DESCRIBE APPLICATION

Displays information about an application object.

DESCRIBE can be abbreviated to DESC.

See also:

ALTER APPLICATION PACKAGE, CREATE APPLICATION PACKAGE, DROP APPLICATION PACKAGE, SHOW APPLICATION PACKAGES,

Syntax

DESC[RIBE] APPLICATION <name>
Copy

Parameters

name

Specifies the identifier of the application object to describe.

Output

The command displays properties of an application object in the following columns:

Column

Description

property

The name of the property of the application object. This column can include the properties listed in the following table.

value

The value assigned to the property of the application object.

The property column can include the following properties of an application object:

Property

Description

name

The name of the application object.

source_organization

The name of the organization of the account containing the application package used to create the application object.

source_account

The account of the application package used to create the application object.

source_type

The source used to create the application. Valid values are APP_PACKAGE and LISTING.

source

The name of the application package or listing used to create the application object.

version

The version identifier of the application object.

version_label

The version label of the application object. This label is visible to consumer when they install a Snowflake Native App.

patch

The patch number of the application object.

created_on

The timestamp when the application object was created.

last_upgraded_on

The timestamp of the last upgrade of the application object.

share_events_with_provider

Indicates whether logging and event sharing is enabled for the application object.

log_level

The log level set for the application object.

trace_level

The trace level set for the application object.

debug_mode

Indicates whether the application was created using debug mode.

upgrade_state

The current state of the background installation or upgrade of the application object. Valid values are:

  • INSTALLING: The application object is in the process of being created.

  • INSTALL_FAILED: The creation of the application object failed. The application object remains in the INSTALL_FAILED state until it is dropped. The reason for the failure is listed in the UPGRADE_FAILURE_REASON column, if present.

  • COMPLETE: The setup script successfully completed and the application object was created or upgraded.

  • QUEUED: The application object is queued for upgrade.

  • UPGRADING: The application object is in the process of being upgraded.

  • FAILED: All upgrade attempts failed. The reason for the failure is listed in the UPGRADE_FAILURE_REASON column, if present. The instance remains in the FAILED state until a release directive is updated to point to a different version than the one that the upgrade was targeting, as defined in the TARGET_UPGRADE_VERSION column.

  • QUEUED_RETRY: The instance failed one or more upgrade attempts. The reason for the failure is indicated in UPGRADE_FAILURE_REASON: The instance is queued to perform another upgrade attempt.

  • DISABLED: The application object and its upgrades were disabled. In this state the instance will be inaccessible for consumers, it will not be considered for upgrades and will not block application package version drop. The reason for the failure is listed in the UPGRADE_FAILURE_REASON column, if present.

upgrade_target_version

The version identifier to which the application object is being upgraded.

upgrade_target_patch

The patch to which the application object is being upgraded.

upgrade_attempt

Indicates whether an upgrade was attempted for the application object.

upgrade_task_id

The internal task identifier for the upgrade attempt.

upgrade_started_on

The timestamp when the upgrade was initiated.

upgrade_attempted_on

The timestamp when the application object was last upgraded.

upgrade_failure_reason

The reason the upgrade failed, if applicable.

previous_version

The identifier of the previous version of the application object.

previous_patch

The number of the previous patch of the installed application object.

previous_version_state

The state of the previous version of the application object.

upgrade_failure_type

The reason for an upgrade failure. Possible values are:

  • VERSION_SETUP: indicates that an error occurred when running the setup script for the app. This can occur if the setup script contains a syntax error, is empty, etc. When this error occurs, an email notification is sent to the provider.

  • INTERNAL: indicates an internal Snowflake error, for example, if a required object does not respond or cannot be found.

Usage notes

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Examples

Describe the properties of an application object:

DESC APPLICATION hello_snowflake_app;
Copy
+----------------------------+-------------------------------+
| property                   | value                         |
|----------------------------+-------------------------------|
| name                       | hello_snowflake_app           |
| source_organization        | my_organization               |
| source_account             | provider_account              |
| source_type                | APPLICATION PACKAGE           |
| source                     | hello_snowflake_package       |
| version                    | v1_0                          |
| version_label              | NULL                          |
| patch                      | 0                             |
| created_on                 | 2023-05-25 08:30:41.520 -0700 |
| last_upgraded_on           |                               |
| share_events_with_provider | FALSE                         |
| log_level                  | OFF                           |
| trace_level                | OFF                           |
| debug_mode                 | FALSE                         |
| upgrade_state              | COMPLETE                      |
| upgrade_target_version     | NULL                          |
| upgrade_target_patch       | 0                             |
| upgrade_attempt            | NULL                          |
| upgrade_task_id            | NULL                          |
| upgrade_started_on         |                               |
| upgrade_attempted_on       |                               |
| upgrade_failure_reason     | NULL                          |
| previous_version           | NULL                          |
| previous_patch             | 0                             |
| previous_version_state     | COMPLETE                      |
| upgrade_failure_type       | NULL                          |
+----------------------------+-------------------------------+