liquibase.change.core
Class DropColumnChange
java.lang.Object
liquibase.change.AbstractChange
liquibase.change.core.DropColumnChange
- All Implemented Interfaces:
- Change, ChangeWithColumns<ColumnConfig>, LiquibaseSerializable
public class DropColumnChange
- extends AbstractChange
- implements ChangeWithColumns<ColumnConfig>
Drops an existing column from a table.
Methods inherited from class liquibase.change.AbstractChange |
createChangeMetaData, createChangeParameterMetadata, createDescriptionMetaData, createEmptyColumnConfig, createExampleValueMetaData, createInverses, createMustEqualExistingMetaData, createRequiredDatabasesMetaData, createSerializationTypeMetaData, createSinceMetaData, createSupportedDatabasesMetaData, customLoadLogic, finishInitialization, generateCheckSum, generateRollbackStatements, generateRollbackStatementsVolatile, getAffectedDatabaseObjects, getChangeSet, getDescription, getResourceAccessor, getSerializableFieldNamespace, getSerializableFields, getSerializableFieldType, getSerializedObjectName, isInvalidProperty, load, serialize, serializeValue, setChangeSet, setResourceAccessor, supportsRollback, toString, warn |
DropColumnChange
public DropColumnChange()
generateStatementsVolatile
public boolean generateStatementsVolatile(Database database)
- Description copied from class:
AbstractChange
- Implementation delegates logic to the
SqlGenerator.generateStatementsIsVolatile(Database)
method on the SqlStatement
objects returned by Change.generateStatements(liquibase.database.Database)
.
If zero or null SqlStatements are returned by generateStatements then this method returns false.
- Specified by:
generateStatementsVolatile
in interface Change
- Overrides:
generateStatementsVolatile
in class AbstractChange
supports
public boolean supports(Database database)
- Description copied from class:
AbstractChange
- Implementation delegates logic to the
SqlGenerator.supports(liquibase.statement.SqlStatement, liquibase.database.Database)
method on the SqlStatement
objects returned by Change.generateStatements(liquibase.database.Database)
.
If no or null SqlStatements are returned by generateStatements then this method returns true.
If AbstractChange.generateStatementsVolatile(liquibase.database.Database)
returns true, we cannot call generateStatements and so assume true.
- Specified by:
supports
in interface Change
- Overrides:
supports
in class AbstractChange
validate
public ValidationErrors validate(Database database)
- Description copied from class:
AbstractChange
- Implementation checks the ChangeParameterMetaData for declared required fields
and also delegates logic to the
SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)
method on the SqlStatement
objects returned by Change.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 interface Change
- Overrides:
validate
in class AbstractChange
getColumnName
public String getColumnName()
setColumnName
public void setColumnName(String columnName)
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)
generateStatements
public SqlStatement[] generateStatements(Database database)
- Description copied from interface:
Change
- Generates the
SqlStatement
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 from Change.generateStatementsVolatile(liquibase.database.Database)
.
- Specified by:
generateStatements
in interface Change
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 interface Change
- Overrides:
checkStatus
in class AbstractChange
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 interface Change
getSerializedObjectNamespace
public String getSerializedObjectNamespace()
- Specified by:
getSerializedObjectNamespace
in interface LiquibaseSerializable
- Overrides:
getSerializedObjectNamespace
in class AbstractChange
getSerializableFieldValue
public Object getSerializableFieldValue(String field)
- Specified by:
getSerializableFieldValue
in interface LiquibaseSerializable
- Overrides:
getSerializableFieldValue
in class AbstractChange
addColumn
public void addColumn(ColumnConfig column)
- Description copied from interface:
ChangeWithColumns
- Add a column configuration to the Change.
- Specified by:
addColumn
in interface ChangeWithColumns<ColumnConfig>
getColumns
public List<ColumnConfig> getColumns()
- Description copied from interface:
ChangeWithColumns
- Return all the
ColumnConfig
objects defined for this Change
- Specified by:
getColumns
in interface ChangeWithColumns<ColumnConfig>
setColumns
public void setColumns(List<ColumnConfig> columns)
- Specified by:
setColumns
in interface ChangeWithColumns<ColumnConfig>
Copyright © 2016 Liquibase.org. All rights reserved.