DESCRIBE BACKUP SET

Describes a specific backup set.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE BACKUP SET, ALTER BACKUP SET, DROP BACKUP SET, SHOW BACKUP SETS

Syntax

DESC[RIBE] BACKUP SET <name>

Parameters

name

Specifies the identifier for the backup 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 backup set was created.
nameName of the backup set.
database_nameName of the database that contains the backup set.
schema_nameName of the schema that contains the backup set.
object_kindType of the object that the backup set is backing up.
object_nameName of the object that the backup set is backing up.
object_database_nameName of the database that contains the object being backed up by this backup set.
object_schema_nameName of the schema that contains the object being backed up by this backup set.
backup_policy_nameName of the backup policy attached to this backup set.
backup_policy_database_nameName of the database that contains the backup policy.
backup_policy_schema_nameName of the schema that contains the backup policy.
backup_policy_stateCurrent state of the backup policy.
owner_roleName of the role with the OWNERSHIP privilege on the backup set.
owner_role_typeType of role with the OWNERSHIP privilege on the backup set.
commentComment for backup set.

Examples

Describe a backup set:

DESC BACKUP SET my_backup_set;