Describes the properties of a snapshot.
DESCRIBE can be abbreviated to DESC.
CREATE SNAPSHOT , ALTER SNAPSHOT, DROP SNAPSHOT, SHOW SNAPSHOTS
{ DESC | DESCRIBE } SNAPSHOT <name>
Copy
Parameters¶name
Specifies the identifier for the snapshot 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 Identifier requirements.
The output of the command includes the following columns, which describe the properties and metadata of the object:
Column
Description
name
Name of the snapshot.
state
One of the following values, which indicates the current status of the snapshot:
INITIALIZED: The snapshot creation is in progress.
CREATED: The snapshot is created and can be used to create a volume.
ERROR: Snapshot creation failed.
database_name
Database in which the snapshot is created.
schema_name
Schema in which the snapshot is created.
service_name
Fully qualified service name from which the snapshot is created.
volume_name
Volume from the specified service instance for which the snapshot is created.
instance
ID of the service instance.
size
Size (in GB) of the snapshot.
comment
General comment about the snapshot.
owner
Role that owns the snapshot.
owner_role_type
The type of role that owns the object, either ROLE or DATABASE_ROLE.
created_on
Date and time when the snapshot was created.
encryption
Encryption type configured for the volume, from which the snapshot was created. Possible values include SNOWFLAKE_SSE and SNOWFLAKE_FULL.
A role used to execute this operation must have the following privileges at a minimum:
Privilege
Object
Notes
OWNERSHIP or USAGE
Snapshot
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 Creating custom roles.
For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.
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.
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.
The following example describes the snapshot named my_snapshot:
DESC SNAPSHOT my_snapshot;
Copy
Output:
+-------------+---------+---------------+-------------+----------------------------------------------------+-------------+----------+------+--------------+-----------+-----------------+-------------------------------+-------------------------------+---------------+ | name | state | database_name | schema_name | service_name | volume_name | instance | size | comment | owner | owner_role_type | created_on | updated_on | encryption | |-------------+---------+---------------+-------------+----------------------------------------------------+-------------+----------+------+--------------+-----------+-----------------+-------------------------------+-------------------------------+---------------| | MY_SNAPSHOT | CREATED | TUTORIAL_DB | DATA_SCHEMA | TUTORIAL_DB.DATA_SCHEMA.MY_SERVICE_WITH_EBS_VOLUME | block-vol1 | 0 | 10 | new snapshot | TEST_ROLE | ROLE | 2024-05-09 21:36:58.502 -0700 | 2024-05-09 21:38:03.424 -0700 | SNOWFLAKE_SSE | +-------------+---------+---------------+-------------+----------------------------------------------------+-------------+----------+------+--------------+-----------+-----------------+-------------------------------+-------------------------------+---------------+
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4