Liquibase 4.26.0 · liquibase.change.core.AddForeignKeyConstraintChange

Modifier and Type	Field and Description
private String	baseColumnNames
private String	baseTableCatalogName
private String	baseTableName
private String	baseTableSchemaName
private String	constraintName
private Boolean	deferrable
private Boolean	initiallyDeferred
private String	onDelete
private String	onUpdate
private String	referencedColumnNames
private String	referencedTableCatalogName
private String	referencedTableName
private String	referencedTableSchemaName
private Boolean	shouldValidate

Access	Constructor and Description
public	AddForeignKeyConstraintChange()

Modifier and Type	Method and Description
private boolean	checkDefferable(Database database)
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 Change[]	createInverses() Overrides liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change.
protected String[]	createSupportedDatabasesMetaData(String parameterName, DatabaseChangeProperty changePropertyAnnotation) Overrides liquibase.change.AbstractChange.createSupportedDatabasesMetaData. Create the `ChangeParameterMetaData` "supportedDatabase" value.
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	getBaseColumnNames()
public String	getBaseTableCatalogName()
public String	getBaseTableName()
public String	getBaseTableSchemaName()
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	getDeleteCascade() Deprecated Use `getOnDelete()`.
public Boolean	getInitiallyDeferred()
public String	getOnDelete()
public String	getOnUpdate()
public String	getReferencedColumnNames()
public String	getReferencedTableCatalogName()
public String	getReferencedTableName()
public String	getReferencedTableSchemaName()
public Boolean	getReferencesUniqueColumn() Deprecated No longer supported in 3.0
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public Boolean	Returns: true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE. getValidate() the VALIDATE keyword defines whether to check if a foreign key constraint on a column in a table refers to a valid row or not.
public void	setBaseColumnNames(String baseColumnNames)
public void	setBaseTableCatalogName(String baseTableCatalogName)
public void	setBaseTableName(String baseTableName)
public void	setBaseTableSchemaName(String baseTableSchemaName)
public void	setConstraintName(String constraintName)
public void	setDeferrable(Boolean deferrable)
public void	setDeleteCascade(Boolean deleteCascade)
public void	setInitiallyDeferred(Boolean initiallyDeferred)
public void	setOnDelete(String onDelete)
public void	setOnDelete(ForeignKeyConstraintType rule)
public void	setOnUpdate(String rule)
public void	setOnUpdate(ForeignKeyConstraintType rule)
public void	setReferencedColumnNames(String referencedColumnNames)
public void	setReferencedTableCatalogName(String referencedTableCatalogName)
public void	setReferencedTableName(String referencedTableName)
public void	setReferencedTableSchemaName(String referencedTableSchemaName)
public void	setReferencesUniqueColumn(Boolean referencesUniqueColumn)
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 foreign keys - only new data would be checked to see if it complies with the constraint logic. The default state for foreign keys is to have 'ENABLE VALIDATE' set. shouldValidate)

baseColumnNames	back to summary
private String baseColumnNames

baseTableCatalogName	back to summary
private String baseTableCatalogName

baseTableName	back to summary
private String baseTableName

baseTableSchemaName	back to summary
private String baseTableSchemaName

constraintName	back to summary
private String constraintName

deferrable	back to summary
private Boolean deferrable

initiallyDeferred	back to summary
private Boolean initiallyDeferred

onDelete	back to summary
private String onDelete

onUpdate	back to summary
private String onUpdate

referencedColumnNames	back to summary
private String referencedColumnNames

referencedTableCatalogName	back to summary
private String referencedTableCatalogName

referencedTableName	back to summary
private String referencedTableName

referencedTableSchemaName	back to summary
private String referencedTableSchemaName

shouldValidate	back to summary
private Boolean shouldValidate

AddForeignKeyConstraintChange	back to summary
public AddForeignKeyConstraintChange()

Method Detail

checkDefferable	back to summary
private boolean checkDefferable(Database database)

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

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

createSupportedDatabasesMetaData back to summary

protected String[] createSupportedDatabasesMetaData(String parameterName, DatabaseChangeProperty changePropertyAnnotation)

Overrides liquibase.change.AbstractChange.createSupportedDatabasesMetaData.

Doc from liquibase.change.AbstractChange.createSupportedDatabasesMetaData.

Create the ChangeParameterMetaData "supportedDatabase" value. Uses the value on the DatabaseChangeProperty annotation or returns an array containing the string "COMPUTE" as a default. "COMPUTE" will cause ChangeParameterMetaData to attempt to determine the required databases based on the generated Statements

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

getBaseColumnNames	back to summary
public String getBaseColumnNames() Annotations @DatabaseChangeProperty description:Name of the column(s) to place the foreign key constraint on. Comma-separate if multiple exampleValue:person_id mustEqualExisting:column

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

getBaseTableName	back to summary
public String getBaseTableName() Annotations @DatabaseChangeProperty description:Name of the table containing the column to constrain exampleValue:address mustEqualExisting:column.relation

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

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 new foreign key constraint exampleValue:fk_address_person

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

getDeleteCascade	back to summary
public Boolean getDeleteCascade() Deprecated Use `getOnDelete()`. This always returns null so it doesn't impact checksums when settings onDelete vs. deleteCascade Annotations @DatabaseChangeProperty description:Deprecated. This is true to set onDelete to Cascade, priority given to onDelete tag if one exists

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

getOnDelete	back to summary
public String getOnDelete() Annotations @DatabaseChangeProperty description:ON DELETE functionality. Possible values: \'CASCADE\', \'SET NULL\', \'SET DEFAULT\', \'RESTRICT\', \'NO ACTION\' exampleValue:CASCADE

getOnUpdate	back to summary
public String getOnUpdate() Annotations @DatabaseChangeProperty description:ON UPDATE functionality. Possible values: \'CASCADE\', \'SET NULL\', \'SET DEFAULT\', \'RESTRICT\', \'NO ACTION\' exampleValue:RESTRICT

getReferencedColumnNames	back to summary
public String getReferencedColumnNames() Annotations @DatabaseChangeProperty description:Name of the column(s) the foreign key points to. Comma-separate if multiple exampleValue:id

getReferencedTableCatalogName	back to summary
public String getReferencedTableCatalogName() Annotations @DatabaseChangeProperty since:3.0 mustEqualExisting:column description:Name of the database catalog of the referenced table

getReferencedTableName	back to summary
public String getReferencedTableName() Annotations @DatabaseChangeProperty description:Name of the table the foreign key points to exampleValue:person

getReferencedTableSchemaName	back to summary
public String getReferencedTableSchemaName() Annotations @DatabaseChangeProperty description:Name of the database schema of the referenced table

getReferencesUniqueColumn	back to summary
public Boolean getReferencesUniqueColumn() Deprecated No longer supported in 3.0 Annotations @Deprecated @DatabaseChangeProperty description:Deprecated

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

getValidate	back to summary
public Boolean getValidate() the VALIDATE keyword defines whether to check if a foreign key constraint on a column in a table 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 foreign key constraint refers to a valid row. This is true if the foreign key has \'ENABLE VALIDATE\' set, or false if the foreign key has \'ENABLE NOVALIDATE\' set.

getValidate

back to summary

public Boolean getValidate()

the VALIDATE keyword defines whether to check if a foreign key constraint on a column in a table 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 foreign key constraint refers to a valid row. This is true if the foreign key has \'ENABLE VALIDATE\' set, or false if the foreign key has \'ENABLE NOVALIDATE\' set.

setBaseColumnNames	back to summary
public void setBaseColumnNames(String baseColumnNames)

setBaseTableCatalogName	back to summary
public void setBaseTableCatalogName(String baseTableCatalogName)

setBaseTableName	back to summary
public void setBaseTableName(String baseTableName)

setBaseTableSchemaName	back to summary
public void setBaseTableSchemaName(String baseTableSchemaName)

setConstraintName	back to summary
public void setConstraintName(String constraintName)

setDeferrable	back to summary
public void setDeferrable(Boolean deferrable)

setDeleteCascade	back to summary
public void setDeleteCascade(Boolean deleteCascade)

setInitiallyDeferred	back to summary
public void setInitiallyDeferred(Boolean initiallyDeferred)

setOnDelete	back to summary
public void setOnDelete(String onDelete)

setOnDelete	back to summary
public void setOnDelete(ForeignKeyConstraintType rule)

setOnUpdate	back to summary
public void setOnUpdate(String rule)

setOnUpdate	back to summary
public void setOnUpdate(ForeignKeyConstraintType rule)

setReferencedColumnNames	back to summary
public void setReferencedColumnNames(String referencedColumnNames)

setReferencedTableCatalogName	back to summary
public void setReferencedTableCatalogName(String referencedTableCatalogName)

setReferencedTableName	back to summary
public void setReferencedTableName(String referencedTableName)

setReferencedTableSchemaName	back to summary
public void setReferencedTableSchemaName(String referencedTableSchemaName)

setReferencesUniqueColumn	back to summary
public void setReferencesUniqueColumn(Boolean referencesUniqueColumn)

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

public Class AddForeignKeyConstraintChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail