DESCRIBE CATALOG INTEGRATION

描述 目录集成 的属性。

DESCRIBE 可以缩写为 DESC。

另请参阅:

CREATE CATALOG INTEGRATIONDROP CATALOG INTEGRATIONSHOW CATALOG INTEGRATIONS

语法

DESC[RIBE] CATALOG INTEGRATION <name>
Copy

参数

name

指定要描述的目录集成的标识符。如果标识符包含空格或特殊字符,则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

输出

命令的输出包括以下列,它们描述了对象的属性和元数据:

描述

property

属性的名称。此列可以包含下表中列出的属性。

property_type

属性类型。

property_value

分配给属性的值。

property_default

默认属性值。

property 列可以包含目录集成对象的以下属性:

属性

描述

enabled

指定目录集成是否可用于 Iceberg 表。

catalog_source

目录源的类型;例如 GLUEOBJECT_STORE

catalog_namespace

(AWS Glue) 指定 AWS Glue Data Catalog 命名空间。

table_format

目录提供的表格式;例如 ICEBERG

glue_aws_role_arn

(AWS Glue) IAM 角色的 Amazon 资源名称 (ARN),Snowflake 担任该角色来连接到 AWS Glue。

glue_catalog_id

(AWS Glue) AWS 账户的 ID。

glue_region

(AWS Glue) AWS Glue Data Catalog 的 AWS 区域。

glue_aws_iam_user_arn

(AWS Glue) 在创建目录集成时为 Snowflake 账户创建的 AWS IAM 用户的 ARN。

glue_aws_external_id

(AWS Glue) Snowflake 与 AWS Glue 建立信任关系所使用的外部 ID。

comment

目录集成的注释。

访问控制要求

用于执行此 SQL 命令的 角色 必须至少具有以下 权限

权限

对象

备注

USAGE

集成(目录)

有关创建具有指定权限集的自定义角色的说明,请参阅 创建自定义角色

有关对 安全对象 执行 SQL 操作的相应角色和权限授予的一般信息,请参阅 访问控制概述

使用说明

  • 若要对此命令的输出进行后处理,可以使用 RESULT_SCAN 函数,该函数会将输出视为可查询的表。

示例

描述目录集成:

DESC CATALOG INTEGRATION my_catalog_integration;
Copy

下面显示了 DESCRIBE CATALOG INTEGRATION 对于 AWS Glue 目录集成的输出。输出包括 AWS Glue 特定属性(例如,GLUE_AWS_ROLE_ARN)和常用目录集成属性。

+-----------------------+---------------+----------------------------------+------------------+
|       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        |                                  |                  |
+-----------------------+---------------+----------------------------------+------------------+
语言: 中文