alterDynamicTable alterComment

Modifies or removes the comment on a dynamic table.

Known limitations:

  • This change type does not support automatic rollback.

  • Snowflake snapshots created with Liquibase Secure 5.1 are incompatible with earlier versions due to enhanced object type detection for TABLES and VIEWS. Regenerate all snapshots with 5.1 after upgrading to avoid false differences in diff and diff-changelog operations.

Available attributes

Attribute

Type

Description

Required

catalogName

String

Name of the catalog (database) containing the table

No

schemaName

String

Name of the schema containing the table

No

tableName

String

Name of the dynamic table to alter

Yes

ifExists

Boolean

Only execute if the table exists

No

alterComment nested attributes

Attribute

Type

Description

Required

newComment

String

New comment text

No*

unsetComment

Boolean

If true, removes the comment

No*

*Exactly one of newComment or unsetComment must be specified.

<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
  xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
  xmlns:pro-snowflake="http://www.liquibase.org/xml/ns/pro-snowflake"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        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/pro-snowflake
        http://www.liquibase.org/xml/ns/pro-snowflake/liquibase-pro-snowflake-latest.xsd">
  <!-- Set comment -->
  <changeSet id="set-comment" author="examples">
    <pro-snowflake:alterDynamicTable tableName="SALES_SUMMARY">
      <pro-snowflake:alterComment newComment="Updated sales summary with hourly refresh"/>
    </pro-snowflake:alterDynamicTable>
  </changeSet>
  <!-- Unset comment -->
  <changeSet id="unset-comment" author="examples">
    <pro-snowflake:alterDynamicTable tableName="SALES_SUMMARY">
      <pro-snowflake:alterComment unsetComment="true"/>
    </pro-snowflake:alterDynamicTable>
  </changeSet>
</databaseChangeLog>