DESCRIBE CATALOG INTEGRATION

描述 目录集成 的属性。

DESCRIBE 可以缩写为 DESC。

小技巧

除了 SQL，您还可以使用其他接口，如 Snowflake REST APIs、Snowflake Python APIs 和 Snowflake CLI。请参阅 备用接口。

另请参阅：

CREATE CATALOG INTEGRATION、ALTER CATALOG INTEGRATION、DROP CATALOG INTEGRATION、SHOW CATALOG INTEGRATIONS

语法

DESC[RIBE] CATALOG INTEGRATION <name>
Copy

参数

name

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

输出

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

列

描述

property

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

property_type

属性类型。

property_value

分配给属性的值。

property_default

默认属性值。

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

属性

描述

enabled

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

catalog_source

目录源的类型；ICEBERG_REST、POLARIS、OBJECT_STORE 或 :code:`GLUE`（对于非 REST Glue 集成）。

refresh_interval_seconds

指定 Snowflake 在尝试轮询外部 Iceberg 目录期间等待的秒数，该轮询旨在获取用于 自动刷新 的元数据更新。

rest_authentication

为目录集成指定 REST 身份验证参数。

rest_config

指定目录集成的 REST 配置参数。

catalog_namespace

此列的输出如下所示：

  • 如果目录集成适用于外部管理的 Iceberg 表，请指定外部 Iceberg 目录的命名空间。如果仅在表级别指定命名空间，则此列在函数输出中没有值。

  • 如果目录集成用于 将 Snowflake 管理的表与 Snowflake Open 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

目录集成的注释。

访问控制要求

用于执行此操作的 角色 必须至少具有以下 权限：

权限

对象

备注

USAGE

集成（目录）

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

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

使用说明

  • To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

    The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is type, then specify "type" for the identifier.

示例

描述目录集成：

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        |                                  |                  |
+-----------------------+---------------+----------------------------------+------------------+

备用接口

语言: 中文