Liquibase 4.26.0 · liquibase.change.core.AddNotNullConstraintChange

Modifier and Type	Class and Description
pack-priv class	AddNotNullConstraintChange.SQLiteAlterTableVisitor

Field Summary

Modifier and Type	Field and Description
private String	catalogName
private String	columnDataType
private String	columnName
private String	constraintName
private String	defaultNullValue
private String	schemaName
private Boolean	shouldValidate
private String	tableName

Inherited from liquibase.change.AbstractChange:: NODENAME_COLUMN

Constructor Summary

Access	Constructor and Description
public	AddNotNullConstraintChange()

Method Summary

Modifier and Type	Method and Description
protected Change[]	createInverses() Overrides liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change.
public SqlStatement[]	generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given database.
public String	getCatalogName()
public String	getColumnDataType()
public String	getColumnName()
public String	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getConstraintName()
public String	getDefaultNullValue()
public String	getSchemaName()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getTableName()
public Boolean	Returns: true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE. getValidate() In certain SQL dialects, the VALIDATE keyword defines whether a NOT NULL constraint on a column in a table should be checked if it refers to a valid row or not.
public void	setCatalogName(String catalogName)
public void	setColumnDataType(String columnDataType)
public void	setColumnName(String columnName)
public void	setConstraintName(String constraintName)
public void	setDefaultNullValue(String defaultNullValue)
public void	setSchemaName(String schemaName)
public void	setTableName(String tableName)
public void	setValidate(Boolean - if shouldValidate is set to FALSE then the constraint will be created with the 'ENABLE NOVALIDATE' mode. This means the constraint would be created, but that no check will be done to ensure old data has valid not null constrain - only new data would be checked to see if it complies with the constraint logic. The default state for not null constrain is to have 'ENABLE VALIDATE' set. shouldValidate)

Inherited from liquibase.change.AbstractChange:: checkStatus createChangeMetaData createChangeParameterMetadata createDescriptionMetaData createEmptyColumnConfig createExampleValueMetaData createMustEqualExistingMetaData createRequiredDatabasesMetaData createSerializationTypeMetaData createSinceMetaData createSupportedDatabasesMetaData customLoadLogic equals finishInitialization generateCheckSum generateRollbackStatements generateRollbackStatementsVolatile generateStatementsVolatile getAffectedDatabaseObjects getChangeSet getDescription getExcludedFieldFilters getResourceAccessor getSerializableFieldNamespace getSerializableFields getSerializableFieldType getSerializableFieldValue getSerializedObjectName hashCode isInvalidProperty load modify serialize serializeValue setChangeSet setResourceAccessor shouldExecuteChange supports supportsRollback toString validate warn

Field Detail

catalogName	back to summary
private String catalogName

columnDataType	back to summary
private String columnDataType

columnName	back to summary
private String columnName

constraintName	back to summary
private String constraintName

defaultNullValue	back to summary
private String defaultNullValue

schemaName	back to summary
private String schemaName

shouldValidate	back to summary
private Boolean shouldValidate

tableName	back to summary
private String tableName

Constructor Detail

AddNotNullConstraintChange	back to summary
public AddNotNullConstraintChange()

Method Detail

createInverses back to summary

createInverses	back to summary
protected Change[] createInverses() Overrides liquibase.change.AbstractChange.createInverses. Doc from liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change. This method is intended to be overridden by Change implementations that have a logical inverse operation. Default implementation returns null. If `generateRollbackStatements(liquibase.database.Database)` is overridden, this method may not be called. Returns:Change[] Return null if there is no corresponding inverse and therefore automatic rollback is not possible. Return an empty array to have a no-op rollback. Annotations @Override

protected Change[] createInverses()

Overrides liquibase.change.AbstractChange.createInverses.

Doc from liquibase.change.AbstractChange.createInverses.

Create inverse changes that can roll back this change. This method is intended to be overridden by Change implementations that have a logical inverse operation. Default implementation returns null.

If generateRollbackStatements(liquibase.database.Database) is overridden, this method may not be called.

Returns:Change[]

Return null if there is no corresponding inverse and therefore automatic rollback is not possible. Return an empty array to have a no-op rollback.

Annotations

@Override

generateStatements back to summary

generateStatements	back to summary
public SqlStatement[] generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Doc from liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given database. NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well. If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from `generateStatementsVolatile`. Annotations @Override

public SqlStatement[] generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

Doc from liquibase.change.Change.generateStatements.

Generates the SqlStatement objects required to run the change for the given database.

NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well.

If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from generateStatementsVolatile.

Annotations

@Override

getCatalogName	back to summary
public String getCatalogName() Annotations @DatabaseChangeProperty since:3.0 mustEqualExisting:column.relation.catalog description:Name of the database catalog

getColumnDataType	back to summary
public String getColumnDataType() Annotations @DatabaseChangeProperty description:Current data type of the column

getColumnName	back to summary
public String getColumnName() Annotations @DatabaseChangeProperty description:Name of the column to add the constraint to mustEqualExisting:column.relation.column

getConfirmationMessage	back to summary
public String getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Doc from liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation. Annotations @Override

getConfirmationMessage

back to summary

public String getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Doc from liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation.

Annotations

@Override

getConstraintName	back to summary
public String getConstraintName() Annotations @DatabaseChangeProperty description:Name of the constraint to add (if database supports names for NOT NULL constraints)

getDefaultNullValue	back to summary
public String getDefaultNullValue() Annotations @DatabaseChangeProperty description:Value to set all currently null values to. If defaultNullValue is not set and null values exist, the change fails

getSchemaName	back to summary
public String getSchemaName() Annotations @DatabaseChangeProperty mustEqualExisting:column.relation.schema description:Name of the database schema

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getTableName	back to summary
public String getTableName() Annotations @DatabaseChangeProperty description:Name of the table to add a NOT NULL constraint to. mustEqualExisting:column.relation

getValidate	back to summary
public Boolean getValidate() In certain SQL dialects, the VALIDATE keyword defines whether a NOT NULL constraint on a column in a table should be checked if it refers to a valid row or not. Returns:Boolean true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE. Annotations @DatabaseChangeProperty description:Defines whether to check if the NOT NULL constraint refers to a valid row. This is true if the constraint has \'ENABLE VALIDATE\' set, or false if the constraint has \'ENABLE NOVALIDATE\' set.

getValidate

back to summary

public Boolean getValidate()

In certain SQL dialects, the VALIDATE keyword defines whether a NOT NULL constraint on a column in a table should be checked if it refers to a valid row or not.

Returns:Boolean

true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE.

Annotations

@DatabaseChangeProperty
description:Defines whether to check if the NOT NULL constraint refers to a valid row. This is true if the constraint has \'ENABLE VALIDATE\' set, or false if the constraint has \'ENABLE NOVALIDATE\' set.

setCatalogName	back to summary
public void setCatalogName(String catalogName)

setColumnDataType	back to summary
public void setColumnDataType(String columnDataType)

setColumnName	back to summary
public void setColumnName(String columnName)

setConstraintName	back to summary
public void setConstraintName(String constraintName)

setDefaultNullValue	back to summary
public void setDefaultNullValue(String defaultNullValue)

setSchemaName	back to summary
public void setSchemaName(String schemaName)

setTableName	back to summary
public void setTableName(String tableName)

setValidate	back to summary
public void setValidate(Boolean shouldValidate) Parameters shouldValidate:Boolean - if shouldValidate is set to FALSE then the constraint will be created with the 'ENABLE NOVALIDATE' mode. This means the constraint would be created, but that no check will be done to ensure old data has valid not null constrain - only new data would be checked to see if it complies with the constraint logic. The default state for not null constrain is to have 'ENABLE VALIDATE' set.

setValidate

back to summary

public void setValidate(Boolean shouldValidate)

Parameters

shouldValidate:Boolean: - if shouldValidate is set to FALSE then the constraint will be created with the 'ENABLE NOVALIDATE' mode. This means the constraint would be created, but that no check will be done to ensure old data has valid not null constrain - only new data would be checked to see if it complies with the constraint logic. The default state for not null constrain is to have 'ENABLE VALIDATE' set.

Access	Constructor and Description
pack-priv	SQLiteAlterTableVisitor()

Modifier and Type	Method and Description
public boolean	copyThisColumn(ColumnConfig column) Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.copyThisColumn.
public boolean	createThisColumn(ColumnConfig column) Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.createThisColumn.
public boolean	createThisIndex(Index index) Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.createThisIndex.
public ColumnConfig[]	getColumnsToAdd() Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.getColumnsToAdd.

Constructor Detail

SQLiteAlterTableVisitor	back to summary
pack-priv SQLiteAlterTableVisitor()

Method Detail

copyThisColumn	back to summary
public boolean copyThisColumn(ColumnConfig column) Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.copyThisColumn. Annotations @Override

copyThisColumn

back to summary

public boolean copyThisColumn(ColumnConfig column)

Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.copyThisColumn.

Annotations

@Override

createThisColumn	back to summary
public boolean createThisColumn(ColumnConfig column) Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.createThisColumn. Annotations @Override

createThisColumn

back to summary

public boolean createThisColumn(ColumnConfig column)

Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.createThisColumn.

Annotations

@Override

createThisIndex	back to summary
public boolean createThisIndex(Index index) Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.createThisIndex. Annotations @Override

createThisIndex

back to summary

public boolean createThisIndex(Index index)

Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.createThisIndex.

Annotations

@Override

getColumnsToAdd	back to summary
public ColumnConfig[] getColumnsToAdd() Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.getColumnsToAdd. Annotations @Override

getColumnsToAdd

back to summary

public ColumnConfig[] getColumnsToAdd()

Implements liquibase.database.core.SQLiteDatabase.AlterTableVisitor.getColumnsToAdd.

Annotations

@Override

public Class AddNotNullConstraintChange

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AddNotNullConstraintChange.SQLiteAlterTableVisitor

Constructor Summary

Method Summary

Constructor Detail

Method Detail