DESCRIBE CONFIGURATION

Describes the properties of a configuration.

DESCRIBE can be abbreviated to DESC.

See also:

SHOW CONFIGURATIONS

Syntax

{ DESC | DESCRIBE } CONFIGURATION <configuration_name> [ IN APPLICATION <app> ]
Copy

Parameters

configuration_name

Specifies the identifier for the configuration to describe.

app

The name of the app to describe the configuration for.

If an app runs this command, the parameter is optional and ignored. Listing configurations for another app from within an app is not supported.

If this command is run directly using a workspace or the Snowflake CLI, the app parameter is required.

Output

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

Column

Description

property

The name of the configuration.

value

The timestamp when the configuration object was created.

Usage notes

  • When an app runs this command, it can always describe all the configurations that it has.

  • When this command is run outside of an app, a configuration will only be returned if the consumer role is granted an application role that has access to the configuration. However, if the consumer role has the MONITOR or OWNERSHIP privilege on the app, the consumer can see all the configurations in that app, regardless of which application roles they have been granted.

Language: English