setColumnRemarks

The setColumnRemarks Change Type sets remarks on a column.

Uses

You can typically use the setColumnRemarks Change Type when you want to alter the existing column by adding a comment to it.

Running the setColumnRemarks Change Type

To set a remark on your column, follow these steps:

Step 1: Add the setColumnRemarks Change Type to your changeset with the needed attributes as it is shown in the examples.

Step 2: Deploy your changeset by running the update command.

liquibase update

Now, you should see the column with a remark.

Available attributes

Name Description Required for Supports Since
catalogName

Name of the catalog

 asany, db2, db2z, h2, mariadb, mysql, oracle, postgresql 3.0
columnName The name of the column all all
remarks The comment to set on the column all all
schemaName

Name of the schema

 all
tableName The name of the table all all
columnDataType The data type of a value in the column mysql   4.3 (for XML) 
<changeSet author="liquibase-docs" id="setColumnRemarks-example">  
    <setColumnRemarks catalogName="department"  
            columnName="id"
            remarks="A String"
            schemaName="public"
            tableName="person"/>
  </changeSet>
changeSet: 
  id:  setColumnRemarks-example  
  author:  liquibase-docs 
  changes:  
  -  setColumnRemarks:
      catalogName:  department 
      columnName:  id  
      remarks:  A String  
      schemaName:  public  
      tableName:  person
{
  "changeSet":{
    "id":"setColumnRemarks-example",
    "author":"liquibase-docs",
    "changes":[
       {
         "setColumnRemarks":{
           "catalogName":"department",
           "columnName":"id",
           "remarks":"A String",
           "schemaName":"public",
           "tableName":"person"
         }
       }
     ]
   }
 }
COMMENT ON COLUMN dempartment.person IS 'A String';

Note: The SQL to set column remarks is platform-specific. You need to use the example depending on your database syntax.

Database support

Database Notes Auto Rollback
DB2/LUW Supported No
DB2/z Supported No
Derby Not Supported No
Firebird Not Supported No
H2 Supported No
HyperSQL Not Supported No
INGRES Not Supported No
Informix Not Supported No
MariaDB Supported No
MySQL Supported No
Oracle Supported No
PostgreSQL Supported No
Snowflake Supported No
SQL Server Supported No
SQLite Not Supported No
Sybase Not Supported No
Sybase Anywhere Supported No