DESCRIBE CATALOG INTEGRATION

カタログ統合 のプロパティについて説明します。

DESCRIBE は DESC に短縮できます。

Tip

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

カタログソースの型。例: GLUE または OBJECT_STORE

catalog_namespace

(AWS Glue) AWS Glue Data Catalog名前空間を指定します。

table_format

カタログが提供するテーブル形式を指定します。例: ICEBERG

glue_aws_role_arn

(AWS Glue)Snowflakeが AWS Glueに接続するために想定する IAM ロールのAmazonリソース名(ARN)。

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 アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • このコマンドの出力を後処理するには、 RESULT_SCAN 関数を使用できます。この関数は、出力をクエリ可能なテーブルとして扱います。

カタログ統合を説明します。

DESC CATALOG INTEGRATION my_catalog_integration;
Copy

以下に、AWS Glueカタログ統合の DESCRIBE CATALOG INTEGRATION の出力を示します。出力には 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        |                                  |                  |
+-----------------------+---------------+----------------------------------+------------------+

代替インターフェイス