Liquibase 4.26.0 · liquibase.change.core.AddDefaultValueChange

Modifier and Type	Field and Description
private String	catalogName
private String	columnDataType
private String	columnName
private String	defaultValue
private Boolean	defaultValueBoolean
private DatabaseFunction	defaultValueComputed
private String	defaultValueConstraintName
private String	defaultValueDate
private String	defaultValueNumeric
private SequenceNextValueFunction	defaultValueSequenceNext
private String	schemaName
private String	tableName

Access	Constructor and Description
public	AddDefaultValueChange()

Modifier and Type	Method and Description
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 Change[]	createInverses() Overrides liquibase.change.AbstractChange.createInverses. Create inverse changes that can roll back this change.
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 String	getColumnDataType()
public String	getColumnName()
public String	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getDefaultValue()
public Boolean	getDefaultValueBoolean()
public DatabaseFunction	getDefaultValueComputed()
public String	getDefaultValueConstraintName()
public String	getDefaultValueDate()
public String	getDefaultValueNumeric()
public SequenceNextValueFunction	getDefaultValueSequenceNext()
public String	getSchemaName()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getTableName()
public void	setCatalogName(String catalogName)
public void	setColumnDataType(String columnDataType)
public void	setColumnName(String columnName)
public void	setDefaultValue(String defaultValue)
public void	setDefaultValueBoolean(Boolean defaultValueBoolean)
public void	setDefaultValueComputed(DatabaseFunction defaultValueComputed)
public void	setDefaultValueConstraintName(String defaultValueConstraintName)
public void	setDefaultValueDate(String defaultValueDate)
public void	setDefaultValueNumeric(String defaultValueNumeric)
public void	setDefaultValueSequenceNext(SequenceNextValueFunction defaultValueSequenceNext)
public void	setSchemaName(String schemaName)
public void	setTableName(String tableName)
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`.

catalogName	back to summary
private String catalogName

columnDataType	back to summary
private String columnDataType

columnName	back to summary
private String columnName

defaultValue	back to summary
private String defaultValue

defaultValueBoolean	back to summary
private Boolean defaultValueBoolean

defaultValueComputed	back to summary
private DatabaseFunction defaultValueComputed

defaultValueConstraintName	back to summary
private String defaultValueConstraintName

defaultValueDate	back to summary
private String defaultValueDate

defaultValueNumeric	back to summary
private String defaultValueNumeric

defaultValueSequenceNext	back to summary
private SequenceNextValueFunction defaultValueSequenceNext

schemaName	back to summary
private String schemaName

tableName	back to summary
private String tableName

AddDefaultValueChange	back to summary
public AddDefaultValueChange()

Method Detail

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

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

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

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:column.relation.catalog since:3.0 description:Name of the database catalog

getColumnDataType	back to summary
public String getColumnDataType() Annotations @DatabaseChangeProperty description:Current data type of the column to add a default value to exampleValue:varchar(50)

getColumnName	back to summary
public String getColumnName() Annotations @DatabaseChangeProperty mustEqualExisting:column description:Name of the column to add a default value to exampleValue:fileName

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

getDefaultValue	back to summary
public String getDefaultValue() Annotations @DatabaseChangeProperty exampleValue:Something Else requiredForDatabase:none description:Default value for fields in the column. Either this property or another defaultValue* property is required.

getDefaultValueBoolean	back to summary
public Boolean getDefaultValueBoolean() Annotations @DatabaseChangeProperty requiredForDatabase:none description:Default value for a column of a boolean type.

getDefaultValueComputed	back to summary
public DatabaseFunction getDefaultValueComputed() Annotations @DatabaseChangeProperty requiredForDatabase:none description:Default value that is returned from a function or procedure call of the same type as the column. Contains the function or column name to call. Differs from defaultValue by returning the value of the function or column you specify instead of the name of the function/column as a string. Can also perform operations on the returned value.

getDefaultValueComputed

back to summary

public DatabaseFunction getDefaultValueComputed()

Annotations

@DatabaseChangeProperty
requiredForDatabase:none
description:Default value that is returned from a function or procedure call of the same type as the column. Contains the function or column name to call. Differs from defaultValue by returning the value of the function or column you specify instead of the name of the function/column as a string. Can also perform operations on the returned value.

getDefaultValueConstraintName	back to summary
public String getDefaultValueConstraintName() Annotations @DatabaseChangeProperty description:Sets a unique name for the default constraint used for a specific column. Works only along with any of the defaultValue* properties listed.

getDefaultValueDate	back to summary
public String getDefaultValueDate() Annotations @DatabaseChangeProperty requiredForDatabase:none exampleValue:2008-02-12T12:34:03 description:Default date and time value for column. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.

getDefaultValueNumeric	back to summary
public String getDefaultValueNumeric() Annotations @DatabaseChangeProperty requiredForDatabase:none exampleValue:439.2 description:Default value for a column of a numeric type. For example: integer, bigint, bigdecimal, and others.

getDefaultValueSequenceNext	back to summary
public SequenceNextValueFunction getDefaultValueSequenceNext() Annotations @DatabaseChangeProperty requiredForDatabase:none description:Sets value for a specified column by using the value of the existing sequence. With every new input, the next value of the sequence will be taken.

getSchemaName	back to summary
public String getSchemaName() Annotations @DatabaseChangeProperty mustEqualExisting:column.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:column.relation description:Name of the table containing the column to modify exampleValue:file

setCatalogName	back to summary
public void setCatalogName(String catalogName)

setColumnDataType	back to summary
public void setColumnDataType(String columnDataType)

setColumnName	back to summary
public void setColumnName(String columnName)

setDefaultValue	back to summary
public void setDefaultValue(String defaultValue)

setDefaultValueBoolean	back to summary
public void setDefaultValueBoolean(Boolean defaultValueBoolean)

setDefaultValueComputed	back to summary
public void setDefaultValueComputed(DatabaseFunction defaultValueComputed)

setDefaultValueConstraintName	back to summary
public void setDefaultValueConstraintName(String defaultValueConstraintName)

setDefaultValueDate	back to summary
public void setDefaultValueDate(String defaultValueDate)

setDefaultValueNumeric	back to summary
public void setDefaultValueNumeric(String defaultValueNumeric)

setDefaultValueSequenceNext	back to summary
public void setDefaultValueSequenceNext(SequenceNextValueFunction defaultValueSequenceNext)

setSchemaName	back to summary
public void setSchemaName(String schemaName)

setTableName	back to summary
public void setTableName(String tableName)

validate back to summary

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

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

public Class AddDefaultValueChange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail