quality-monitors コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のquality-monitorsコマンド グループには、品質モニターを作成、編集、および削除するコマンドが含まれています。モニターは、時間の経過に伴うテーブルのデータまたはモデル品質を監視します。 メトリクステーブルとダッシュボードを生成し、テーブルの健全性を監視し、アラートを設定します。 Databricksレイクハウスモニタリングの概要を参照してください。
databricks quality-monitors create
指定したテーブルの新しいモニターを作成します。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であり、テーブルの親スキーマに対する
USE_SCHEMAを持ち、テーブルに対するSELECTアクセス権を持っている - テーブルの親カタログに
USE_CATALOGを持ち、テーブルの親スキーマの所有者であり、テーブルに対するSELECTアクセス権を持っています。 - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマ- テーブルの所有者であること。
ダッシュボードなどのワークスペース資産は、この呼び出しが行われたワークスペースに作成されます。
databricks quality-monitors create TABLE_NAME ASSETS_DIR OUTPUT_SCHEMA_NAME [flags]
引数
TABLE_NAME
テーブルのフルネーム。
ASSETS_DIR
モニタリングアセットを格納するディレクトリ(例: ダッシュボード、メトリクステーブル)。
OUTPUT_SCHEMA_NAME
出力メトリクステーブルが作成されるスキーマ。
オプション
--baseline-table-name string
ドリフトメトリクスがコンピュートされるベースラインテーブルの名前。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--skip-builtin-dashboard
作成をスキップするかどうか デフォルトダッシュボード データ品質を要約する メトリクス.
--warehouse-id string
ダッシュボード作成のウェアハウスを指定するオプションの引数。
例
次の例では、テーブルの品質モニターを作成します。
databricks quality-monitors create main.my_schema.my_table /monitoring/assets main.monitoring_schema
databricks quality-monitors delete
指定した表のモニターを削除します。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であること
- テーブルの親カタログに
USE_CATALOGがあり、テーブルの親スキーマの所有者であること - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマ- テーブルの所有者であること。
さらに、モニターが作成されたワークスペースから呼び出しを行う必要があります。
メトリクス テーブルとダッシュボードは、この呼び出しの一部として削除されないことに注意してください。これらの資産は、手動でクリーンアップする必要があります (必要な場合)。
databricks quality-monitors delete TABLE_NAME [flags]
引数
TABLE_NAME
テーブルのフルネーム。
オプション
例
次の例では、品質モニターを削除します。
databricks quality-monitors delete main.my_schema.my_table
databricks quality-monitors get
指定したテーブルのモニターを取得します。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であること
- テーブルの親カタログに
USE_CATALOGがあり、テーブルの親スキーマの所有者である。 - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマSELECT権限をテーブルに対して持っていること。
返される情報には、構成値と、モニターによって作成された資産に関する情報が含まれます。一部の情報 (ダッシュボードなど) は、呼び出し元がモニターが作成された場所とは異なるワークスペースにいる場合、除外される場合があります。
databricks quality-monitors get TABLE_NAME [flags]
引数
TABLE_NAME
テーブルのフルネーム。
オプション
例
次の例では、品質モニターに関する情報を取得します。
databricks quality-monitors get main.my_schema.my_table
databricks quality-monitors get-refresh
指定された更新 ID を使用して、特定のモニター更新に関する情報を取得します。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であること
- テーブルの親カタログに
USE_CATALOGがあり、テーブルの親スキーマの所有者であること - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマSELECT権限をテーブルに対して持っていること。
さらに、モニターが作成されたワークスペースから呼び出しを行う必要があります。
databricks quality-monitors get-refresh TABLE_NAME REFRESH_ID [flags]
引数
TABLE_NAME
テーブルのフルネーム。
REFRESH_ID
更新の ID。
オプション
例
次の例では、特定の更新に関する情報を取得します。
databricks quality-monitors get-refresh main.my_schema.my_table 12345
databricks quality-monitors list-refreshes
この表の最新の更新 (最大 25 回) の履歴を一覧表示します。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であること
- テーブルの親カタログに
USE_CATALOGがあり、テーブルの親スキーマの所有者であること - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマSELECT権限をテーブルに対して持っていること。
さらに、モニターが作成されたワークスペースから呼び出しを行う必要があります。
databricks quality-monitors list-refreshes TABLE_NAME [flags]
引数
TABLE_NAME
テーブルのフルネーム。
オプション
例
次の例は、品質モニターの更新をリストします。
databricks quality-monitors list-refreshes main.my_schema.my_table
databricks quality-monitors run-refresh
指定したテーブルのモニターでメトリクス 更新をキューに入れます。 更新はバックグラウンドで実行されます。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であること
- テーブルの親カタログに
USE_CATALOGがあり、テーブルの親スキーマの所有者であること - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマ- テーブルの所有者であること
さらに、モニターが作成されたワークスペースから呼び出しを行う必要があります。
databricks quality-monitors run-refresh TABLE_NAME [flags]
引数
TABLE_NAME
テーブルのフルネーム。
オプション
例
次の例では、品質モニターの更新をキューに入れます。
databricks quality-monitors run-refresh main.my_schema.my_table
databricks quality-monitors update
指定したテーブルのモニターを更新します。
発信者は、次のいずれかを行う必要があります。
- テーブルの親カタログの所有者であること
- テーブルの親カタログに
USE_CATALOGがあり、テーブルの親スキーマの所有者であること - 次の権限があります。
USE_CATALOGテーブルの親カタログUSE_SCHEMAテーブルの親スキーマ- テーブルの所有者であること。
さらに、呼び出しはモニターが作成されたワークスペースから行う必要があり、呼び出し元はモニターの元の作成者である必要があります。
出力資産識別子などの特定の構成フィールドは更新できません。
databricks quality-monitors update TABLE_NAME OUTPUT_SCHEMA_NAME [flags]
引数
TABLE_NAME
テーブルのフルネーム。
OUTPUT_SCHEMA_NAME
出力メトリクステーブルが作成されるスキーマ。
オプション
--baseline-table-name string
ドリフトメトリクスがコンピュートされるベースラインテーブルの名前。
--dashboard-id string
コンピュート メトリクスを視覚化するダッシュボードの ID。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、品質モニターを更新します。
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 string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット