setColumnRemarks

Set remarks on a column

Available attributes

Name Description Required for Supports Since
catalogName Name of the catalog asany, db2, db2z, h2, mariadb, mysql, oracle, postgresql 3.0
columnName Name of the column all all
remarks Comment to set on the column all all
schemaName Name of the schema all
tableName Name of the table all all

XML example

<changeSet  author="liquibase-docs"  id="setColumnRemarks-example">  
    <setColumnRemarks  catalogName="cat"  
            columnName="id"  
            remarks="A String"  
            schemaName="public"  
            tableName="person"/>  
</changeSet>

YAML example

changeSet:  
  id:  setColumnRemarks-example  
  author:  liquibase-docs  
  changes:  
  -  setColumnRemarks:  
      catalogName:  cat  
      columnName:  id  
      remarks:  A String  
      schemaName:  public  
      tableName:  person

JSON example

{  "changeSet":  {  "id":  "setColumnRemarks-example",  "author":  "liquibase-docs",  "changes":  [  {  "setColumnRemarks":  {  "catalogName":  "cat",  "columnName":  "id",  "remarks":  "A String",  "schemaName":  "public",  "tableName":  "person"  }  }]  }  }

SQL example

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

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
SQL Server Supported No
SQLite Not Supported No
Sybase Not Supported No
Sybase Anywhere Supported No