Liquibase 4.26.0 · liquibase.structure.core.PrimaryKey

Access	Constructor and Description
public	PrimaryKey()
public	PrimaryKey(String name, String tableCatalogName, String tableSchemaName, String tableName, Column... columns)

Method Summary

Modifier and Type	Method and Description
public PrimaryKey	Returns: a reference to the updated PrimaryKey object. addColumn(int the position where to insert or replace the column position, Column the new column column) Adds a new column to the column list of this PrimaryKey.
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<String>	getColumnNamesAsList()
public List<Column>	getColumns()
public DatabaseObject[]	getContainingObjects() Implements liquibase.structure.DatabaseObject.getContainingObjects.
public String	getName() Implements liquibase.structure.DatabaseObject.getName.
public Schema	getSchema() Implements liquibase.structure.DatabaseObject.getSchema.
public Table	Returns: the Table object, or null if not initialized yet. getTable() Returns the Table object this PrimaryKey belongs to.
public String	getTablespace()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isCertainName()
public PrimaryKey	setBackingIndex(Index backingIndex)
public PrimaryKey	setCertainName(boolean certainName)
public PrimaryKey	setName(String the new name for the database object name) Implements liquibase.structure.DatabaseObject.setName. Sets the name for the database object.
public PrimaryKey	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 primary keys - only new data would be checked to see if it complies with the constraint logic. The default state for primary keys is to have 'ENABLE VALIDATE' set. shouldValidate)
public PrimaryKey	Returns: the updated object setTable(Table the table object to set as the container for this PrimaryKey table) Sets the Table object this PrimaryKey belongs to.
public PrimaryKey	setTablespace(String tablespace)
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

PrimaryKey	back to summary
public PrimaryKey()

PrimaryKey	back to summary
public PrimaryKey(String name, String tableCatalogName, String tableSchemaName, String tableName, Column... columns)

Method Detail

addColumn	back to summary
public PrimaryKey addColumn(int position, Column column) Adds a new column to the column list of this PrimaryKey. The first column has the position 0. If you specify a position that is greater than the number of columns present, undefined columns (NULL expressions) will be added as padding. If a position that is already occupied by a column is specified, that column will be replaced. Parameters position:int the position where to insert or replace the column column:Column the new column Returns:PrimaryKey a reference to the updated PrimaryKey object.

addColumn

back to summary

public PrimaryKey addColumn(int position, Column column)

Adds a new column to the column list of this PrimaryKey. The first column has the position 0. If you specify a position that is greater than the number of columns present, undefined columns (NULL expressions) will be added as padding. If a position that is already occupied by a column is specified, that column will be replaced.

Parameters

position:int: the position where to insert or replace the column
column:Column: the new column

Returns:PrimaryKey

a reference to the updated PrimaryKey object.

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

getColumnNamesAsList	back to summary
public List<String> getColumnNamesAsList()

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

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() Returns the Table object this PrimaryKey belongs to. Returns:Table the Table object, or null if not initialized yet.

getTable

back to summary

public Table getTable()

Returns the Table object this PrimaryKey belongs to.

Returns:Table: the Table object, or null if not initialized yet.

getTablespace	back to summary
public String getTablespace()

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

isCertainName	back to summary
public boolean isCertainName()

setBackingIndex	back to summary
public PrimaryKey setBackingIndex(Index backingIndex)

setCertainName	back to summary
public PrimaryKey setCertainName(boolean certainName)

setName	back to summary
public PrimaryKey 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:PrimaryKey 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 PrimaryKey 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:PrimaryKey

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

Annotations

@Override

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

setShouldValidate

back to summary

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

setTable	back to summary
public PrimaryKey setTable(Table table) Sets the Table object this PrimaryKey belongs to. Parameters table:Table the table object to set as the container for this PrimaryKey Returns:PrimaryKey the updated object

setTable

back to summary

public PrimaryKey setTable(Table table)

Sets the Table object this PrimaryKey belongs to.

Parameters

table:Table: the table object to set as the container for this PrimaryKey

Returns:PrimaryKey

the updated object

setTablespace	back to summary
public PrimaryKey setTablespace(String tablespace)

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 PrimaryKey

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail