类别：: 系统函数（系统信息）

SYSTEM$GET_CATALOG_LINKED_DATABASE_CONFIG¶

返回在指定目录关联的数据库上设置的配置参数。输出为 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_NAMESPACE`、`HIERARCHICAL`。
`namespace_flatten_delimiter`	展平嵌套命名空间时使用的分隔符。仅适用于 `namespace_mode` 为 `FLATTEN_NESTED_NAMESPACE` 的情况。
`allowed_write_operations`	目录链接数据库上允许的写入操作类型。可能的值：`NONE`、`ALL`。
`catalog_case_sensitivity`	目录的区分大小写设置。可能的值：`CASE_SENSITIVE`、`CASE_INSENSITIVE`。
`is_suspended`	目录链接数据库同步是否已暂停。如果已暂停，则返回 `true`，否则为 `false`。
`allowed_namespaces`	允许同步的命名空间列表。如果允许所有命名空间，则返回 `null`。
`blocked_namespaces`	阻止同步的命名空间列表。如果没有命名空间被阻止，则返回 `null`。

有关示例输出，请参阅示例。

访问控制要求¶

用于执行此操作的角色必须具有 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'"]
}