DESCRIBE INGRESS POLICY¶
Describes the properties of an ingress policy.
DESCRIBE can be abbreviated to DESC.
Syntax¶
Parameters¶
nameIdentifier for the ingress policy to describe. If the identifier contains spaces or special characters, enclose the entire string in double quotes. Identifiers enclosed in double quotes are case-sensitive.
For more information, see Identifier requirements.
Access control requirements¶
A role used to execute this SQL command must have at least one of the following privileges at a minimum:
| Privilege | Object | Notes |
|---|---|---|
| OWNERSHIP | Ingress policy | 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 no privilege on the policy cannot describe it. Snowflake reports that the policy does not exist.
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, specifySELECT "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¶
The command returns one row for each property:
| Property | Description |
|---|---|
CREATED_ON | Date and time when the ingress policy was created. |
NAME | Name of the ingress policy. |
OWNER | Role that owns the ingress policy. |
OWNER_ROLE_TYPE | Type of the owner role. |
COMMENT | Comment for the ingress policy. |
POLICY_DEFINITION | YAML body of the ingress policy. |
Examples¶
Describe an ingress policy: