DESCRIBE CATALOG INTEGRATION

Describes the properties of a catalog integration.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE CATALOG INTEGRATION , DROP CATALOG INTEGRATION , SHOW CATALOG INTEGRATIONS

Syntax

DESC[RIBE] CATALOG INTEGRATION <name>
Copy

Parameters

name

Specifies the identifier for the catalog integration 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.

Access control requirements

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

Privilege

Object

Notes

USAGE

Integration (catalog)

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 RESULT_SCAN function, which treats the output as a table that can be queried.

Output

The command output provides catalog integration properties and metadata in the following columns.

Column

Description

property

The name of the property. For property descriptions, see CREATE CATALOG INTEGRATION.

property_type

The property type.

property_value

The value assigned to the property.

property_default

The default property value.

Examples

Describe the columns in the integration:

DESC CATALOG INTEGRATION myCatalogInt;
Copy

The following shows the output of DESCRIBE CATALOG INTEGRATION for an AWS Glue catalog integration. The output includes AWS Glue-specific (for example, GLUE_AWS_ROLE_ARN) and common catalog integration properties.

+-----------------------+---------------+----------------------------------+------------------+
|       property        | property_type |          property_value          | property_default |
+-----------------------+---------------+----------------------------------+------------------+
| ENABLED               | Boolean       | true                             | false            |
| CATALOG_SOURCE        | String        | GLUE                             |                  |
| CATALOG_NAMESPACE     | String        | dbname                           |                  |
| TABLE_FORMAT          | String        | ICEBERG                          |                  |
| GLUE_AWS_ROLE_ARN     | String        | arn:aws:iam::123:role/dummy-role |                  |
| GLUE_CATALOG_ID       | String        | 123456789012                     |                  |
| GLUE_REGION           | String        | us-west-2                        |                  |
| GLUE_AWS_IAM_USER_ARN | String        | arn:aws:iam::123:user/example    |                  |
| GLUE_AWS_EXTERNAL_ID  | String        | exampleGlueExternalId            |                  |
| COMMENT               | String        |                                  |                  |
+-----------------------+---------------+----------------------------------+------------------+