Skip to main content

Tag

You can provide configuration to Snowflake Object Lifecycle Engine for the following operations with tag:

  • Manage the lifecycle of new and existing tags
  • Manage the grants of tags

Using this configuration defines the tag as a Snowflake object for further use. It does not apply the tag to an object. For details on how to apply tags to objects within SOLE see SOLE Tags Management.

Usage

note

We have introduced SOLE for Data Products as a new framework for SOLE to help you quickly build an ecosystem of data products. Learn more about SOLE for Data Products, which is currently available as a private preview.

databases:
<database-name>:
schemas:
<schema-name>:
tags:
<tag-name>:
<configuration-key>: <value>

Supported parameters

The engine supports the parameters listed below.

Configuration KeyRequired/OptionalData Types and ValuesDescription
allowed_valuesOptionalList of StringList of allowed values for the tag
commentOptionalStringSpecifies a comment for the tag
deletedOptionalBoolean: True enables deletion prevention, False does nothingSpecifies what objects are allowed to be deleted
grantsOptionalMap: See Supported Tag Grants to RolesList of Privileges and Roles to which privileges are granted on the current tag
manage_modeOptionalString: all (default), none, grantsConfigures what properties to manage for the tag.
See Changing Manage Mode before changing the value.

Supported tag grants to roles

Following is the privilege you can grant to roles in the tag definition:

  • APPLY

Examples

databases:
PRODUCTS_RECORD:
schemas:
PRODUCTS:
tags:
PRODUCT:
comment: "PRODUCT Tag"
allowed_values: ["Red", "Yellow", "Blue"]
grants:
APPLY:
- READER
- WRITER
- ADMIN