SYSTEM$GET_TAG¶

Syntax¶

SYSTEM$GET_TAG( '<tag_name>' , '<obj_name>' , '<obj_domain>' )

Arguments¶

'tag_name'

The name of the tag as a string.

The name is the key in the key-value pair of the tag. For example, in the tag cost_center = 'sales', cost_center is the key-name of the tag. For this argument, use 'cost_center'.

'obj_name'

The name of the object as a string.

For example, if a table name is my_table, use 'my_table' as the name of the object.

To specify a column, use the format <table_name>.<column_name>. For example, my_table.revenue.

For more information, see Object Identifiers.

'obj_domain'

The domain of the object (e.g. TABLE, WAREHOUSE) as a string. If a tag is assigned to a table or view column, the domain is COLUMN.

Use one of the following values:

ACCOUNT | INTEGRATION | ROLE | SHARE | USER | WAREHOUSE | DATABASE | SCHEMA | PROCEDURE | STAGE | STREAM | TABLE | TASK | COLUMN

Note that the domain value of TABLE should be used for all table-like objects such as views, materialized views, and external tables.

Usage Notes¶

• Using this function requires:

  • The privileges to run a DESCRIBE <object> operation on the specified object name.

  • USAGE on the database and schema in which the tag exists.

    For more information, see Tag Privilege & DDL Summary.

Examples¶

Returns NULL if a tag is not associated to the specified object:

select system$get_tag('cost_center', 'my_table', 'table');

+-----------------------------------------------------+
| SYSTEM$GET_TAG('COST_CENTER', 'MY_TABLE', 'TABLE')  |
+-----------------------------------------------------+
| NULL                                                |
+-----------------------------------------------------+

Copy

Returns the tag value for the specified table. The tag value is the string component of the key = 'value' pair in the tag:

select system$get_tag('cost_center', 'my_table', 'table');

-----------------------------------------------------+
| SYSTEM$GET_TAG('COST_CENTER', 'MY_TABLE', 'TABLE') |
+----------------------------------------------------+
| sales                                              |
+----------------------------------------------------+

Copy

Returns the tag value for the specified column:

select system$get_tag('fiscal_quarter', 'my_table.revenue', 'column');

+----------------------------------------------------------------+
| SYSTEM$GET_TAG('FISCAL_QUARTER', 'MY_TABLE.REVENUE', 'COLUMN') |
+----------------------------------------------------------------+
| Q1                                                             |
+----------------------------------------------------------------+

Copy