Liquibase 4.26.0 · liquibase.change.ConstraintsConfig

Modifier and Type	Field and Description
private String	checkConstraint
private Boolean	deferrable
private Boolean	deleteCascade
private String	foreignKeyName
private Boolean	initiallyDeferred
private String	notNullConstraintName
private Boolean	nullable
private Boolean	primaryKey
private String	primaryKeyName
private String	primaryKeyTablespace
private String	referencedColumnNames
private String	referencedTableCatalogName
private String	referencedTableName
private String	referencedTableSchemaName
private String	references
private Boolean	unique
private String	uniqueConstraintName
private Boolean	validateForeignKey
private Boolean	validateNullable
private Boolean	validatePrimaryKey
private Boolean	validateUnique

Access	Constructor and Description
public	ConstraintsConfig()

Method Summary

Modifier and Type	Method and Description
public String	getCheckConstraint() Returns the check constraint to use on this column.
public String	getForeignKeyName() Returns the name to use for the columns foreign key constraint.
public String	Returns: not null constraint name getNotNullConstraintName() If `isNullable()` is 'false' and database supports named not null constraints
public String	getPrimaryKeyName() Returns the name to use for the primary key constraint.
public String	getPrimaryKeyTablespace() Returns the tablespace to use for the defined primary key.
public String	getReferencedColumnNames()
public String	getReferencedTableCatalogName()
public String	getReferencedTableName()
public String	getReferencedTableSchemaName()
public String	getReferences() Returns the "references" clause to use for the foreign key.
public String	getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.
public String	getSerializedObjectNamespace() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getUniqueConstraintName() Returns the name to use for the unique constraint.
public Boolean	getValidateForeignKey() Returns whether a ForeignKeyConst defined for this column should validate.
public Boolean	getValidateNullable() Returns whether a NotNullConst defined for this column should validate.
public Boolean	getValidatePrimaryKey() Returns whether a PrimaryKeyConst defined for this column should validate.
public Boolean	getValidateUnique() Returns whether a UniqueConst defined for this column should validate.
public Boolean	isDeferrable() Returns if a foreign key defined for this column should deferrable.
public Boolean	isDeleteCascade() Returns if a foreign key defined for this column should cascade deletes.
public Boolean	isInitiallyDeferred() Returns if a foreign key defined for this column should be "initially deferred".
public Boolean	isNullable() Returns if the column should be nullable.
public Boolean	isPrimaryKey() Returns true if the column should be part of the primary key.
public Boolean	isUnique() Returns if the column is part of a unique constraint.
public void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.serializer.AbstractLiquibaseSerializable.load. Implements liquibase.serializer.LiquibaseSerializable.load.
private Boolean	parseBoolean(String value)
public ConstraintsConfig	setCheckConstraint(String checkConstraint)
public ConstraintsConfig	setDeferrable(Boolean deferrable)
public ConstraintsConfig	setDeferrable(String deferrable) Set the deferrable parameter based on the passed string.
public ConstraintsConfig	setDeleteCascade(Boolean deleteCascade)
public ConstraintsConfig	setDeleteCascade(String deleteCascade) Set the deleteCascade parameter based on the passed string.
public ConstraintsConfig	setForeignKeyName(String foreignKeyName)
public ConstraintsConfig	setInitiallyDeferred(Boolean initiallyDeferred)
public ConstraintsConfig	setInitiallyDeferred(String initiallyDeferred) Set the initiallyDeferred parameter based on the passed string.
public ConstraintsConfig	setNotNullConstraintName(String notNullConstraintName)
public ConstraintsConfig	setNullable(Boolean nullable)
public ConstraintsConfig	setNullable(String nullable) Set the nullable parameter based on the passed string.
public ConstraintsConfig	setPrimaryKey(Boolean primaryKey)
public ConstraintsConfig	setPrimaryKey(String primaryKey) Set the primaryKey parameter based on the passed string.
public ConstraintsConfig	setPrimaryKeyName(String primaryKeyName)
public ConstraintsConfig	setPrimaryKeyTablespace(String primaryKeyTablespace)
public void	setReferencedColumnNames(String referencedColumnNames)
public void	setReferencedTableCatalogName(String referencedTableCatalogName)
public void	setReferencedTableName(String referencedTableName)
public void	setReferencedTableSchemaName(String referencedTableSchemaName)
public ConstraintsConfig	setReferences(String references)
public ConstraintsConfig	setUnique(Boolean unique)
public ConstraintsConfig	setUnique(String unique) Set the unique parameter based on the passed string.
public ConstraintsConfig	setUniqueConstraintName(String uniqueConstraintName)
public ConstraintsConfig	setValidateForeignKey(String validateForeignKey) Set the validateForeignKey field based on the passed string.
public ConstraintsConfig	setValidateForeignKey(Boolean validateForeignKey)
public ConstraintsConfig	setValidateNullable(String validateNullable) Set the validateNullable field based on the passed string.
public ConstraintsConfig	setValidateNullable(Boolean validateNullable)
public ConstraintsConfig	setValidatePrimaryKey(String validatePrimaryKey) Set the validatePrimaryKey field based on the passed string.
public ConstraintsConfig	setValidatePrimaryKey(Boolean validatePrimaryKey)
public ConstraintsConfig	setValidateUnique(String validateUnique) Set the validateUnique field based on the passed string.
public ConstraintsConfig	setValidateUnique(Boolean validateUnique)

Inherited from liquibase.serializer.AbstractLiquibaseSerializable:: convertEscaped getSerializableFieldDataTypeClass getSerializableFieldDataTypeClassParameters getSerializableFieldNamespace getSerializableFields getSerializableFieldType getSerializableFieldValue serialize serializeValue setSerializableFieldValue shouldAutoLoad

checkConstraint	back to summary
private String checkConstraint

deferrable	back to summary
private Boolean deferrable

deleteCascade	back to summary
private Boolean deleteCascade

foreignKeyName	back to summary
private String foreignKeyName

initiallyDeferred	back to summary
private Boolean initiallyDeferred

notNullConstraintName	back to summary
private String notNullConstraintName

nullable	back to summary
private Boolean nullable

primaryKey	back to summary
private Boolean primaryKey

primaryKeyName	back to summary
private String primaryKeyName

primaryKeyTablespace	back to summary
private String primaryKeyTablespace

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

references	back to summary
private String references

unique	back to summary
private Boolean unique

uniqueConstraintName	back to summary
private String uniqueConstraintName

validateForeignKey	back to summary
private Boolean validateForeignKey

validateNullable	back to summary
private Boolean validateNullable

validatePrimaryKey	back to summary
private Boolean validatePrimaryKey

validateUnique	back to summary
private Boolean validateUnique

ConstraintsConfig	back to summary
public ConstraintsConfig()

Method Detail

getCheckConstraint	back to summary
public String getCheckConstraint() Returns the check constraint to use on this column. Returns null if not specified

getForeignKeyName	back to summary
public String getForeignKeyName() Returns the name to use for the columns foreign key constraint. Returns null if not specified.

getNotNullConstraintName back to summary

getNotNullConstraintName	back to summary
public String getNotNullConstraintName() If `isNullable()` is 'false' and database supports named not null constraints Returns:String not null constraint name See Also `getUniqueConstraintName()`

public String getNotNullConstraintName()

If isNullable() is 'false' and database supports named not null constraints

Returns:String: not null constraint name
See Also: getUniqueConstraintName()

getPrimaryKeyName	back to summary
public String getPrimaryKeyName() Returns the name to use for the primary key constraint. Returns null if not specified

getPrimaryKeyTablespace	back to summary
public String getPrimaryKeyTablespace() Returns the tablespace to use for the defined primary key. Returns null if not specified.

getReferencedColumnNames	back to summary
public String getReferencedColumnNames()

getReferencedTableCatalogName	back to summary
public String getReferencedTableCatalogName()

getReferencedTableName	back to summary
public String getReferencedTableName()

getReferencedTableSchemaName	back to summary
public String getReferencedTableSchemaName()

getReferences	back to summary
public String getReferences() Returns the "references" clause to use for the foreign key. Normally a string of the format TABLE(COLUMN_NAME). Returns null if not specified

getSerializedObjectName	back to summary
public String getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName. Annotations @Override

getSerializedObjectName

back to summary

public String getSerializedObjectName()

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.

Annotations

@Override

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

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getUniqueConstraintName	back to summary
public String getUniqueConstraintName() Returns the name to use for the unique constraint. Returns null if not specified

getValidateForeignKey	back to summary
public Boolean getValidateForeignKey() Returns whether a ForeignKeyConst defined for this column should validate. Returns null if not setValidateForeignKey has not been called.

getValidateNullable	back to summary
public Boolean getValidateNullable() Returns whether a NotNullConst defined for this column should validate. Returns null if not setValidateNullable has not been called.

getValidatePrimaryKey	back to summary
public Boolean getValidatePrimaryKey() Returns whether a PrimaryKeyConst defined for this column should validate. Returns null if not setValidatePrimaryKey has not been called.

getValidateUnique	back to summary
public Boolean getValidateUnique() Returns whether a UniqueConst defined for this column should validate. Returns null if not setValidateUnique has not been called.

isDeferrable	back to summary
public Boolean isDeferrable() Returns if a foreign key defined for this column should deferrable. Returns null if not specified.

isDeleteCascade	back to summary
public Boolean isDeleteCascade() Returns if a foreign key defined for this column should cascade deletes. Returns null if not specified.

isInitiallyDeferred	back to summary
public Boolean isInitiallyDeferred() Returns if a foreign key defined for this column should be "initially deferred". Returns null if not specified.

isNullable	back to summary
public Boolean isNullable() Returns if the column should be nullable. Returns null if unspecified.

isPrimaryKey	back to summary
public Boolean isPrimaryKey() Returns true if the column should be part of the primary key. Returns null if unspecified

isUnique	back to summary
public Boolean isUnique() Returns if the column is part of a unique constraint. Returns null if not specified

load	back to summary
public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Overrides liquibase.serializer.AbstractLiquibaseSerializable.load. Implements liquibase.serializer.LiquibaseSerializable.load. Annotations @Override

load

back to summary

public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Overrides liquibase.serializer.AbstractLiquibaseSerializable.load.

Implements liquibase.serializer.LiquibaseSerializable.load.

Annotations

@Override

parseBoolean	back to summary
private Boolean parseBoolean(String value)

setCheckConstraint	back to summary
public ConstraintsConfig setCheckConstraint(String checkConstraint)

setDeferrable	back to summary
public ConstraintsConfig setDeferrable(Boolean deferrable)

setDeferrable	back to summary
public ConstraintsConfig setDeferrable(String deferrable) Set the deferrable parameter based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if a different value is passed

setDeleteCascade	back to summary
public ConstraintsConfig setDeleteCascade(Boolean deleteCascade)

setDeleteCascade	back to summary
public ConstraintsConfig setDeleteCascade(String deleteCascade) Set the deleteCascade parameter based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if a different value is passed

setForeignKeyName	back to summary
public ConstraintsConfig setForeignKeyName(String foreignKeyName)

setInitiallyDeferred	back to summary
public ConstraintsConfig setInitiallyDeferred(Boolean initiallyDeferred)

setInitiallyDeferred	back to summary
public ConstraintsConfig setInitiallyDeferred(String initiallyDeferred) Set the initiallyDeferred parameter based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if a different value is passed

setNotNullConstraintName	back to summary
public ConstraintsConfig setNotNullConstraintName(String notNullConstraintName)

setNullable	back to summary
public ConstraintsConfig setNullable(Boolean nullable)

setNullable	back to summary
public ConstraintsConfig setNullable(String nullable) Set the nullable parameter based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if a different value is passed

setPrimaryKey	back to summary
public ConstraintsConfig setPrimaryKey(Boolean primaryKey)

setPrimaryKey	back to summary
public ConstraintsConfig setPrimaryKey(String primaryKey) Set the primaryKey parameter based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if a different value is passed

setPrimaryKeyName	back to summary
public ConstraintsConfig setPrimaryKeyName(String primaryKeyName)

setPrimaryKeyTablespace	back to summary
public ConstraintsConfig setPrimaryKeyTablespace(String primaryKeyTablespace)

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)

setReferences	back to summary
public ConstraintsConfig setReferences(String references)

setUnique	back to summary
public ConstraintsConfig setUnique(Boolean unique)

setUnique	back to summary
public ConstraintsConfig setUnique(String unique) Set the unique parameter based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if a different value is passed

setUniqueConstraintName	back to summary
public ConstraintsConfig setUniqueConstraintName(String uniqueConstraintName)

setValidateForeignKey	back to summary
public ConstraintsConfig setValidateForeignKey(String validateForeignKey) Set the validateForeignKey field based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if an invalid value is passed

setValidateForeignKey	back to summary
public ConstraintsConfig setValidateForeignKey(Boolean validateForeignKey)

setValidateNullable	back to summary
public ConstraintsConfig setValidateNullable(String validateNullable) Set the validateNullable field based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if an invalid value is passed

setValidateNullable	back to summary
public ConstraintsConfig setValidateNullable(Boolean validateNullable)

setValidatePrimaryKey	back to summary
public ConstraintsConfig setValidatePrimaryKey(String validatePrimaryKey) Set the validatePrimaryKey field based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if an invalid value is passed

setValidatePrimaryKey	back to summary
public ConstraintsConfig setValidatePrimaryKey(Boolean validatePrimaryKey)

setValidateUnique	back to summary
public ConstraintsConfig setValidateUnique(String validateUnique) Set the validateUnique field based on the passed string. Sets true if the passed string is 1 or true or TRUE. Sets false if the passed string is 0 or false or FALSE. Sets null if the passed string is null or "null" or "NULL". Throws an `UnexpectedLiquibaseException` if an invalid value is passed

setValidateUnique	back to summary
public ConstraintsConfig setValidateUnique(Boolean validateUnique)

public Class ConstraintsConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail