DESCRIBE LISTING¶

Describes the columns in a listing.

DESCRIBE can be abbreviated to DESC.

See also:: CREATE LISTING, ALTER LISTING, SHOW LISTINGS, DROP LISTING, Listing manifest reference

Syntax¶

{ DESC | DESCRIBE } LISTING <name>  [ REVISION = { DRAFT | PUBLISHED } ]

Copy

Parameters¶

name

Specifies the identifier, specified when the listing was created, for the listing 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.

See SHOW LISTINGS for listing details, including listing name.

REVISION = { DRAFT | PUBLISHED }

Specifies which revision to display.

For example, If you have a draft of a published listing, you can specify either the draft or published version to display.

Valid values:

DRAFT: Describe the draft version of the listing.
PUBLISHED: Describe the published version of the listing.

Default:: PUBLISHED

Usage notes¶

To DESCRIBE a listing, you must be using a role that has one of USAGE, MODIFY, or OWNERSHIP privilege on the listing.

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.

Output¶

The command output provides listing properties and metadata in the following columns:

Column	Description
`global_name`	Global name of the listing
`name`	Name specified when the listing was created.
`owner`	The listing owner.
`owner_role_type`	The listing owner role type.
`created_on`	Date and time the listing was created.
`updated_on`	Date and time the listing was last updated.
`published_on`	Date and time the listing was last published.
`title`	Title specified in the listing manifest
`subtitle`	Sub title specified in the listing manifest
`description`	Listing description.
`target_accounts`	Comma separated list of target accounts.
`is_monetized`	Is monetized flag.
`is_application`	Is application flag. If `true` an application package is attached to the listing.
`is_targeted`	Is targeted flag.
`state`	State of the listing, one of: DRAFT PUBLISHED UNPUBLISHED
`revisions`	Revision state, for public listings only.
`comment`	Associated comment, if present.
`refresh_schedule`	The listing refresh frequency in minutes.
`refresh_type`	The listing refresh type.
`business_needs`	The business needs the listing satisfies.
`usage_examples`	The listing use case.
`listing_terms`	The listing terms.
`profile`	Provider profile name as specified in the listing manifest.
`customized_contact_info`	Provider contact information.
`application_package`	The application package associated with the listing.
`data_dictionary`	Listing metadata.
`regions`	The listing regions.
`manifest_yaml`	The entire published manifest when `REVISION` is `PUBLISHED`, and the entire published manifest with draft changes when `REVISION` is `DRAFT`.
`review_state`	The listing review state.
`rejection_reason`	The reason the listing was rejected.
`categories`	The listing categories.
`resources`	The listing resources.
`unpublished_by_admin_reasons`	The reason the listing owner didn’t publish the listing.

Examples¶

Describe the columns in the listing named MYLISTING:

DESC LISTING MYLISTING;

Copy

+------------------------------+---------------------+------------------+---------------------+--------------------------------------+--------------------------------------+--------------------------------------+----------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------+------------------+--------------------+-----------------+---------------+---------------------+-------------+----------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------+--------------------------------------------------+-----------------------------+----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+------------------+----------------------+----------------+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
|   global_name                |   name              |   owner          |   owner_role_type   |   created_on                         |   updated_on                         |   published_on                       |   title                                                        |   subtitle                                         |   description                                                                                                              |   target_accounts   |   is_monetized   |   is_application   |   is_targeted   |   state       |   revisions         |   comment   |   refresh_schedule   |   refresh_type    |   business_needs                                                                                                                                         |   usage_examples                                                                                                     |   listing_terms         |   profile                                        |   customized_contact_info   |  application_package |  data_dictionary                                                                                                                   |   regions   |   manifest_yaml                                                                   |   review_state   |   rejection_reason   |   categories   |   resources                                                                                                     |   unpublished_by_admin_reason   |
+------------------------------+---------------------+------------------+---------------------+--------------------------------------+--------------------------------------+--------------------------------------+----------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------+------------------+--------------------+-----------------+---------------+---------------------+-------------+----------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------+--------------------------------------------------+-----------------------------+----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+------------------+----------------------+----------------+-----------------------------------------------------------------------------------------------------------------+---------------------------------+
|   GZ13Z1VEWNG                |   CDC_COVID_19_DATA |   ACCOUNTADMIN   |   ROLE              |   2023-12-01T13:01:13.367-08:00      |   2023-12-01T13:25:11.331-08:00      |   2023-12-01T13:25:11.331-08:00      |   Understanding COVID-19: Explore the Latest Data from the CDC |   Track cases, deaths, vaccination rates, and more |   Get the most up-to-date information on the COVID-19 pandemic from the Centers for Disease Control and Prevention (CDC).  |                     |   false          |   false            |   false         |   PUBLISHED   |   DRAFT,PUBLISHED   |             |   60 MINUTE          |   FULL_DATABASE   |   [{""type"":""CUSTOM"",""name"":""Public Health Monitoring and Response"",""description"":""Monitor trends in cases, deaths, and other key metrics.""}] |   [{""title"":""Identify potential outbreaks of COVID-19 in [country name] by tracking trends in confirmed cases"    |   {"type":"STANDARD"}   |   RAVENCLAW_9A314599_F644_4664_946B_4DE0B2169C28 |                             |                      |  {""database"":""COVIDDATADB"",""objects"":[{""schema"":""PUBLIC"",""domain"":""TABLE"",""name"":""GLOBAL_COVID_STATISTICS""}]}"   |   ALL       |   title: "Understanding COVID-19: Explore the Latest Data from the CDC"  . . .    |                  |                      |   HEALTH       |   "{""documentation"":""https://snowflake.com/doc"",""media"":""https://www.youtube.com/watch?v=AR88dZG-hwo""}" |                                 |
+------------------------------+---------------------+------------------+---------------------+--------------------------------------+--------------------------------------+--------------------------------------+----------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------+------------------+--------------------+-----------------+---------------+---------------------+-------------+----------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+-------------------------+--------------------------------------------------+-----------------------------+----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+------------------+----------------------+----------------+-----------------------------------------------------------------------------------------------------------------+---------------------------------+