Liquibase 4.26.0 · liquibase.structure.core.Index · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	MARK_FOREIGN_KEY Marks Index as associated with Foreign Key [FK]
public static final String	MARK_PRIMARY_KEY Marks Index as associated with Primary Key [PK]
public static final String	MARK_UNIQUE_CONSTRAINT Marks Index as associated with Unique Constraint [UC]

Access	Constructor and Description
public	Index()
public	Index(String indexName)
public	Index(String indexName, String catalogName, String schemaName, String tableName, Column... columns)

Modifier and Type	Method and Description
public void	addAssociatedWith(String item)
public Index	addColumn(Column column)
private boolean	allColumnObjects(List<E> columns)
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. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Set<String>	getAssociatedWith()
public String	getAssociatedWithAsString()
public Boolean	getClustered()
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 Object	getSerializableFieldValue(String field) Overrides liquibase.structure.AbstractDatabaseObject.getSerializableFieldValue. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.
public Table	getTable() Deprecated Use `getRelation()`
public String	getTablespace()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isAssociatedWith(String keyword)
public Boolean	isUnique()
public void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.structure.AbstractDatabaseObject.load. Implements liquibase.serializer.LiquibaseSerializable.load.
public Index	setClustered(Boolean clustered)
public Index	setColumns(List<Column> columns)
public Index	setName(String the new name for the database object name) Implements liquibase.structure.DatabaseObject.setName. Sets the name for the database object.
public Index	setRelation(Relation relation)
public Index	setTable(Relation table) Deprecated Use `setRelation(Relation)`
public Index	setTablespace(String tablespace)
public Index	setUnique(Boolean value)
public String	Returns: A (hopefully) human-readable name toString() Overrides liquibase.structure.AbstractDatabaseObject.toString. (Try to) provide a human-readable name for the index.

MARK_FOREIGN_KEY	back to summary
public static final String MARK_FOREIGN_KEY Marks Index as associated with Foreign Key [FK]

MARK_PRIMARY_KEY	back to summary
public static final String MARK_PRIMARY_KEY Marks Index as associated with Primary Key [PK]

MARK_UNIQUE_CONSTRAINT	back to summary
public static final String MARK_UNIQUE_CONSTRAINT Marks Index as associated with Unique Constraint [UC]

Index	back to summary
public Index()

Index	back to summary
public Index(String indexName)

Index	back to summary
public Index(String indexName, String catalogName, String schemaName, String tableName, Column... columns)

Method Detail

addAssociatedWith	back to summary
public void addAssociatedWith(String item)

addColumn	back to summary
public Index addColumn(Column column)

allColumnObjects	back to summary
private boolean allColumnObjects(List<E> columns)

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 obj) 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 obj: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 obj)

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

obj: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

getAssociatedWith	back to summary
public Set<String> getAssociatedWith()

getAssociatedWithAsString	back to summary
public String getAssociatedWithAsString()

getClustered	back to summary
public Boolean getClustered()

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

getSerializableFieldValue	back to summary
public Object getSerializableFieldValue(String field) Overrides liquibase.structure.AbstractDatabaseObject.getSerializableFieldValue. Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue. Annotations @Override

getSerializableFieldValue

back to summary

public Object getSerializableFieldValue(String field)

Overrides liquibase.structure.AbstractDatabaseObject.getSerializableFieldValue.

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

Annotations

@Override

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

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

isAssociatedWith	back to summary
public boolean isAssociatedWith(String keyword)

isUnique	back to summary
public Boolean isUnique()

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

setClustered	back to summary
public Index setClustered(Boolean clustered)

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

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

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 Index setRelation(Relation relation)

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

setTablespace	back to summary
public Index setTablespace(String tablespace)

setUnique	back to summary
public Index setUnique(Boolean value)

toString	back to summary
public String toString() Overrides liquibase.structure.AbstractDatabaseObject.toString. (Try to) provide a human-readable name for the index. Returns:String A (hopefully) human-readable name Annotations @Override

toString

back to summary

public String toString()

Overrides liquibase.structure.AbstractDatabaseObject.toString.

(Try to) provide a human-readable name for the index.

Returns:String

A (hopefully) human-readable name

Annotations

@Override

public Class Index

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail