.alter materialized-view docstring

适用于:✅Azure 数据资源管理器

更改与现有具体化视图关联的 DocString 值以对该视图进行说明。

权限

你必须至少具有具体化视图管理员权限才能运行此命令。

语法

.alter materialized-view MaterializedViewName docstringDocString

详细了解语法约定

参数

客户 类型​​ 必需 说明
MaterializedViewName string ✔️ 具体化视图的名称。
DocString string ✔️ 可以附加到具体化视图的自由文本,用于说明具体化视图。 此字符串显示在实体名称旁边的各种 UI 设置中。

返回

输出架构:

客户 类型​​ 说明
客户 string 具体化视图的名称。
SourceTable string 定义视图的源表的名称。
查询 string 具体化视图的查询定义。
MaterializedTo datetime 源表中的最大具体化 ingestion_time() 时间戳。 有关详细信息,请参阅具体化视图的工作原理
LastRun datetime 上次运行具体化的时间。
LastRunResult string 上次运行的结果。 如果运行成功,则返回 Completed,否则返回 Failed
IsHealthy bool 当视图被认为正常时为 true,否则为 false。 如果视图在最后一小时之前被成功地具体化(MaterializedTo 大于 ago(1h)),则认为它是正常的。
已启用 bool 如果视图已启用,则为 true(请参阅禁用或启用具体化视图)。
文件夹 string 在其中创建具体化视图的文件夹。
DocString string 分配给具体化视图的说明。
AutoUpdateSchema bool 视图是否已启用自动更新。
EffectiveDateTime datetime 视图的生效日期时间,在创建期间确定(请参阅 .create materialized-view)。
回溯 timespan 限制预期重复或更新的时间段的时间跨度。 有关详细信息,请参阅 回溯期
LookbackColumn string 视图中的 string 列,用作回溯期的引用。 如果此列为空,但 lookback 具有值,则具体化视图使用默认回溯。 有关详细信息,请参阅 回溯期

示例

设置具体化视图的 docstring

以下命令通过具体化视图的 docstring 属性设置具体化视图的说明:

.alter materialized-view MyView docstring "docs here..."

输出

客户 SourceTable 查询 MaterializedTo LastRun LastRunResult IsHealthy 已启用 文件夹 DocString AutoUpdateSchema EffectiveDateTime 回溯
MyView MyTable MyTable |summarize take_any\ by Column1 2023-02-26T16:40:03.3345704Z 2023-02-26T16:44:15.9033667Z 已完成 “此处的文档...” 2023-02-23T14:01:42.5172342Z