DESCRIBE STORAGE LIFECYCLE POLICY

Describes the properties of a storage lifecycle policy.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE STORAGE LIFECYCLE POLICY , ALTER STORAGE LIFECYCLE POLICY , DROP STORAGE LIFECYCLE POLICY , SHOW STORAGE LIFECYCLE POLICIES

Syntax

{ DESC | DESCRIBE } STORAGE LIFECYCLE POLICY <policy_name>
Copy

Parameters

name

Specifies the identifier for the policy to describe.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Exigences relatives à l’identificateur.

Output

The output of the command includes the following columns, which describe the properties and metadata of the object:

Column

Description

name

The name of the policy.

signature

The columns the policy uses to evaluate rows for expiration.

return_type

A VARCHAR value that contains the data type of the return value. For example BOOLEAN, NUMBER, ARRAY, and OBJECT.

body

The function body that evaluates whether a row should be expired.

archive_tier

The archive storage tier; COOL or COLD.

archive_for_days

The (optional) number of days to archive table rows before expiration. If this property isn’t set, the value is NULL.

Access control requirements

A role used to execute this SQL command must have at least one of the following privileges at a minimum:

Privilege

Object

Notes

APPLY STORAGE LIFECYCLE POLICY

Account

Allows DESC on all storage lifecycle policies in the account.

APPLY

Storage lifecycle policy

Allows DESC on the storage lifecycle policy.

OWNERSHIP

Storage lifecycle policy

OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema.

For instructions on creating a custom role with a specified set of privileges, see Création de rôles personnalisés.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Aperçu du contrôle d’accès.

Usage notes

  • If you’ve ever enabled archive storage for a policy, the archive_tier property in the command output shows the archive tier (COOL or COLD) that was set. This is true even if you transition the archival policy into an expiration policy by using ALTER STORAGE LIFECYCLE POLICY to unset the ARCHIVE_FOR_DAYS parameter. You can’t change the archive tier after setting it.

  • To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

    The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is type, then specify "type" for the identifier.

Examples

The following example describes the storage lifecycle policy named my_storage_lifecycle_policy:

DESCRIBE STORAGE LIFECYCLE POLICY example_slp;
Copy

Output:

+-----------------------------+----------------+-------------+------+------------------+
| name                        | signature      | return_type | body | archive_for_days |
|-----------------------------+----------------+-------------+------+------------------|
| MY_STORAGE_LIFECYCLE_POLICY | (ARG1 BOOLEAN) | BOOLEAN     | arg1 |              365 |
+-----------------------------+----------------+-------------+------+------------------+
Langage: Français