Liquibase 4.26.0 · liquibase.structure.core.ForeignKey

Access	Constructor and Description
public	ForeignKey()
public	ForeignKey(String name)
public	ForeignKey(String name, String foreignKeyCatalog, String foreignKeySchema, String foreignKeyTable, Column... baseTableColumns)

Method Summary

Modifier and Type	Method and Description
public ForeignKey	addForeignKeyColumn(Column foreignKeyColumn)
public ForeignKey	addPrimaryKeyColumn(Column primaryKeyColumn)
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 DatabaseObject[]	getContainingObjects() Implements liquibase.structure.DatabaseObject.getContainingObjects.
public ForeignKeyConstraintType	getDeleteRule()
public List<Column>	getForeignKeyColumns()
public Table	getForeignKeyTable()
public String	getName() Implements liquibase.structure.DatabaseObject.getName.
public List<Column>	getPrimaryKeyColumns()
public Table	getPrimaryKeyTable()
public Schema	getSchema() Implements liquibase.structure.DatabaseObject.getSchema.
public ForeignKeyConstraintType	getUpdateRule()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isDeferrable()
public boolean	isInitiallyDeferred()
public ForeignKey	setBackingIndex(Index backingIndex)
public ForeignKey	setDeferrable(boolean deferrable)
public ForeignKey	setDeleteRule(ForeignKeyConstraintType rule)
public ForeignKey	setForeignKeyColumns(List<Column> foreignKeyColumns)
public ForeignKey	setForeignKeyTable(Table foreignKeyTable)
public ForeignKey	setInitiallyDeferred(boolean initiallyDeferred)
public ForeignKey	setName(String the new name for the database object name) Implements liquibase.structure.DatabaseObject.setName. Sets the name for the database object.
public ForeignKey	setPrimaryKeyColumns(List<Column> primaryKeyColumns)
public ForeignKey	setPrimaryKeyTable(Table primaryKeyTable)
public ForeignKey	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 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)
public ForeignKey	setUpdateRule(ForeignKeyConstraintType rule)
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 foreign key constraint on a column in a table should be checked if it refers to a valid row or not.
private String	toDisplayString(List<String> columnsNames)
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 load serialize setAttribute setSnapshotId shouldIncludeCatalogInSpecification snapshotByDefault

ForeignKey	back to summary
public ForeignKey()

ForeignKey	back to summary
public ForeignKey(String name)

ForeignKey	back to summary
public ForeignKey(String name, String foreignKeyCatalog, String foreignKeySchema, String foreignKeyTable, Column... baseTableColumns)

Method Detail

addForeignKeyColumn	back to summary
public ForeignKey addForeignKeyColumn(Column foreignKeyColumn)

addPrimaryKeyColumn	back to summary
public ForeignKey addPrimaryKeyColumn(Column primaryKeyColumn)

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()

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

getDeleteRule	back to summary
public ForeignKeyConstraintType getDeleteRule()

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

getForeignKeyTable	back to summary
public Table getForeignKeyTable()

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

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

getPrimaryKeyTable	back to summary
public Table getPrimaryKeyTable()

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

getUpdateRule	back to summary
public ForeignKeyConstraintType getUpdateRule()

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

isDeferrable	back to summary
public boolean isDeferrable()

isInitiallyDeferred	back to summary
public boolean isInitiallyDeferred()

setBackingIndex	back to summary
public ForeignKey setBackingIndex(Index backingIndex)

setDeferrable	back to summary
public ForeignKey setDeferrable(boolean deferrable)

setDeleteRule	back to summary
public ForeignKey setDeleteRule(ForeignKeyConstraintType rule)

setForeignKeyColumns	back to summary
public ForeignKey setForeignKeyColumns(List<Column> foreignKeyColumns)

setForeignKeyTable	back to summary
public ForeignKey setForeignKeyTable(Table foreignKeyTable)

setInitiallyDeferred	back to summary
public ForeignKey setInitiallyDeferred(boolean initiallyDeferred)

setName	back to summary
public ForeignKey setName(String name) Implements liquibase.structure.DatabaseObject.setName. Doc from liquibase.structure.DatabaseObject.setName. Sets the name for the database object. Parameters name:String the new name for the database object Returns:ForeignKey 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 ForeignKey setName(String name)

Implements liquibase.structure.DatabaseObject.setName.

Doc from liquibase.structure.DatabaseObject.setName.

Sets the name for the database object.

Parameters

name:String: the new name for the database object

Returns:ForeignKey

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

Annotations

@Override

setPrimaryKeyColumns	back to summary
public ForeignKey setPrimaryKeyColumns(List<Column> primaryKeyColumns)

setPrimaryKeyTable	back to summary
public ForeignKey setPrimaryKeyTable(Table primaryKeyTable)

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

setShouldValidate

back to summary

public ForeignKey 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 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.

setUpdateRule	back to summary
public ForeignKey setUpdateRule(ForeignKeyConstraintType rule)

shouldValidate	back to summary
public boolean shouldValidate() In Oracle PL/SQL, the VALIDATE keyword defines whether a foreign key 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.

shouldValidate

back to summary

public boolean shouldValidate()

In Oracle PL/SQL, the VALIDATE keyword defines whether a foreign key 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.

toDisplayString	back to summary
private String toDisplayString(List<String> columnsNames)

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 ForeignKey

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail