共用方式為

quality-monitors 命令群組

Note

此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。

Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。

quality-monitors 內的命令群組包含建立、編輯和刪除品質監視器的命令。 監控器會隨時間推移計算和監測數據表的數據或模型品質指標。 它會產生計量數據表和儀錶板，可用來監視數據表健康情況並設定警示。 請參閱 資料分析。

databricks質量監視器建立

為指定的數據表建立新的監視器。

呼叫端必須選擇其中一項或操作：

  1. 是資料表父目錄的擁有者、在資料表的父架構上具有 USE_SCHEMA 的權限，而且在資料表上具有 SELECT 的存取權。
  2. 在數據表的父目錄上具有 USE_CATALOG ，成為數據表父架構的擁有者，而且具有 SELECT 數據表的存取權。
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • 成為資料表的擁有者。

工作區資產，例如儀錶板，將會在進行此呼叫的工作區中建立。

databricks quality-monitors create TABLE_NAME ASSETS_DIR OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

ASSETS_DIR

    用來儲存監視資產的目錄（例如儀錶板、計量數據表）。

OUTPUT_SCHEMA_NAME

    建立輸出計量數據表的架構。

選項

--baseline-table-name string

    從中計算漂移計量的基準數據表名稱。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--skip-builtin-dashboard

    是否要略過建立預設的儀表板來摘要數據品質指標。

--warehouse-id string

    選填參數，以指定建立儀錶板所用的倉儲。

全域旗標

Examples

下列範例會建立資料表的品質監視器：

databricks quality-monitors create main.my_schema.my_table /monitoring/assets main.monitoring_schema

databricks質量監視器刪除

刪除指定數據表的監視器。

呼叫端必須選擇其中一項或操作：

  1. 成為數據表父目錄的擁有者
  2. 在數據表的父目錄上具有 USE_CATALOG ，並且是數據表父架構的擁有者
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • 成為資料表的擁有者。

此外，必須從建立監視器的工作區進行呼叫。

請注意，計量數據表和儀錶板不會在此呼叫中刪除;這些資產必須手動清除（如有需要）。

databricks quality-monitors delete TABLE_NAME [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

選項

全域旗標

Examples

下列範例會刪除質量監視器：

databricks quality-monitors delete main.my_schema.my_table

databricks質量監視器取得

取得指定數據表的監視器。

呼叫端必須選擇其中一項或操作：

  1. 成為數據表父目錄的擁有者
  2. 在數據表的父級目錄上擁有 USE_CATALOG ，並且是數據表父級架構的擁有者。
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • SELECT 數據表上的權限。

傳回的資訊包括組態值，以及監視器所建立資產的相關信息。 如果呼叫者在與監視器創建位置不同的工作區，某些資訊（例如儀錶板）可能會被篩選掉。

databricks quality-monitors get TABLE_NAME [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

選項

全域旗標

Examples

下列範例會取得品質監視器的相關資訊：

databricks quality-monitors get main.my_schema.my_table

databricks 品質監控 get-refresh

使用指定的重新整理標識子取得特定監視器重新整理的相關信息。

呼叫端必須選擇其中一項或操作：

  1. 成為數據表父目錄的擁有者
  2. 在數據表的父目錄上具有 USE_CATALOG ，並且是數據表父架構的擁有者
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • SELECT 數據表上的權限。

此外，必須從建立監視器的工作區進行呼叫。

databricks quality-monitors get-refresh TABLE_NAME REFRESH_ID [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

REFRESH_ID

    重新整理的標識碼。

選項

全域旗標

Examples

以下範例會取得特定重新整理的相關資訊：

databricks quality-monitors get-refresh main.my_schema.my_table 12345

databricks 品質監控器 列表刷新

列出此數據表最近重新整理的歷程記錄（最多 25 個）。

呼叫端必須選擇其中一項或操作：

  1. 成為數據表父目錄的擁有者
  2. 在數據表的父目錄上具有 USE_CATALOG ，並且是數據表父架構的擁有者
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • SELECT 數據表上的權限。

此外，必須從建立監視器的工作區進行呼叫。

databricks quality-monitors list-refreshes TABLE_NAME [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

選項

全域旗標

Examples

下列範例會列出品質監視器的更新：

databricks quality-monitors list-refreshes main.my_schema.my_table

databricks 品質監控器運行刷新

將指定數據表之監視器上的計量重新整理排入佇列。 刷新會在背景中執行。

呼叫端必須選擇其中一項或操作：

  1. 成為數據表父目錄的擁有者
  2. 在數據表的父目錄上具有 USE_CATALOG ，並且是數據表父架構的擁有者
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • 成為資料表的擁有者

此外，必須從建立監視器的工作區進行呼叫。

databricks quality-monitors run-refresh TABLE_NAME [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

選項

全域旗標

Examples

下列範例會將品質監視器的刷新排程：

databricks quality-monitors run-refresh main.my_schema.my_table

databricks質量監視器更新

更新指定數據表的監視器。

呼叫端必須選擇其中一項或操作：

  1. 成為數據表父目錄的擁有者
  2. 在數據表的父目錄上具有 USE_CATALOG ，並且是數據表父架構的擁有者
  3. 具有下列權限：
    • USE_CATALOG 在資料表的父目錄中
    • USE_SCHEMA 在數據表的父架構上
    • 成為資料表的擁有者。

此外，必須從建立監視器的工作區進行呼叫，而呼叫端必須是監視器的原始建立者。

無法更新某些組態欄位，例如輸出資產標識碼。

databricks quality-monitors update TABLE_NAME OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    數據表的完整名稱。

OUTPUT_SCHEMA_NAME

    建立輸出計量數據表的架構。

選項

--baseline-table-name string

    從中計算漂移計量的基準數據表名稱。

--dashboard-id string

    用於可視化計算指標的儀錶板識別碼。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Examples

下列範例會更新品質監視器：

databricks quality-monitors update main.my_schema.my_table main.monitoring_schema

下列範例會使用新的基準資料表來更新品質監視器：

databricks quality-monitors update main.my_schema.my_table main.monitoring_schema --baseline-table-name main.my_schema.new_baseline

全域旗標

--debug

  是否要啟用偵錯記錄。

-h 或 --help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--log-file 字串

    字串，表示要寫入輸出記錄檔的檔案。 若未指定此旗標，則預設值是將輸出記錄寫入 stderr。

--log-format 格式

    記錄格式類型，text 或 json。 預設值是 text。

--log-level 字串

    表示日誌格式層級的字串。 若未指定，則日誌的格式層級功能將被停用。

-o, --output 類型

    指令輸出類型，text 或 json。 預設值是 text。

-p, --profile 字串

    用於執行命令的~/.databrickscfg檔案中的配置檔名稱。 如果未指定此旗標，則如果存在，則會使用名為 DEFAULT 的配置檔。

--progress-format 格式

    顯示進度記錄的格式：default、、appendinplace、 或json

-t, --target 字串

    如果適用，要使用的套件組合目標

  • Last updated on