Liquibase® version 3.8.5 is now available! Get it for free.
2018 XML Announcement
News All Previous Posts >>

Subscribe for email updates

- and/or -

Change: ‘setColumnRemarks’

Set remarks on a column

Available Attributes

NameDescription
catalogNameName of the catalogSupported by: asany, db2, db2z, h2, mariadb, mysql, oracle, postgresqlE.g. 'cat'
columnNameName of the columnE.g. 'id'
remarksComment to set on the columnE.g. 'A String'
schemaNameName of the schemaE.g. 'public'
tableNameName of the tableE.g. 'person'
<changeSet author="liquibase-docs" id="setColumnRemarks-example">
    <setColumnRemarks catalogName="cat"
            columnName="id"
            remarks="A String"
            schemaName="public"
            tableName="person"/>
</changeSet>
changeSet:
  id: setColumnRemarks-example
  author: liquibase-docs
  changes:
  - setColumnRemarks:
      catalogName: cat
      columnName: id
      remarks: A String
      schemaName: public
      tableName: person
{
  "changeSet": {
    "id": "setColumnRemarks-example",
    "author": "liquibase-docs",
    "changes": [
      {
        "setColumnRemarks": {
          "catalogName": "cat",
          "columnName": "id",
          "remarks": "A String",
          "schemaName": "public",
          "tableName": "person"
        }
      }]
    
  }
}

SQL Generated From Above Sample (MySQL)

ALTER TABLE cat.person COMMENT = 'A String';

Database Support

DatabaseNotesAuto Rollback
DB2/LUWSupportedNo
DB2/zSupportedNo
DerbyNot SupportedNo
FirebirdNot SupportedNo
H2SupportedNo
HyperSQLNot SupportedNo
INGRESNot SupportedNo
InformixNot SupportedNo
MariaDBSupportedNo
MySQLSupportedNo
OracleSupportedNo
PostgreSQLSupportedNo
SQL ServerSupportedNo
SQLiteNot SupportedNo
SybaseNot SupportedNo
Sybase AnywhereSupportedNo