setTableRemarks

Sets remarks on a table.

Available attributes

Name Description Required for Supports Since
catalogName

Name of the catalog

all 3.0
remarks

A short descriptive comment

all all
schemaName

Name of the schema

all
tableName

Name of the table

all all

Examples

<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
    xmlns:pro="http://www.liquibase.org/xml/ns/pro"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
        http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
        http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd">

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

</databaseChangeLog>
databaseChangeLog:
-  changeSet:
    id:  setTableRemarks-example
    author:  liquibase-docs
    changes:
    -  setTableRemarks:
        catalogName:  cat
        remarks:  A String
        schemaName:  public
        tableName:  person
{
    "databaseChangeLog": [
        {
            "changeSet": {
                "id": "setTableRemarks-example",
                "author": "liquibase-docs",
                "changes": [
                    {
                        "setTableRemarks": {
                            "catalogName": "cat",
                            "remarks": "A String",
                            "schemaName": "public",
                            "tableName": "person"
                        }
                    }
                ]
            }
        }
    ]
}
--liquibase formatted sql

--changeset liquibase-docs:setTableRemarks-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
Snowflake Supported No
SQL Server Supported No
SQLite Not Supported No
Sybase Not Supported No
Sybase Anywhere Supported No