alterDynamicTable alterDataRetention

Modifies data retention settings for Time Travel 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

alterDataRetention nested attributes

Attribute

Type

Description

Required

newDataRetentionTimeInDays

Integer

New Time Travel retention period (0-90 days)

No*

unsetDataRetentionTimeInDays

Boolean

If true, unsets the data retention time

No*

newMaxDataExtensionTimeInDays

Integer

New maximum extension period

No

unsetMaxDataExtensionTimeInDays

Boolean

If true, unsets the max extension time

No

*Specify either set or unset for each property.

<?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 data retention -->
  <changeSet id="set-data-retention" author="examples">
    <pro-snowflake:alterDynamicTable tableName="HISTORICAL_SUMMARY">
      <pro-snowflake:alterDataRetention
                newDataRetentionTimeInDays="90"
                newMaxDataExtensionTimeInDays="14"/>
    </pro-snowflake:alterDynamicTable>
  </changeSet>
  <!-- Unset data retention -->
  <changeSet id="unset-data-retention" author="examples">
    <pro-snowflake:alterDynamicTable tableName="HISTORICAL_SUMMARY">
      <pro-snowflake:alterDataRetention unsetDataRetentionTimeInDays="true"/>
    </pro-snowflake:alterDynamicTable>
  </changeSet>
</databaseChangeLog>