Top Fields Constructors Methods
liquibase.change.core

public Class SetColumnRemarksChange

extends AbstractChange
Class Inheritance
Annotations
@DatabaseChange
name:setColumnRemarks
description:Set remarks on a column
priority:1
Imports
liquibase.change.AbstractChange, .ChangeMetaData, .DatabaseChange, .DatabaseChangeProperty, liquibase.database.Database, liquibase.exception.ValidationErrors, liquibase.statement.SqlStatement, liquibase.statement.core.SetColumnRemarksStatement

Field Summary

Modifier and TypeField and Description
private String
catalogName

private String
columnDataType

private String
columnName

private String
columnParentType

private String
remarks

private String
schemaName

private String
tableName

Inherited from liquibase.change.AbstractChange:
NODENAME_COLUMN

Constructor Summary

AccessConstructor and Description
public
SetColumnRemarksChange()

Method Summary

Modifier and TypeMethod and Description
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
getColumnParentType()

public String
getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed.

public String
getRemarks()

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
setColumnParentType(String columnParentType)

public void
setRemarks(String remarks)

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.

Inherited from liquibase.change.AbstractChange:
checkStatuscreateChangeMetaDatacreateChangeParameterMetadatacreateDescriptionMetaDatacreateEmptyColumnConfigcreateExampleValueMetaDatacreateInversescreateMustEqualExistingMetaDatacreateRequiredDatabasesMetaDatacreateSerializationTypeMetaDatacreateSinceMetaDatacreateSupportedDatabasesMetaDatacustomLoadLogicequalsfinishInitializationgenerateCheckSumgenerateRollbackStatementsgenerateRollbackStatementsVolatilegenerateStatementsVolatilegetAffectedDatabaseObjectsgetChangeSetgetDescriptiongetExcludedFieldFiltersgetResourceAccessorgetSerializableFieldNamespacegetSerializableFieldsgetSerializableFieldTypegetSerializableFieldValuegetSerializedObjectNamehashCodeisInvalidPropertyloadmodifyserializeserializeValuesetChangeSetsetResourceAccessorshouldExecuteChangesupportssupportsRollbacktoStringwarn

Field Detail

catalogNameback to summary
private String catalogName
columnDataTypeback to summary
private String columnDataType
columnNameback to summary
private String columnName
columnParentTypeback to summary
private String columnParentType
remarksback to summary
private String remarks
schemaNameback to summary
private String schemaName
tableNameback to summary
private String tableName

Constructor Detail

SetColumnRemarksChangeback to summary
public SetColumnRemarksChange()

Method Detail

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
getCatalogNameback to summary
public String getCatalogName()
Annotations
@DatabaseChangeProperty
description:Name of the database catalog
getColumnDataTypeback to summary
public String getColumnDataType()
Annotations
@DatabaseChangeProperty
description:Data type of the column
getColumnNameback to summary
public String getColumnName()
Annotations
@DatabaseChangeProperty
description:Name of the column to set remarks on
getColumnParentTypeback to summary
public String getColumnParentType()
Annotations
@DatabaseChangeProperty
description:Indicates the parent object type of the column we are setting remarks against. Valid values are VIEW and TABLE. Default: TABLE.
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
getRemarksback to summary
public String getRemarks()
Annotations
@DatabaseChangeProperty
description:A brief descriptive comment written to the column metadata.
getSchemaNameback to summary
public String getSchemaName()
Annotations
@DatabaseChangeProperty
description:Name of the database schema
getSerializedObjectNamespaceback to summary
public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations
@Override
getTableNameback to summary
public String getTableName()
Annotations
@DatabaseChangeProperty
description:Name of the table containing the column to set remarks on
setCatalogNameback to summary
public void setCatalogName(String catalogName)
setColumnDataTypeback to summary
public void setColumnDataType(String columnDataType)
setColumnNameback to summary
public void setColumnName(String columnName)
setColumnParentTypeback to summary
public void setColumnParentType(String columnParentType)
setRemarksback to summary
public void setRemarks(String remarks)
setSchemaNameback to summary
public void setSchemaName(String schemaName)
setTableNameback to summary
public void setTableName(String tableName)
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