Liquibase 4.26.0 · liquibase.change.core.AddColumnChange

Modifier and Type	Field and Description
private String	catalogName
private List<AddColumnConfig>	columns
private String	schemaName
private String	tableName

Modifier and Type

Field and Description

private String

catalogName

private List<AddColumnConfig>

columns

private String

schemaName

private String

tableName

Access	Constructor and Description
public	AddColumnChange()

Access

Constructor and Description

public

AddColumnChange()

Modifier and Type	Method and Description
public void	addColumn(AddColumnConfig 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.
private AddNotNullConstraintChange	createAddNotNullConstraintChange(AddColumnConfig column, ConstraintsConfig constraints)
protected Change[]	createInverses() Overrides liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change.
private NotNullConstraint	createNotNullConstraint(ConstraintsConfig constraintsConfig)
private List<SqlStatement>	generateAddNotNullConstraintStatements(AddColumnConfig column, ConstraintsConfig constraints, Database database)
public SqlStatement[]	generateStatements(Database database) Implements liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given database.
public String	getCatalogName()
public List<AddColumnConfig>	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	getSchemaName()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getTableName()
public void	modify(ChangeVisitor changeVisitor) Overrides liquibase.change.AbstractChange.modify. Implements liquibase.change.Change.modify.
public void	removeColumn(ColumnConfig column)
public void	setCatalogName(String catalogName)
public void	setColumns(List<AddColumnConfig> columns) Implements liquibase.change.ChangeWithColumns.setColumns.
public void	setSchemaName(String schemaName)
public void	setTableName(String tableName)

Modifier and Type

Method and Description

public void

addColumn(AddColumnConfig 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.

private AddNotNullConstraintChange

createAddNotNullConstraintChange(AddColumnConfig column, ConstraintsConfig constraints)

protected Change[]

createInverses()

Overrides liquibase.change.AbstractChange.createInverses.

Create inverse changes that can roll back this change.

private NotNullConstraint

createNotNullConstraint(ConstraintsConfig constraintsConfig)

private List<SqlStatement>

generateAddNotNullConstraintStatements(AddColumnConfig column, ConstraintsConfig constraints, Database database)

public SqlStatement[]

generateStatements(Database database)

Implements liquibase.change.Change.generateStatements.

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

public String

getCatalogName()

public List<AddColumnConfig>

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

getSchemaName()

public String

getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

public String

getTableName()

public void

modify(ChangeVisitor changeVisitor)

Overrides liquibase.change.AbstractChange.modify.

Implements liquibase.change.Change.modify.

public void

removeColumn(ColumnConfig column)

public void

setCatalogName(String catalogName)

public void

setColumns(List<AddColumnConfig> columns)

Implements liquibase.change.ChangeWithColumns.setColumns.

public void

setSchemaName(String schemaName)

public void

setTableName(String tableName)

catalogName	back to summary
private String catalogName

catalogName

back to summary

private String catalogName

columns	back to summary
private List<AddColumnConfig> columns

columns

back to summary

private List<AddColumnConfig> columns

schemaName	back to summary
private String schemaName

schemaName

back to summary

private String schemaName

tableName	back to summary
private String tableName

tableName

back to summary

private String tableName

AddColumnChange	back to summary
public AddColumnChange()

AddColumnChange

back to summary

public AddColumnChange()

Method Detail

addColumn	back to summary
public void addColumn(AddColumnConfig column) Implements liquibase.change.ChangeWithColumns.addColumn. Doc from liquibase.change.ChangeWithColumns.addColumn. Add a column configuration to the Change. Annotations @Override

addColumn

back to summary

public void addColumn(AddColumnConfig column)

Implements liquibase.change.ChangeWithColumns.addColumn.

Doc from liquibase.change.ChangeWithColumns.addColumn.

Add a column configuration to the Change.

Annotations

@Override

checkStatus	back 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

checkStatus

back 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

createAddNotNullConstraintChange	back to summary
private AddNotNullConstraintChange createAddNotNullConstraintChange(AddColumnConfig column, ConstraintsConfig constraints)

createInverses back to summary

createInverses	back to summary
protected Change[] createInverses() Overrides liquibase.change.AbstractChange.createInverses. Doc from liquibase.change.AbstractChange.createInverses. 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. If `generateRollbackStatements(liquibase.database.Database)` is overridden, this method may not be called. Returns:Change[] 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. Annotations @Override

protected Change[] createInverses()

Overrides liquibase.change.AbstractChange.createInverses.

Doc from liquibase.change.AbstractChange.createInverses.

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.

If generateRollbackStatements(liquibase.database.Database) is overridden, this method may not be called.

Returns:Change[]

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.

Annotations

@Override

createNotNullConstraint	back to summary
private NotNullConstraint createNotNullConstraint(ConstraintsConfig constraintsConfig)

generateAddNotNullConstraintStatements	back to summary
private List<SqlStatement> generateAddNotNullConstraintStatements(AddColumnConfig column, ConstraintsConfig constraints, Database database)

generateStatements back to summary

generateStatements	back 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

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

getCatalogName	back to summary
public String getCatalogName() Annotations @DatabaseChangeProperty mustEqualExisting:relation.catalog since:3.0 description:Name of the database catalog

getColumns back to summary

getColumns	back to summary
public List<AddColumnConfig> getColumns() Implements liquibase.change.ChangeWithColumns.getColumns. Doc from liquibase.change.ChangeWithColumns.getColumns. Return all the `ColumnConfig` objects defined for this `Change` Annotations @Override @DatabaseChangeProperty requiredForDatabase:all description:Column constraint and foreign key information. Setting the "defaultValue" attribute specifies a default value for the column. Setting the "value" attribute sets all rows existing to the specified value without modifying the column default.

public List<AddColumnConfig> getColumns()

Implements liquibase.change.ChangeWithColumns.getColumns.

Doc from liquibase.change.ChangeWithColumns.getColumns.

Return all the ColumnConfig objects defined for this Change

Annotations

@Override
@DatabaseChangeProperty
requiredForDatabase:all
description:Column constraint and foreign key information. Setting the "defaultValue" attribute specifies a default value for the column. Setting the "value" attribute sets all rows existing to the specified value without modifying the column default.

getConfirmationMessage	back 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

getConfirmationMessage

back 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

getSchemaName	back to summary
public String getSchemaName() Annotations @DatabaseChangeProperty mustEqualExisting:relation.schema description:Name of the database schema

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getTableName	back to summary
public String getTableName() Annotations @DatabaseChangeProperty mustEqualExisting:table description:Name of the table to add the column to

modify	back to summary
public void modify(ChangeVisitor changeVisitor) throws ParsedNodeException Overrides liquibase.change.AbstractChange.modify. Implements liquibase.change.Change.modify. Annotations @Override Exceptions ParsedNodeException: Doc from liquibase.change.Change.modify. if there is an error processing ChangeVisitor

modify

back to summary

public void modify(ChangeVisitor changeVisitor) throws ParsedNodeException

Overrides liquibase.change.AbstractChange.modify.

Implements liquibase.change.Change.modify.

Annotations

@Override

Exceptions

ParsedNodeException:

Doc from liquibase.change.Change.modify.

if there is an error processing ChangeVisitor

removeColumn	back to summary
public void removeColumn(ColumnConfig column)

setCatalogName	back to summary
public void setCatalogName(String catalogName)

setColumns	back to summary
public void setColumns(List<AddColumnConfig> columns) Implements liquibase.change.ChangeWithColumns.setColumns. Annotations @Override

setColumns

back to summary

public void setColumns(List<AddColumnConfig> columns)

Implements liquibase.change.ChangeWithColumns.setColumns.

Annotations

@Override

setSchemaName	back to summary
public void setSchemaName(String schemaName)

setTableName	back to summary
public void setTableName(String tableName)

public Class AddColumnChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail