Top Fields Constructors Methods
liquibase.change.core

public Class UpdateDataChange

extends AbstractModifyDataChange
implements ChangeWithColumns<ColumnConfig>
Class Inheritance
All Implemented Interfaces
liquibase.change.ChangeWithColumns
Annotations
@DatabaseChange
name:update
description:Updates data in an existing table
priority:1
appliesTo:table
Imports
liquibase.Scope, liquibase.change.*, liquibase.database.Database, liquibase.database.core.OracleDatabase, liquibase.exception.ValidationErrors, liquibase.parser.core.ParsedNode, .ParsedNodeException, liquibase.resource.ResourceAccessor, liquibase.statement.SequenceCurrentValueFunction, .SequenceNextValueFunction, .SqlStatement, .UpdateExecutablePreparedStatement, liquibase.statement.core.UpdateStatement, java.util.ArrayList, .List

Field Summary

Modifier and TypeField and Description
private List<ColumnConfig>
columns

Inherited from liquibase.change.core.AbstractModifyDataChange:
catalogNameschemaNametableNamewherewhereParams

Constructor Summary

AccessConstructor and Description
public
UpdateDataChange()

Method Summary

Modifier and TypeMethod and Description
public void
addColumn(ColumnConfig column)

Implements liquibase.change.ChangeWithColumns.addColumn.

Add a column configuration to the Change.

public ChangeStatus
checkStatus(Database database)

Overrides liquibase.change.AbstractChange.checkStatus.

Implements liquibase.change.Change.checkStatus.

Validate that this change executed successfully against the given database.

protected void
customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor)

Overrides liquibase.change.AbstractChange.customLoadLogic.

public SqlStatement[]
generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

Generates the SqlStatement objects required to run the change for the given database.

public List<ColumnConfig>
getColumns()

Implements liquibase.change.ChangeWithColumns.getColumns.

Return all the ColumnConfig objects defined for this Change

public String
getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed.

public String
getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

public void
removeColumn(ColumnConfig column)

public void
setColumns(List<ColumnConfig> columns)

Implements liquibase.change.ChangeWithColumns.setColumns.

public ValidationErrors
validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by generateStatements.

Inherited from liquibase.change.core.AbstractModifyDataChange:
addWhereParamgetCatalogNamegetSchemaNamegetTableNamegetWheregetWhereClausegetWhereParamsremoveWhereParamsetCatalogNamesetSchemaNamesetTableNamesetWheresetWhereClause

Field Detail

columnsback to summary
private List<ColumnConfig> columns

Constructor Detail

UpdateDataChangeback to summary
public UpdateDataChange()

Method Detail

addColumnback to summary
public void addColumn(ColumnConfig column)

Implements liquibase.change.ChangeWithColumns.addColumn.

Doc from liquibase.change.ChangeWithColumns.addColumn.

Add a column configuration to the Change.

Annotations
@Override
checkStatusback to summary
public ChangeStatus checkStatus(Database database)

Overrides liquibase.change.AbstractChange.checkStatus.

Implements liquibase.change.Change.checkStatus.

Doc from liquibase.change.Change.checkStatus.

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.

Annotations
@Override
customLoadLogicback to summary
protected void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Overrides liquibase.change.AbstractChange.customLoadLogic.

Annotations
@Override
generateStatementsback to summary
public SqlStatement[] generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

Doc from liquibase.change.Change.generateStatements.

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 generateStatementsVolatile.
Annotations
@Override
getColumnsback to summary
public List<ColumnConfig> getColumns()

Implements liquibase.change.ChangeWithColumns.getColumns.

Doc from liquibase.change.ChangeWithColumns.getColumns.

Return all the ColumnConfig objects defined for this Change

Annotations
@Override
@DatabaseChangeProperty
description:Data to update
requiredForDatabase:all
getConfirmationMessageback to summary
public String getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Doc from liquibase.change.Change.getConfirmationMessage.

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.

Annotations
@Override
getSerializedObjectNamespaceback to summary
public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations
@Override
removeColumnback to summary
public void removeColumn(ColumnConfig column)
setColumnsback to summary
public void setColumns(List<ColumnConfig> columns)

Implements liquibase.change.ChangeWithColumns.setColumns.

Annotations
@Override
validateback to summary
public ValidationErrors validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

Doc from liquibase.change.AbstractChange.validate.

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by generateStatements. 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

Annotations
@Override