ALTER SNAPSHOT¶

Modifies the properties of an existing snapshot.

See also:: CREATE SNAPSHOT , DESCRIBE SNAPSHOT, DROP SNAPSHOT, SHOW SNAPSHOTS

Syntax¶

ALTER SNAPSHOT [ IF EXISTS ] <name> SET COMMENT = '<string_literal>'

Copy

Parameters¶

name

Specifies the identifier for the snapshot to alter.

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.

SET ...

Sets one or more specified properties or parameters for the snapshot:

COMMENT = string-literal: Specifies a comment for the snapshot.

Access control requirements¶

Privilege	Object	Notes
OWNERSHIP	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).

Note that operating on any object in a schema also requires the USAGE privilege on the parent database and 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¶

Regarding metadata:

Attention

Customers should ensure that no personal data (other than for a User object), sensitive data, export-controlled data, or other regulated data is entered as metadata when using the Snowflake service. For more information, see Metadata Fields in Snowflake.

Examples¶

The following example sets a comment on the example_snapshot snapshot.

ALTER SNAPSHOT example_snapshot SET COMMENT = 'sample comment.';

Copy