.show databases entities 命令
以下命令显示数据库的实体,例如表、具体化视图、外部表等。
权限
你必须至少具有数据库用户、数据库查看者或数据库监视者权限才能运行这些命令。 有关详细信息,请参阅基于角色的访问控制。
.show databases entities
语法
.show
databases
entities
[with
(
选项)
]
支持的选项
密钥 | 值 | 说明 |
---|---|---|
showObfuscatedStrings |
bool |
默认为 false 。 如果为 true ,则会显示数据库实体正文中经过模糊处理得字符串。 若要使用此选项,你需是数据库管理员或实体创建者。 如果没有这些权限,该命令将失败。 |
resolveFunctionsSchema |
bool |
默认为 false 。 如果 true ,则返回的存储函数将解析输出架构。 |
返回
返回用户可见的所有群集数据库的实体列表。 数据库实体包括:表、具体化视图、外部表等。
重要
默认情况下,返回所有数据库的实体。 若要使命令执行更加优化,请添加 where
条件,它会按特定数据库和/或实体类型或名称进行筛选(请参阅本文的示例部分)。
返回的列
列 | 说明 |
---|---|
DatabaseName | 定义了实体的数据库的名称 |
EntityType | 其中之一:Table 、MaterialiedView 、ExternalTable 、Function 、EntityGroup |
EntityName | 实体的名称 |
DocString | 实体文档(如果存在) |
文件夹 | 实体所在的文件夹名称 |
CslInputSchema | CSL 架构格式的实体输入架构(如果适用)。 对于函数,这是函数参数架构 |
内容 | 实体内容(如果适用)。 对于函数,它是函数的主体 |
CslOutputSchema | CSL 架构格式的实体输出架构 |
属性 | 动态结构,提供有关(当前未使用的)实体的更多详细信息 |
示例
显示数据库实体
.show databases entities with (showObfuscatedStrings=true)
| where DatabaseName == "TestDB"
输出
DatabaseName | EntityType | EntityName | DocString | 文件夹 | CslInputSchema | 内容 | CslOutputSchema | 属性 |
---|---|---|---|---|---|---|---|---|
TestDB | 表 | GeoIP | 包含每个 IP 网络的地理位置信息的表 | 我的表 | ['network']:string, locale_code:string, continent_code:string, continent_name:string, country_iso_code:string,country_name:string | {} | ||
TestDB | MaterializedView | MV1 | 我的第一个具体化视图 | a:long, b:string, c:long | {} | |||
TestDB | 函数 | MeaningLessFn | 我的第一个函数 | 函数 | (T:(s:string,a:long,b:long), k:long) | {T | extend substring(s, a, b) | take k} | {} |
解析函数架构
.show databases entities with (resolveFunctionsSchema=true)
| where DatabaseName == "TestDB" and EntityType == "Function" and EntityName == "MeaningLessFn"
输出
DatabaseName | EntityType | EntityName | DocString | 文件夹 | CslInputSchema | 内容 | CslOutputSchema | 属性 |
---|---|---|---|---|---|---|---|---|
TestDB | 函数 | MeaningLessFn | 我的第一个函数 | 函数 | (T:(s:string,a:long,b:long), k:long) | {T | extend substring(s, a, b) | take k} | s:string, a:long, b:long, Column1:string | {} |