Liquibase 4.26.0 · liquibase.structure.core.UniqueConstraint

Access	Constructor and Description
public	UniqueConstraint()
public	UniqueConstraint(String name, String tableCatalog, String tableSchema, String tableName, Column... columns)

Method Summary

Modifier and Type	Method and Description
public UniqueConstraint	addColumn(int position, Column column)
public int	compareTo(Object the object to be compared. other) Overrides liquibase.structure.AbstractDatabaseObject.compareTo. Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Index	getBackingIndex()
public String	getColumnNames()
public List<Column>	getColumns()
public DatabaseObject[]	getContainingObjects() Implements liquibase.structure.DatabaseObject.getContainingObjects.
public String	getName() Implements liquibase.structure.DatabaseObject.getName.
public Relation	getRelation()
public Schema	getSchema() Implements liquibase.structure.DatabaseObject.getSchema.
public Table	getTable() Deprecated Use `getRelation()`
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isClustered()
public boolean	isDeferrable()
public boolean	isDisabled()
public boolean	isInitiallyDeferred()
public void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.structure.AbstractDatabaseObject.load. Implements liquibase.serializer.LiquibaseSerializable.load.
public UniqueConstraint	setBackingIndex(Index backingIndex)
public UniqueConstraint	setClustered(boolean clustered)
public UniqueConstraint	setColumns(List<Column> columns)
public UniqueConstraint	setDeferrable(boolean deferrable)
public UniqueConstraint	setDisabled(boolean disabled)
public UniqueConstraint	setInitiallyDeferred(boolean initiallyDeferred)
public UniqueConstraint	setName(String the new name for the database object constraintName) Implements liquibase.structure.DatabaseObject.setName. Sets the name for the database object.
public UniqueConstraint	setRelation(Relation relation)
public UniqueConstraint	setShouldValidate(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. shouldValidate)
public UniqueConstraint	setTable(Table table) Deprecated Use `setRelation(Relation)`
public boolean	Returns: true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE. shouldValidate() 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 String	toString() Overrides liquibase.structure.AbstractDatabaseObject.toString. Returns a string representation of the object.

Inherited from liquibase.structure.AbstractDatabaseObject:: getAttribute getAttribute getAttributes getObjectTypeName getSerializableFieldNamespace getSerializableFields getSerializableFieldType getSerializableFieldValue getSerializedObjectName getSerializedObjectNamespace getSnapshotId serialize setAttribute setSnapshotId shouldIncludeCatalogInSpecification snapshotByDefault

UniqueConstraint	back to summary
public UniqueConstraint()

UniqueConstraint	back to summary
public UniqueConstraint(String name, String tableCatalog, String tableSchema, String tableName, Column... columns)

Method Detail

addColumn	back to summary
public UniqueConstraint addColumn(int position, Column column)

compareTo back to summary

compareTo	back to summary
public int compareTo(Object other) Overrides liquibase.structure.AbstractDatabaseObject.compareTo. Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:Object the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(Object other)

Overrides liquibase.structure.AbstractDatabaseObject.compareTo.

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:Object: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getBackingIndex	back to summary
public Index getBackingIndex()

getColumnNames	back to summary
public String getColumnNames()

getColumns	back to summary
public List<Column> getColumns()

getContainingObjects	back to summary
public DatabaseObject[] getContainingObjects() Implements liquibase.structure.DatabaseObject.getContainingObjects. Annotations @Override

getContainingObjects

back to summary

public DatabaseObject[] getContainingObjects()

Implements liquibase.structure.DatabaseObject.getContainingObjects.

Annotations

@Override

getName	back to summary
public String getName() Implements liquibase.structure.DatabaseObject.getName. Annotations @Override

getName

back to summary

public String getName()

Implements liquibase.structure.DatabaseObject.getName.

Annotations

@Override

getRelation	back to summary
public Relation getRelation()

getSchema	back to summary
public Schema getSchema() Implements liquibase.structure.DatabaseObject.getSchema. Annotations @Override

getSchema

back to summary

public Schema getSchema()

Implements liquibase.structure.DatabaseObject.getSchema.

Annotations

@Override

getTable	back to summary
public Table getTable() Deprecated Use `getRelation()` Annotations @Deprecated

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isClustered	back to summary
public boolean isClustered()

isDeferrable	back to summary
public boolean isDeferrable()

isDisabled	back to summary
public boolean isDisabled()

isInitiallyDeferred	back to summary
public boolean isInitiallyDeferred()

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

load

back to summary

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

Overrides liquibase.structure.AbstractDatabaseObject.load.

Implements liquibase.serializer.LiquibaseSerializable.load.

Annotations

@Override

setBackingIndex	back to summary
public UniqueConstraint setBackingIndex(Index backingIndex)

setClustered	back to summary
public UniqueConstraint setClustered(boolean clustered)

setColumns	back to summary
public UniqueConstraint setColumns(List<Column> columns)

setDeferrable	back to summary
public UniqueConstraint setDeferrable(boolean deferrable)

setDisabled	back to summary
public UniqueConstraint setDisabled(boolean disabled)

setInitiallyDeferred	back to summary
public UniqueConstraint setInitiallyDeferred(boolean initiallyDeferred)

setName	back to summary
public UniqueConstraint setName(String constraintName) Implements liquibase.structure.DatabaseObject.setName. Doc from liquibase.structure.DatabaseObject.setName. Sets the name for the database object. Parameters constraintName:String the new name for the database object Returns:UniqueConstraint a reference to the same object (implementing classes are expected to return a reference to the same object). Annotations @Override

setName

back to summary

public UniqueConstraint setName(String constraintName)

Implements liquibase.structure.DatabaseObject.setName.

Doc from liquibase.structure.DatabaseObject.setName.

Sets the name for the database object.

Parameters

constraintName:String: the new name for the database object

Returns:UniqueConstraint

a reference to the same object (implementing classes are expected to return a reference to the same object).

Annotations

@Override

setRelation	back to summary
public UniqueConstraint setRelation(Relation relation)

setShouldValidate	back to summary
public UniqueConstraint setShouldValidate(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 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.

setShouldValidate

back to summary

public UniqueConstraint setShouldValidate(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 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.

setTable	back to summary
public UniqueConstraint setTable(Table table) Deprecated Use `setRelation(Relation)` Annotations @Deprecated

shouldValidate	back to summary
public boolean shouldValidate() 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.

shouldValidate

back to summary

public boolean shouldValidate()

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.

toString back to summary

toString	back to summary
public String toString() Overrides liquibase.structure.AbstractDatabaseObject.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides liquibase.structure.AbstractDatabaseObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class UniqueConstraint

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail