次の方法で共有

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 ファイルに対するインライン JSON 文字列または @path。

--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 品質監視のリフレッシュを取得 (quality-monitors get-refresh)

指定された更新 ID を使用して、特定のモニターの更新に関する情報を取得します。

呼び出し元は、次のいずれかを行う必要があります。

  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

    更新の ID。

オプション

グローバル フラグ

Examples

次の例では、特定の更新に関する情報を取得します。

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

データブリックス quality-monitors list-refreshes

このテーブルの最新の更新の履歴 (最大 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 quality-monitors run-refresh

指定したテーブルのモニターでメトリック更新をキューに登録します。 更新はバックグラウンドで実行されます。

呼び出し元は、次のいずれかを行う必要があります。

  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

    計算されたメトリックを視覚化するダッシュボードの ID。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

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、 append、 inplace、または json

-t, --target 文字列

    該当する場合は、使用するバンドル ターゲット

  • Last updated on