Liquibase 4.26.0 · liquibase.change.core.AddUniqueConstraintChange

Field Summary

Modifier and Type	Field and Description
private String	catalogName
private Boolean	clustered
private String	columnNames
private String	constraintName
private Boolean	deferrable
private Boolean	disabled
private String	forIndexCatalogName
private String	forIndexName
private String	forIndexSchemaName
private Boolean	initiallyDeferred
private String	schemaName
private Boolean	shouldValidate
private String	tableName
private String	tablespace

Inherited from liquibase.change.AbstractChange:: NODENAME_COLUMN

Constructor Summary

Access	Constructor and Description
public	AddUniqueConstraintChange()

Method Summary

Modifier and Type	Method and Description
public ChangeStatus	checkStatus(Database database) Overrides liquibase.change.AbstractChange.checkStatus. Implements liquibase.change.Change.checkStatus. Validate that this change executed successfully against the given database.
protected AddUniqueConstraintStatement	createAddUniqueConstraintStatement()
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 Boolean	getClustered()
public String	getColumnNames()
public String	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getConstraintName()
public Boolean	getDeferrable()
public Boolean	getDisabled()
public String	getForIndexCatalogName()
public String	getForIndexName()
public String	getForIndexSchemaName()
public Boolean	getInitiallyDeferred()
public String	getSchemaName()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getTableName()
public String	getTablespace()
public Boolean	Returns: true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE. getValidate() In Oracle PL/SQL, the VALIDATE keyword defines whether a newly added unique constraint on a column in a table should cause existing rows to be checked to see if they satisfy the uniqueness constraint or not.
public void	setCatalogName(String catalogName)
public void	setClustered(Boolean clustered)
public void	setColumnNames(String columnNames)
public void	setConstraintName(String constraintName)
public void	setDeferrable(Boolean deferrable)
public void	setDisabled(Boolean disabled)
public void	setForIndexCatalogName(String forIndexCatalogName)
public void	setForIndexName(String forIndexName)
public void	setForIndexSchemaName(String forIndexSchemaName)
public void	setInitiallyDeferred(Boolean initiallyDeferred)
public void	setSchemaName(String schemaName)
public void	setTableName(String tableName)
public void	setTablespace(String tablespace)
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 constraints - only new data would be checked to see if it complies with the constraint logic. The default state for unique constraints is to have 'ENABLE VALIDATE' set. validate)

Field Detail

catalogName	back to summary
private String catalogName

clustered	back to summary
private Boolean clustered

columnNames	back to summary
private String columnNames

constraintName	back to summary
private String constraintName

deferrable	back to summary
private Boolean deferrable

disabled	back to summary
private Boolean disabled

forIndexCatalogName	back to summary
private String forIndexCatalogName

forIndexName	back to summary
private String forIndexName

forIndexSchemaName	back to summary
private String forIndexSchemaName

initiallyDeferred	back to summary
private Boolean initiallyDeferred

schemaName	back to summary
private String schemaName

shouldValidate	back to summary
private Boolean shouldValidate

tableName	back to summary
private String tableName

tablespace	back to summary
private String tablespace

Constructor Detail

AddUniqueConstraintChange	back to summary
public AddUniqueConstraintChange()

Method Detail

checkStatus	back to summary
public ChangeStatus checkStatus(Database database) Overrides liquibase.change.AbstractChange.checkStatus. Implements liquibase.change.Change.checkStatus. Doc from liquibase.change.Change.checkStatus. Validate that this change executed successfully against the given database. This will check that the update completed at a high level plus check details of the change. For example, a change to add a column will check that the column exists plus data type, default values, etc. Annotations @Override

checkStatus

back to summary

public ChangeStatus checkStatus(Database database)

Overrides liquibase.change.AbstractChange.checkStatus.

Implements liquibase.change.Change.checkStatus.

Doc from liquibase.change.Change.checkStatus.

Validate that this change executed successfully against the given database. This will check that the update completed at a high level plus check details of the change. For example, a change to add a column will check that the column exists plus data type, default values, etc.

Annotations

@Override

createAddUniqueConstraintStatement	back to summary
protected AddUniqueConstraintStatement createAddUniqueConstraintStatement()

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 mustEqualExisting:column.relation.catalog since:3.0 description:Name of the database catalog

getClustered	back to summary
public Boolean getClustered() Annotations @DatabaseChangeProperty description:Whether to create a clustered index

getColumnNames	back to summary
public String getColumnNames() Annotations @DatabaseChangeProperty mustEqualExisting:column description:Name of the column(s) to create the unique constraint on. Comma separated if multiple

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 unique constraint

getDeferrable	back to summary
public Boolean getDeferrable() Annotations @DatabaseChangeProperty description:Defines whether the constraint is deferrable

getDisabled	back to summary
public Boolean getDisabled() Annotations @DatabaseChangeProperty description:Specifies whether the constraint is disabled

getForIndexCatalogName	back to summary
public String getForIndexCatalogName() Annotations @DatabaseChangeProperty description:Name of the catalog of the index to associate with the constraint

getForIndexName	back to summary
public String getForIndexName() Annotations @DatabaseChangeProperty description:Name of the index to associate with the constraint

getForIndexSchemaName	back to summary
public String getForIndexSchemaName() Annotations @DatabaseChangeProperty description:Name of the schema of the index to associate with the constraint

getInitiallyDeferred	back to summary
public Boolean getInitiallyDeferred() Annotations @DatabaseChangeProperty description:Defines whether the constraint is initially deferred

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 mustEqualExisting:column.relation description:Name of the table to create the unique constraint on

getTablespace	back to summary
public String getTablespace() Annotations @DatabaseChangeProperty description:Tablespace to create the index in. Corresponds to file group in mssql

getValidate	back to summary
public Boolean getValidate() In Oracle PL/SQL, the VALIDATE keyword defines whether a newly added unique constraint on a column in a table should cause existing rows to be checked to see if they satisfy the uniqueness constraint 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 unique 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 Oracle PL/SQL, the VALIDATE keyword defines whether a newly added unique constraint on a column in a table should cause existing rows to be checked to see if they satisfy the uniqueness constraint 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 unique 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)

setClustered	back to summary
public void setClustered(Boolean clustered)

setColumnNames	back to summary
public void setColumnNames(String columnNames)

setConstraintName	back to summary
public void setConstraintName(String constraintName)

setDeferrable	back to summary
public void setDeferrable(Boolean deferrable)

setDisabled	back to summary
public void setDisabled(Boolean disabled)

setForIndexCatalogName	back to summary
public void setForIndexCatalogName(String forIndexCatalogName)

setForIndexName	back to summary
public void setForIndexName(String forIndexName)

setForIndexSchemaName	back to summary
public void setForIndexSchemaName(String forIndexSchemaName)

setInitiallyDeferred	back to summary
public void setInitiallyDeferred(Boolean initiallyDeferred)

setSchemaName	back to summary
public void setSchemaName(String schemaName)

setTableName	back to summary
public void setTableName(String tableName)

setTablespace	back to summary
public void setTablespace(String tablespace)

setValidate

back to summary

public void setValidate(Boolean validate)

Parameters

validate: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 constraints - only new data would be checked to see if it complies with the constraint logic. The default state for unique constraints is to have 'ENABLE VALIDATE' set.

public Class AddUniqueConstraintChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail