DESCRIBE GATEWAY

描述 网关 的属性。

DESCRIBE 可以缩写为 DESC。

另请参阅:

CREATE GATEWAYALTER GATEWAYDROP GATEWAYSHOW GATEWAYS

语法

DESC[RIBE] GATEWAY <name>
Copy

参数

name

指定要描述的网关的标识符。

如果标识符包含空格或特殊字符,则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

有关更多信息,请参阅 标识符要求

输出

命令输出在以下列中提供网关属性和元数据:

描述

name

网关名称。

ingress_url

网关入口 URL。

privatelink_ingress_url

PrivateLink 入口 URL。

database_name

在其中创建网关的数据库。

schema_name

在其中创建网关的架构。

owner

拥有网关的角色。

owner_role_type

拥有对象的角色类型是 ROLE 或 DATABASE_ROLE。

spec

网关规范(YAML 格式)。仅当执行命令的角色具有网关的 USAGE、MODIFY 或 OWNERSHIP 权限时,才会显示此列。

created_on

创建网关时的时间戳。

updated_on

上次更新网关时的时间戳。

comment

网关相关注释。

备注

如果使用的角色具有网关的 USAGE、MODIFY 或 OWNERSHIP 权限,spec 列将显示。如果没有,将显示其他列,但不显示 spec 列。

访问控制要求

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

权限

对象

备注

USAGE、MODIFY 或 OWNERSHIP

网关

这些权限中的任何一个都允许描述网关。只有具有这些权限的角色才能查看规范。

USAGE

数据库

对于包含网关的数据库是必需的。

USAGE

架构

对于包含网关的架构是必需的。

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

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

使用说明

  • 要对该命令的输出进行后处理,可以使用 管道运算符 (->>) 或 RESULT_SCAN 函数。这两种构造都将输出视为可以查询的结果集。

    例如,您可使用管道操作符或 RESULT_SCAN 函数,从 SHOW 命令输出中选择特定列或筛选行数据。

    引用输出列时,为列名使用 双引号标识符。例如,选择输出列 type,指定 SELECT "type"

    必须使用双引号标识符,因为 SHOW 命令的输出列名均为小写格式。双引号确保 SELECT 列表或 WHERE 子句中的列名,与已扫描的 SHOW 命令输出中的列名完全匹配。

示例

以下示例描述了名为 split_gateway 的网关:

DESCRIBE GATEWAY split_gateway;
Copy
语言: 中文