Liquibase® version 3.8.2 is now available! Get it for free.
2018 XML Announcement
News 5 Ways to Fix a Bad Database Change in Liquibase
04 Dec 2019

- and/or -

All Previous Posts >>

Change: ‘setTableRemarks’

Set remarks on a table

Available Attributes

NameDescriptionRequired ForSupportsSince
catalogNameName of the catalogall
remarksall
schemaNameName of the schemaall
tableNameName of the tableallall
<changeSet author="liquibase-docs" id="setTableRemarks-example">
    <setTableRemarks catalogName="cat"
            remarks="A String"
            schemaName="public"
            tableName="person"/>
</changeSet>
changeSet:
  id: setTableRemarks-example
  author: liquibase-docs
  changes:
  - setTableRemarks:
      catalogName: cat
      remarks: A String
      schemaName: public
      tableName: person
{
  "changeSet": {
    "id": "setTableRemarks-example",
    "author": "liquibase-docs",
    "changes": [
      {
        "setTableRemarks": {
          "catalogName": "cat",
          "remarks": "A String",
          "schemaName": "public",
          "tableName": "person"
        }
      }]
    
  }
}

SQL Generated From Above Sample (MySQL)

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

Database Support

DatabaseNotesAuto Rollback
DB2SupportedNo
DB2SupportedNo
DerbyNot SupportedNo
FirebirdNot SupportedNo
H2SupportedNo
HyperSQLNot SupportedNo
INGRESNot SupportedNo
InformixNot SupportedNo
MariaDBSupportedNo
MySQLSupportedNo
OracleSupportedNo
PostgreSQLSupportedNo
SQL ServerSupportedNo
SQLiteNot SupportedNo
SybaseNot SupportedNo
Sybase AnywhereSupportedNo