カテゴリ:

システム関数 (システム情報)

SYSTEM$GET_CATALOG_LINKED_DATABASE_CONFIG

指定された:doc:`カタログリンクのデータベース</user-guide/tables-iceberg-catalog-linked-database>`に設定された構成パラメーターを返します。出力はJSON形式です。

構文

SYSTEM$GET_CATALOG_LINKED_DATABASE_CONFIG('<catalog_linked_database_name>');

引数

catalog_linked_database_name

構成を取得するカタログリンクのデータベースの名前。

一重引用符で囲まれた文字列リテラルとして指定します。

戻り値

関数は、データベースの構成パラメーターを持つJSONオブジェクトを含む文字列を返します。

フィールド

説明

catalog_integration

カタログリンクのデータベースで使用されるカタログ統合の名前。

catalog_name

外部カタログのカタログ名前空間の名前。指定がない場合は null を返します。

external_volume

テーブルストレージに使用される外部ボリュームの名前。

sync_interval_seconds

Snowflakeがリモートカタログをポーリングして変更を検出する間隔(秒単位)。

namespace_mode

名前空間を処理するためのモード。可能な値: FLATTEN_NESTED_NAMESPACEHIERARCHICAL

namespace_flatten_delimiter

ネストされた名前空間をフラット化するときに使用される区切り文字。``namespace_mode``が``FLATTEN_NESTED_NAMESPACE``の場合にのみ適用されます。

allowed_write_operations

カタログリンクのデータベースで許可される書き込み操作のタイプ。可能な値: NONEALL

catalog_case_sensitivity

カタログの大文字と小文字の区別設定。可能な値: CASE_SENSITIVECASE_INSENSITIVE

is_suspended

カタログリンクのデータベースの同期が一時停止されているかどうか。一時停止されている場合は``true``、それ以外の場合は``false``を返します。

allowed_namespaces

同期が許可されている名前空間のリスト。すべての名前空間が許可されている場合は``null``を返します。

blocked_namespaces

同期がブロックされている名前空間のリスト。名前空間がブロックされていない場合は``null``を返します。

出力例については、:ref:`label-functions_get_catalog_linked_database_config_examples`を参照してください。

アクセス制御の要件

この操作の実行に使用されるロールには、MONITOR、USAGE、OWNERSHIP、またはALL権限が必要です。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

``my_db``という名前のカタログリンクのデータベースの構成を取得します。

SELECT SYSTEM$GET_CATALOG_LINKED_DATABASE_CONFIG('my_db');

出力例:

{
  "catalog_integration": "TEST_GET_CLD_CONFIG_EBEC9E22_44BD_4945_A4C3_A402CCBB86AF_CAT",
  "catalog_name": null,
  "external_volume": "EXVOL_GET_CLD_CONFIG",
  "sync_interval_seconds": 600,
  "namespace_mode": "FLATTEN_NESTED_NAMESPACE",
  "namespace_flatten_delimiter": "_",
  "allowed_write_operations": "NONE",
  "catalog_case_sensitivity": "CASE_INSENSITIVE",
  "is_suspended": false,
  "allowed_namespaces": ["'ns1'", "'ns2'"],
  "blocked_namespaces": ["'blocked_ns1'"]
}