DESCRIBE MODEL MONITOR¶

显示有关特定模型监控器的信息。此命令显示 SHOW MODEL MONITORS 命令显示的所有信息，以及附加信息。

DESCRIBE 可以缩写为 DESC。

另请参阅：: CREATE MODEL MONITOR、ALTER MODEL MONITOR、SHOW MODEL MONITORS、DROP MODEL MONITOR

语法¶

{ DESCRIBE | DESC } MODEL MONITOR <monitor_name>

Copy

参数¶

monitor_name

指定要描述的模型监控器的标识符。

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

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

输出¶

命令输出在以下列中提供模型监控器属性和元数据：

列	描述
`created_on`	创建模型监控器时的日期和时间。
`name`	模型监控器的名称。
`database_name`	用于存储模型监控器的数据库。
`schema_name`	用于存储模型监控器的架构。
`warehouse_name`	用于监控模型的仓库。
`refresh_interval`	触发模型监控器刷新的刷新间隔（目标滞后）。
`aggregation_window`	计算指标的汇总窗口。
`model_task`	被监控的模型的任务，可以是 TABULAR_BINARY_CLASSIFICATION 或 TABULAR_REGRESSION。
`monitor_state`	模型监控器的状态： ACTIVE：模型监控器处于活动状态，工作正常。 SUSPENDED：模型监控已暂停。 PARTIALLY_SUSPENDED：一个基础表在预期的时间间隔内停止刷新时的错误条件。有关更多详细信息，请参阅 DESCRIBE。 UNKNOWN：无法识别基础表状态时的错误条件。
`source`	详细列出聚合所基于的源表或视图的 JSON 对象的字符串表示。如果表不存在或无法访问，则值为空字字符串。请参阅表 JSON 对象规范。
`baseline`	详细说明用于监控的基线表的 JSON 对象的字符串表示，其中克隆嵌入在模型监控器对象中。请参阅表 JSON 对象规范。
`model`	JSON 对象的字符串表示，其中包含有关监控模型的具体信息。请参阅模型 JSON 对象规范。
`comment`	关于模型监控器的注释。
The following columns are the additional columns displayed by DESCRIBE compared to SHOW
`aggregation_status`	JSON object containing aggregation status for each dynamic table type. Keys: `SOURCE_AGGREGATED` / `ACCURACY_AGGREGATED` (non-segment) `SOURCE_AGGREGATED_<segment_column>` / `ACCURACY_AGGREGATED_<segment_column>` (segment-specific) Values: `ACTIVE` or `SUSPENDED`
`aggregation_last_error`	JSON object containing the last error for each dynamic table type. Keys: Same as `aggregation_status` Values: Error message, or empty string if successful
`aggregation_last_data_timestamp`	JSON object containing the last update timestamp for each dynamic table type. Keys: Same as `aggregation_status` Values: Timestamp of last successful update
`columns`	JSON 对象的字符串表示，其中包含源表中正在使用的列的名称。请参阅列 JSON 对象规范。

表 JSON 对象规范¶

以下是命令输出中的 source 和 baseline 列使用的表的 JSON 表示格式：

`name`	源或者基线表或视图的名称。
`database_name`	用于存储表或视图的数据库。
`schema_name`	用于存储表或视图的架构。
`status`	表的状态： ACTIVE：用户可以访问表或视图。 MASKED：当前用户无权访问表或视图。其他字段的值掩码显示（即，显示为一系列星号）。 DELETED：表或视图已删除。 NOT_SET：状态尚未设置。

name

源或者基线表或视图的名称。

database_name

用于存储表或视图的数据库。

schema_name

用于存储表或视图的架构。

status

表的状态：

ACTIVE：用户可以访问表或视图。
MASKED：当前用户无权访问表或视图。其他字段的值掩码显示（即，显示为一系列星号）。
DELETED：表或视图已删除。
NOT_SET：状态尚未设置。

模型 JSON 对象规范¶

以下是命令输出中 model 列使用的模型的 JSON 表示格式：

字段	描述
`model_name`	被监控的模型的名称。
`version_name`	被监控的模型版本的版本名称。
`function_name`	指定模型版本中被监控的特定函数的名称。
`database_name`	存储模型的数据库。
`schema_name`	存储模型的架构。
`model_status`	模型的状态。可以是 ACTIVE、MASKED 或 DELETED。MASKED 表示用户无权访问模型；其他字段显示为一系列星号。
`version_status`	模型版本的状态。可以是 ACTIVE 或 DELETED。（MASKED 不是模型版本的有效状态，因为它们没有访问控制。）

列 JSON 对象规范¶

以下是命令输出中 columns 列使用的列的 JSON 表示格式：

字段	描述
`timestamp_column`	数据源中时间戳列的名称。
`id_columns`	字符串列名称的数组，它们一起唯一标识源数据中的每行。
`prediction_class_columns`	用于命名数据源中所有预测类列的字符串数组。
`prediction_score_columns`	用于命名数据源中所有预测分数列的字符串数组。
`actual_class_columns`	用于命名数据源中所有实际类列的字符串数组。
`numerical_columns`	用于命名模型监控器从源表中使用的所有数值特征列的字符串数组。
`string_columns`	用于命名模型监控器从源表中使用的所有字符串（分类）特征列的字符串数组。
`boolean_columns`	用于命名模型监控器从源表中使用的所有布尔（分类）特征列的字符串数组。
`segment_columns`	An array of strings naming all segment columns in the data source. For existing model monitors created without segments, this field will be an empty array.

访问控制要求¶

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

权限	对象	备注
任意	模型监控器

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema. Note that a role granted any privilege on a schema allows that role to resolve the schema. For example, a role granted CREATE privilege on a schema can create objects on that schema without also having USAGE granted on that schema.

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

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

使用说明¶

To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is type, then specify "type" for the identifier.