Package liquibase.change.core
Class AddPrimaryKeyChange
- java.lang.Object
-
- liquibase.AbstractExtensibleObject
-
- liquibase.plugin.AbstractPlugin
-
- liquibase.change.AbstractChange
-
- liquibase.change.core.AddPrimaryKeyChange
-
- All Implemented Interfaces:
Cloneable
,Change
,ExtensibleObject
,Plugin
,LiquibaseSerializable
public class AddPrimaryKeyChange extends AbstractChange
Creates a primary key out of an existing column or set of columns.
-
-
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 AddPrimaryKeyChange()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
getCatalogName()
Boolean
getClustered()
String
getColumnNames()
String
getConfirmationMessage()
Confirmation message to be displayed after the change is executed.String
getConstraintName()
String
getForIndexCatalogName()
String
getForIndexName()
String
getForIndexSchemaName()
String
getSchemaName()
String
getSerializedObjectNamespace()
String
getTableName()
String
getTablespace()
Boolean
getValidate()
the VALIDATE keyword defines whether a primary key constraint on a column in a table should be checked if it refers to a valid row or not.void
setCatalogName(String catalogName)
void
setClustered(Boolean clustered)
void
setColumnNames(String columnNames)
void
setConstraintName(String constraintName)
void
setForIndexCatalogName(String forIndexCatalogName)
void
setForIndexName(String forIndexName)
void
setForIndexSchemaName(String forIndexSchemaName)
void
setSchemaName(String schemaName)
void
setTableName(String tableName)
void
setTablespace(String tablespace)
void
setValidate(Boolean shouldValidate)
-
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, getSerializableFieldValue, getSerializedObjectName, hashCode, isInvalidProperty, load, modify, serialize, serializeValue, setChangeSet, setResourceAccessor, shouldExecuteChange, supports, supportsRollback, toString, validate, 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
-
getTableName
public String getTableName()
-
setTableName
public void setTableName(String tableName)
-
getCatalogName
public String getCatalogName()
-
setCatalogName
public void setCatalogName(String catalogName)
-
getSchemaName
public String getSchemaName()
-
setSchemaName
public void setSchemaName(String schemaName)
-
getColumnNames
public String getColumnNames()
-
setColumnNames
public void setColumnNames(String columnNames)
-
getConstraintName
public String getConstraintName()
-
setConstraintName
public void setConstraintName(String constraintName)
-
getForIndexName
public String getForIndexName()
-
setForIndexName
public void setForIndexName(String forIndexName)
-
getForIndexSchemaName
public String getForIndexSchemaName()
-
setForIndexSchemaName
public void setForIndexSchemaName(String forIndexSchemaName)
-
getForIndexCatalogName
public String getForIndexCatalogName()
-
setForIndexCatalogName
public void setForIndexCatalogName(String forIndexCatalogName)
-
getTablespace
public String getTablespace()
-
setTablespace
public void setTablespace(String tablespace)
-
getClustered
public Boolean getClustered()
-
setClustered
public void setClustered(Boolean clustered)
-
getValidate
public Boolean getValidate()
the VALIDATE keyword defines whether a primary key constraint on a column in a table should be checked if it refers to a valid row or not.- Returns:
- true if ENABLE VALIDATE (this is the default), or false if ENABLE NOVALIDATE.
-
setValidate
public void setValidate(Boolean shouldValidate)
- Parameters:
shouldValidate
- - 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.
-
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)
.
-
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
-
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
-
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.
-
getSerializedObjectNamespace
public String getSerializedObjectNamespace()
- Specified by:
getSerializedObjectNamespace
in interfaceLiquibaseSerializable
- Overrides:
getSerializedObjectNamespace
in classAbstractChange
-
-