ALTER SEMANTIC VIEW

Modifies the comment for an existing semantic view.

Note

You can’t use the ALTER SEMANTIC VIEW command to change properties other than the comment. To change other properties of the semantic view, replace the semantic view. See Replacing an existing semantic view.

See also:

CREATE SEMANTIC VIEW , DESCRIBE SEMANTIC VIEW , DROP SEMANTIC VIEW , SHOW SEMANTIC VIEWS , SHOW SEMANTIC DIMENSIONS , SHOW SEMANTIC METRICS , SHOW SEMANTIC DIMENSIONS FOR METRIC

Syntax

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

ALTER SEMANTIC VIEW [ IF EXISTS ] <name> UNSET
  COMMENT
Copy

Parameters

name

Specifies the identifier for the semantic view 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 semantic view:

COMMENT = 'string_literal'

Adds a comment or overwrites an existing comment for the semantic view.

UNSET ...

Unsets one or more specified properties or parameters for the semantic view, which resets the properties to their defaults:

  • COMMENT

To unset multiple properties or parameters with a single ALTER statement, separate each property or parameter with a comma.

When unsetting a property or parameter, specify only the property or parameter name (unless the syntax above indicates that you should specify the value). Specifying the value returns an error.

Access control requirements

A role used to execute this operation must have the following privileges at a minimum:

Privilege

Object

Notes

OWNERSHIP

Semantic view

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

  • 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 the comment for a semantic view:

ALTER SEMANTIC VIEW my_semantic_view SET COMMENT = 'my comment';
Copy

The following example unsets the existing comment for a semantic view:

ALTER SEMANTIC VIEW my_semantic_view UNSET COMMENT;
Copy
Language: English