Package liquibase.change.core
Class CreateIndexChange
- java.lang.Object
-
- liquibase.AbstractExtensibleObject
-
- liquibase.plugin.AbstractPlugin
-
- liquibase.change.AbstractChange
-
- liquibase.change.core.CreateIndexChange
-
- All Implemented Interfaces:
Cloneable
,Change
,ChangeWithColumns<AddColumnConfig>
,ExtensibleObject
,Plugin
,LiquibaseSerializable
public class CreateIndexChange extends AbstractChange implements ChangeWithColumns<AddColumnConfig>
Creates an index on an existing column.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface liquibase.serializer.LiquibaseSerializable
LiquibaseSerializable.SerializationType
-
-
Field Summary
-
Fields inherited from class liquibase.change.AbstractChange
NODENAME_COLUMN
-
Fields inherited from interface liquibase.change.Change
EMPTY_CHANGE, SHOULD_EXECUTE
-
Fields inherited from interface liquibase.serializer.LiquibaseSerializable
GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE
-
Fields inherited from interface liquibase.plugin.Plugin
PRIORITY_DATABASE, PRIORITY_DEFAULT, PRIORITY_NOT_APPLICABLE, PRIORITY_SPECIALIZED
-
-
Constructor Summary
Constructors Constructor Description CreateIndexChange()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addColumn(AddColumnConfig column)
Add a column configuration to the Change.ChangeStatus
checkStatus(Database database)
Validate that this change executed successfully against the given database.protected Change[]
createInverses()
Create inverse changes that can roll back this change.SqlStatement[]
generateStatements(Database database)
Generates theSqlStatement
objects required to run the change for the given database.String
getAssociatedWith()
String
getCatalogName()
Boolean
getClustered()
List<AddColumnConfig>
getColumns()
Return all theColumnConfig
objects defined for thisChange
String
getConfirmationMessage()
Confirmation message to be displayed after the change is executed.String
getIndexName()
String
getSchemaName()
Object
getSerializableFieldValue(String field)
String
getSerializedObjectNamespace()
String
getTableName()
String
getTablespace()
Boolean
isUnique()
void
setAssociatedWith(String associatedWith)
void
setCatalogName(String catalogName)
void
setClustered(Boolean clustered)
void
setColumns(List<AddColumnConfig> columns)
void
setIndexName(String indexName)
void
setSchemaName(String schemaName)
void
setTableName(String tableName)
void
setTablespace(String tablespace)
void
setUnique(Boolean isUnique)
ValidationErrors
validate(Database database)
Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to theSqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)
method on theSqlStatement
objects returned byChange.generateStatements(liquibase.database.Database)
.-
Methods inherited from class liquibase.change.AbstractChange
createChangeMetaData, createChangeParameterMetadata, createDescriptionMetaData, createEmptyColumnConfig, createExampleValueMetaData, createMustEqualExistingMetaData, createRequiredDatabasesMetaData, createSerializationTypeMetaData, createSinceMetaData, createSupportedDatabasesMetaData, customLoadLogic, equals, finishInitialization, generateCheckSum, generateRollbackStatements, generateRollbackStatementsVolatile, generateStatementsVolatile, getAffectedDatabaseObjects, getChangeSet, getDescription, getExcludedFieldFilters, getResourceAccessor, getSerializableFieldNamespace, getSerializableFields, getSerializableFieldType, getSerializedObjectName, hashCode, isInvalidProperty, load, serialize, serializeValue, setChangeSet, setResourceAccessor, shouldExecuteChange, supports, supportsRollback, toString, warn
-
Methods inherited from class liquibase.AbstractExtensibleObject
clone, describe, get, get, get, getAttributes, getFieldValue, getObjectMetaData, getValuePath, has, set
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface liquibase.ExtensibleObject
clone, describe, get, get, getAttributes, getObjectMetaData, getValuePath, has, set
-
-
-
-
Method Detail
-
getIndexName
public String getIndexName()
-
setIndexName
public void setIndexName(String indexName)
-
getCatalogName
public String getCatalogName()
-
setCatalogName
public void setCatalogName(String catalogName)
-
getSchemaName
public String getSchemaName()
-
setSchemaName
public void setSchemaName(String schemaName)
-
getTableName
public String getTableName()
-
setTableName
public void setTableName(String tableName)
-
getColumns
public List<AddColumnConfig> getColumns()
Description copied from interface:ChangeWithColumns
Return all theColumnConfig
objects defined for thisChange
- Specified by:
getColumns
in interfaceChangeWithColumns<AddColumnConfig>
-
setColumns
public void setColumns(List<AddColumnConfig> columns)
- Specified by:
setColumns
in interfaceChangeWithColumns<AddColumnConfig>
-
addColumn
public void addColumn(AddColumnConfig column)
Description copied from interface:ChangeWithColumns
Add a column configuration to the Change.- Specified by:
addColumn
in interfaceChangeWithColumns<AddColumnConfig>
-
getTablespace
public String getTablespace()
-
setTablespace
public void setTablespace(String tablespace)
-
generateStatements
public SqlStatement[] generateStatements(Database database)
Description copied from interface:Change
Generates theSqlStatement
objects required to run the change for the given database. NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well. If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true fromChange.generateStatementsVolatile(liquibase.database.Database)
.- Specified by:
generateStatements
in interfaceChange
-
createInverses
protected Change[] createInverses()
Description copied from class:AbstractChange
Create inverse changes that can roll back this change. This method is intended to be overridden by Change implementations that have a logical inverse operation. Default implementation returns null. IfAbstractChange.generateRollbackStatements(liquibase.database.Database)
is overridden, this method may not be called.- Overrides:
createInverses
in classAbstractChange
- Returns:
- Return null if there is no corresponding inverse and therefore automatic rollback is not possible. Return an empty array to have a no-op rollback.
- See Also:
#supportsRollback
-
checkStatus
public ChangeStatus checkStatus(Database database)
Description copied from interface:Change
Validate that this change executed successfully against the given database. This will check that the update completed at a high level plus check details of the change. For example, a change to add a column will check that the column exists plus data type, default values, etc.- Specified by:
checkStatus
in interfaceChange
- Overrides:
checkStatus
in classAbstractChange
-
getConfirmationMessage
public String getConfirmationMessage()
Description copied from interface:Change
Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation.- Specified by:
getConfirmationMessage
in interfaceChange
-
isUnique
public Boolean isUnique()
-
setUnique
public void setUnique(Boolean isUnique)
- Parameters:
isUnique
- the isUnique to set
-
getAssociatedWith
public String getAssociatedWith()
- Returns:
- Index associations. Valid values:
- primaryKey
- foreignKey
- uniqueConstraint
- none
-
setAssociatedWith
public void setAssociatedWith(String associatedWith)
-
getClustered
public Boolean getClustered()
-
setClustered
public void setClustered(Boolean clustered)
-
getSerializedObjectNamespace
public String getSerializedObjectNamespace()
- Specified by:
getSerializedObjectNamespace
in interfaceLiquibaseSerializable
- Overrides:
getSerializedObjectNamespace
in classAbstractChange
-
getSerializableFieldValue
public Object getSerializableFieldValue(String field)
- Specified by:
getSerializableFieldValue
in interfaceLiquibaseSerializable
- Overrides:
getSerializableFieldValue
in classAbstractChange
-
validate
public ValidationErrors validate(Database database)
Description copied from class:AbstractChange
Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to theSqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)
method on theSqlStatement
objects returned byChange.generateStatements(liquibase.database.Database)
. If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors- Specified by:
validate
in interfaceChange
- Overrides:
validate
in classAbstractChange
-
-