Reference
Version · 6.0
Change Automation Reference

alterSequenceComment

Last updated: September 29, 2026

Sets or removes the comment on an existing sequence in Snowflake.

Note: This change type does not support automatic rollback.

Available attributes

Attribute	Type	Description	Required
`catalogName`	String	Name of the catalog (database) containing the sequence	No
`schemaName`	String	Name of the schema containing the sequence	No
`sequenceName`	String	Name of the sequence to alter	Yes
`ifExists`	Boolean	Don't error if the sequence doesn't exist	No
`newComment`	String	New comment text to set*	No
`unsetComment`	Boolean	Remove the existing comment*	No

* Exactly one of newComment or unsetComment must be specified.

Snapshot and diff support

As of Liquibase Secure 6.0, snapshot records the comment on a Snowflake sequence and diff reports a difference when two sequences have different comments. diff-changelog generates a pro-snowflake:alterSequenceComment changeset to correct the difference.

When the sequence in the reference database has no comment, the generated changeset sets unsetComment to true rather than setting an empty comment, because Snowflake treats the two differently.

Note: Snapshots taken before Liquibase Secure 6.0 do not record sequence comments. Regenerate any stored snapshots of Snowflake databases that contain sequences.

<?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-sequence-comment" author="examples">
        <pro-snowflake:alterSequenceComment
                sequenceName="ORDER_ID_SEQ"
                newComment="Generates unique order IDs"/>
    </changeSet>

    <!-- Set comment with IF EXISTS -->
    <changeSet id="set-comment-if-exists" author="examples">
        <pro-snowflake:alterSequenceComment
                sequenceName="INVOICE_SEQ"
                ifExists="true"
                newComment="Invoice number generator - updated"/>
    </changeSet>

    <!-- Unset comment -->
    <changeSet id="unset-sequence-comment" author="examples">
        <pro-snowflake:alterSequenceComment
                sequenceName="TEMP_SEQ"
                unsetComment="true"/>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "set-sequence-comment",
        "author": "examples",
        "changes": [
          {
            "alterSequenceComment": {
              "sequenceName": "ORDER_ID_SEQ",
              "newComment": "Generates unique order IDs"
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "set-comment-if-exists",
        "author": "examples",
        "changes": [
          {
            "alterSequenceComment": {
              "sequenceName": "INVOICE_SEQ",
              "ifExists": true,
              "newComment": "Invoice number generator - updated"
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "unset-sequence-comment",
        "author": "examples",
        "changes": [
          {
            "alterSequenceComment": {
              "sequenceName": "TEMP_SEQ",
              "unsetComment": true
            }
          }
        ]
      }
    }
  ]
}

databaseChangeLog:
  # Set comment
  - changeSet:
      id: set-sequence-comment
      author: examples
      changes:
        - alterSequenceComment:
            sequenceName: ORDER_ID_SEQ
            newComment: Generates unique order IDs

  # Set comment with IF EXISTS
  - changeSet:
      id: set-comment-if-exists
      author: examples
      changes:
        - alterSequenceComment:
            sequenceName: INVOICE_SEQ
            ifExists: true
            newComment: Invoice number generator - updated

  # Unset comment
  - changeSet:
      id: unset-sequence-comment
      author: examples
      changes:
        - alterSequenceComment:
            sequenceName: TEMP_SEQ
            unsetComment: true

--liquibase formatted sql

--changeset examples:set-comment
-- Set comment
ALTER SEQUENCE PUBLIC.ORDER_ID_SEQ SET COMMENT = 'Generates unique order IDs';

--changeset examples:set-comment-with-if-exists
-- Set comment with IF EXISTS
ALTER SEQUENCE IF EXISTS PUBLIC.INVOICE_SEQ SET COMMENT = 'Invoice number generator - updated';

--changeset examples:unset-comment
-- Unset comment
ALTER SEQUENCE PUBLIC.TEMP_SEQ UNSET COMMENT;

<?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-sequence-comment" author="examples">
        <pro-snowflake:alterSequenceComment
                sequenceName="ORDER_ID_SEQ"
                newComment="Generates unique order IDs"/>
    </changeSet>

    <!-- Set comment with IF EXISTS -->
    <changeSet id="set-comment-if-exists" author="examples">
        <pro-snowflake:alterSequenceComment
                sequenceName="INVOICE_SEQ"
                ifExists="true"
                newComment="Invoice number generator - updated"/>
    </changeSet>

    <!-- Unset comment -->
    <changeSet id="unset-sequence-comment" author="examples">
        <pro-snowflake:alterSequenceComment
                sequenceName="TEMP_SEQ"
                unsetComment="true"/>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "set-sequence-comment",
        "author": "examples",
        "changes": [
          {
            "alterSequenceComment": {
              "sequenceName": "ORDER_ID_SEQ",
              "newComment": "Generates unique order IDs"
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "set-comment-if-exists",
        "author": "examples",
        "changes": [
          {
            "alterSequenceComment": {
              "sequenceName": "INVOICE_SEQ",
              "ifExists": true,
              "newComment": "Invoice number generator - updated"
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "unset-sequence-comment",
        "author": "examples",
        "changes": [
          {
            "alterSequenceComment": {
              "sequenceName": "TEMP_SEQ",
              "unsetComment": true
            }
          }
        ]
      }
    }
  ]
}

databaseChangeLog:
  # Set comment
  - changeSet:
      id: set-sequence-comment
      author: examples
      changes:
        - alterSequenceComment:
            sequenceName: ORDER_ID_SEQ
            newComment: Generates unique order IDs

  # Set comment with IF EXISTS
  - changeSet:
      id: set-comment-if-exists
      author: examples
      changes:
        - alterSequenceComment:
            sequenceName: INVOICE_SEQ
            ifExists: true
            newComment: Invoice number generator - updated

  # Unset comment
  - changeSet:
      id: unset-sequence-comment
      author: examples
      changes:
        - alterSequenceComment:
            sequenceName: TEMP_SEQ
            unsetComment: true

--liquibase formatted sql

--changeset examples:set-comment
-- Set comment
ALTER SEQUENCE PUBLIC.ORDER_ID_SEQ SET COMMENT = 'Generates unique order IDs';

--changeset examples:set-comment-with-if-exists
-- Set comment with IF EXISTS
ALTER SEQUENCE IF EXISTS PUBLIC.INVOICE_SEQ SET COMMENT = 'Invoice number generator - updated';

--changeset examples:unset-comment
-- Unset comment
ALTER SEQUENCE PUBLIC.TEMP_SEQ UNSET COMMENT;

PreviouscreateSequence NextBteqExport

alterSequenceComment

Available attributes

Snapshot and diff support

XML

JSON

YAML

SQL

More like this