DESCRIBE SNAPSHOT SET

Describes a specific snapshot set.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE SNAPSHOT SET — Deprecated, ALTER SNAPSHOT SET — Deprecated, DROP SNAPSHOT SET — Deprecated, SHOW SNAPSHOT SETS — Deprecated

Syntax

DESC[RIBE] SNAPSHOT SET <name>

Parameters

name

Specifies the identifier for the snapshot set 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.

Usage notes

  • 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.

    For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

    When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

    You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

Output

ColumnDescription
created_onTimestamp that the snapshot set was created.
nameName of the snapshot set.
database_nameName of the database that contains the snapshot set.
schema_nameName of the schema that contains the snapshot set.
object_kindType of the object that the snapshot set is snapshotting.
object_nameName of the object that the snapshot set is snapshotting.
object_database_nameName of the database that contains the object being snapshotted by this snapshot set.
object_schema_nameName of the schema that contains the object being snapshotted by this snapshot set.
snapshot_policy_nameName of the snapshot policy attached to this snapshot set.
snapshot_policy_database_nameName of the database that contains the snapshot policy.
snapshot_policy_schema_nameName of the schema that contains the snapshot policy.
snapshot_policy_stateCurrent state of the snapshot policy.
owner_roleName of the role with the OWNERSHIP privilege on the snapshot set.
owner_role_typeType of role with the OWNERSHIP privilege on the snapshot set.
commentComment for backup set.

Examples

Describe a snapshot set:

DESC SNAPSHOT SET my_snapshot_set;