Secure 5.2.1: alterSchemaTags

alterSchemaTags

Last updated: August 12, 2026

Sets or unsets tags on a Snowflake schema.

Note: This change type does not support automatic rollback or database inspection features (snapshot, diff, diff-changelog, and generate-changelog commands). Tags must be created before they can be applied to objects.

Available attributes

Attribute	Type	Description	Required
`catalogName`	String	Name of the database containing the schema	No
`targetSchemaName`	String	Name of the schema to alter	Yes
`ifExists`	Boolean	Don't error if schema doesn't exist	No
`setTags`	Map	Key-value pairs of tags to set on the schema*	No
`unsetTags`	List	List of tag names to remove from the schema*	No

* Exactly one of setTags or unsetTags must be specified. Tags must exist before use.

unsetTag attributes

Attribute	Type	Description	Required
`tagName`	String	Name of tag to remove	Yes

<?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 tags -->
    <changeSet id="set-schema-tags" author="examples">
        <pro-snowflake:alterSchemaTags targetSchemaName="ANALYTICS">
            <pro-snowflake:setTags>
                <pro-snowflake:entry key="environment" value="production"/>
                <pro-snowflake:entry key="department" value="engineering"/>
            </pro-snowflake:setTags>
        </pro-snowflake:alterSchemaTags>
    </changeSet>

    <!-- Set tags with IF EXISTS -->
    <changeSet id="set-schema-tags-if-exists" author="examples">
        <pro-snowflake:alterSchemaTags
                targetSchemaName="STAGING"
                ifExists="true">
            <pro-snowflake:setTags>
                <pro-snowflake:entry key="compliance" value="gdpr"/>
            </pro-snowflake:setTags>
        </pro-snowflake:alterSchemaTags>
    </changeSet>

    <!-- Unset tags -->
    <changeSet id="unset-schema-tags" author="examples">
        <pro-snowflake:alterSchemaTags targetSchemaName="ANALYTICS">
            <pro-snowflake:unsetTags>
                <pro-snowflake:unsetTag tagName="environment"/>
                <pro-snowflake:unsetTag tagName="department"/>
            </pro-snowflake:unsetTags>
        </pro-snowflake:alterSchemaTags>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "set-schema-tags",
        "author": "examples",
        "changes": [
          {
            "alterSchemaTags": {
              "targetSchemaName": "ANALYTICS",
              "setTags": {
                "entries": [
                  { "entry": { "key": "environment", "value": "production" } },
                  { "entry": { "key": "department", "value": "engineering" } }
                ]
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "set-schema-tags-if-exists",
        "author": "examples",
        "changes": [
          {
            "alterSchemaTags": {
              "targetSchemaName": "STAGING",
              "ifExists": true,
              "setTags": {
                "entries": [
                  { "entry": { "key": "compliance", "value": "gdpr" } }
                ]
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "unset-schema-tags",
        "author": "examples",
        "changes": [
          {
            "alterSchemaTags": {
              "targetSchemaName": "ANALYTICS",
              "unsetTags": [
                { "unsetTag": { "tagName": "environment" } },
                { "unsetTag": { "tagName": "department" } }
              ]
            }
          }
        ]
      }
    }
  ]
}

databaseChangeLog:
  # Set tags
  - changeSet:
      id: set-schema-tags
      author: examples
      changes:
        - alterSchemaTags:
            targetSchemaName: ANALYTICS
            setTags:
              entries:
                - entry:
                    key: environment
                    value: production
                - entry:
                    key: department
                    value: engineering

  # Set tags with IF EXISTS
  - changeSet:
      id: set-schema-tags-if-exists
      author: examples
      changes:
        - alterSchemaTags:
            targetSchemaName: STAGING
            ifExists: true
            setTags:
              entries:
                - entry:
                    key: compliance
                    value: gdpr

  # Unset tags
  - changeSet:
      id: unset-schema-tags
      author: examples
      changes:
        - alterSchemaTags:
            targetSchemaName: ANALYTICS
            unsetTags:
              - unsetTag:
                  tagName: environment
              - unsetTag:
                  tagName: department

--liquibase formatted sql

--changeset examples:set-tags
-- Set tags
ALTER SCHEMA ANALYTICS SET TAG environment = 'production', department = 'engineering';

--changeset examples:set-tags-with-if-exists
-- Set tags with IF EXISTS
ALTER SCHEMA IF EXISTS STAGING SET TAG compliance = 'gdpr';

--changeset examples:unset-tags
-- Unset tags
ALTER SCHEMA ANALYTICS UNSET TAG environment, department;

<?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 tags -->
    <changeSet id="set-schema-tags" author="examples">
        <pro-snowflake:alterSchemaTags targetSchemaName="ANALYTICS">
            <pro-snowflake:setTags>
                <pro-snowflake:entry key="environment" value="production"/>
                <pro-snowflake:entry key="department" value="engineering"/>
            </pro-snowflake:setTags>
        </pro-snowflake:alterSchemaTags>
    </changeSet>

    <!-- Set tags with IF EXISTS -->
    <changeSet id="set-schema-tags-if-exists" author="examples">
        <pro-snowflake:alterSchemaTags
                targetSchemaName="STAGING"
                ifExists="true">
            <pro-snowflake:setTags>
                <pro-snowflake:entry key="compliance" value="gdpr"/>
            </pro-snowflake:setTags>
        </pro-snowflake:alterSchemaTags>
    </changeSet>

    <!-- Unset tags -->
    <changeSet id="unset-schema-tags" author="examples">
        <pro-snowflake:alterSchemaTags targetSchemaName="ANALYTICS">
            <pro-snowflake:unsetTags>
                <pro-snowflake:unsetTag tagName="environment"/>
                <pro-snowflake:unsetTag tagName="department"/>
            </pro-snowflake:unsetTags>
        </pro-snowflake:alterSchemaTags>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "set-schema-tags",
        "author": "examples",
        "changes": [
          {
            "alterSchemaTags": {
              "targetSchemaName": "ANALYTICS",
              "setTags": {
                "entries": [
                  { "entry": { "key": "environment", "value": "production" } },
                  { "entry": { "key": "department", "value": "engineering" } }
                ]
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "set-schema-tags-if-exists",
        "author": "examples",
        "changes": [
          {
            "alterSchemaTags": {
              "targetSchemaName": "STAGING",
              "ifExists": true,
              "setTags": {
                "entries": [
                  { "entry": { "key": "compliance", "value": "gdpr" } }
                ]
              }
            }
          }
        ]
      }
    },
    {
      "changeSet": {
        "id": "unset-schema-tags",
        "author": "examples",
        "changes": [
          {
            "alterSchemaTags": {
              "targetSchemaName": "ANALYTICS",
              "unsetTags": [
                { "unsetTag": { "tagName": "environment" } },
                { "unsetTag": { "tagName": "department" } }
              ]
            }
          }
        ]
      }
    }
  ]
}

databaseChangeLog:
  # Set tags
  - changeSet:
      id: set-schema-tags
      author: examples
      changes:
        - alterSchemaTags:
            targetSchemaName: ANALYTICS
            setTags:
              entries:
                - entry:
                    key: environment
                    value: production
                - entry:
                    key: department
                    value: engineering

  # Set tags with IF EXISTS
  - changeSet:
      id: set-schema-tags-if-exists
      author: examples
      changes:
        - alterSchemaTags:
            targetSchemaName: STAGING
            ifExists: true
            setTags:
              entries:
                - entry:
                    key: compliance
                    value: gdpr

  # Unset tags
  - changeSet:
      id: unset-schema-tags
      author: examples
      changes:
        - alterSchemaTags:
            targetSchemaName: ANALYTICS
            unsetTags:
              - unsetTag:
                  tagName: environment
              - unsetTag:
                  tagName: department

--liquibase formatted sql

--changeset examples:set-tags
-- Set tags
ALTER SCHEMA ANALYTICS SET TAG environment = 'production', department = 'engineering';

--changeset examples:set-tags-with-if-exists
-- Set tags with IF EXISTS
ALTER SCHEMA IF EXISTS STAGING SET TAG compliance = 'gdpr';

--changeset examples:unset-tags
-- Unset tags
ALTER SCHEMA ANALYTICS UNSET TAG environment, department;

alterSchemaTags

Available attributes

unsetTag attributes

XML example

JSON example

YAML example

SQL example

More like this