DESCRIBE DATA MOVEMENT RULE¶

Describes the properties of a data movement rule, including the creation date, name, movement type, and the SQL expression that defines the maximum number of rows.

DESCRIBE can be abbreviated to DESC.

CREATE DATA MOVEMENT POLICY , ALTER DATA MOVEMENT POLICY , DROP DATA MOVEMENT POLICY

Syntax¶

{ DESC | DESCRIBE } DATA MOVEMENT RULE <name>

Parameters¶

name: Specifies the identifier for the data movement rule 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.

Output¶

The output of the command includes the following columns, which describe the properties and metadata of the object:

Column	Data type	Description
`created_on`	TIMESTAMP_LTZ	Date and time when the rule was created.
`name`	VARCHAR	Name of the rule.
`movement_type`	VARCHAR	Movement type the rule applies to.
`function_signature`	VARCHAR	Parameter signature for the rule function.
`function_body`	VARCHAR	SQL expression body of the rule.
`function_return_type`	VARCHAR	Return data type of the rule function.
`comment`	VARCHAR	Comment for the rule, if any.

Access control requirements¶

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

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

A role with any privilege on the data movement rule can also describe it.

Operating on an object in a schema requires at least one privilege on the parent database and at least one privilege on the parent 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.

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.

Examples¶

The following example describes the data movement rule named hr_snowsight_limit:

DESCRIBE DATA MOVEMENT RULE hr_snowsight_limit;