data-qualityコマンドグループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のdata-qualityコマンド グループにはUnity Catalogオブジェクトのデータ品質を管理するコマンドが含まれています。
データブリックス データ品質 キャンセル 更新
データ品質モニターの更新をキャンセルします。現在、テーブル object_type に対してのみサポートされています。呼び出しは、モニターが作成されたのと同じワークスペースで行う必要があります。
呼び出し元には、次のいずれかの権限セットが必要です。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する MANAGE 。
databricks data-quality cancel-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
REFRESH_ID
更新操作の一意の ID。
オプション
例
次の例では、更新操作をキャンセルします。
databricks data-quality cancel-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 refresh-12345
Databricks データ品質 作成モニター
Unity Catalog オブジェクトにデータ品質モニターを作成します。呼び出し元は、スキーマ モニターの場合はanomaly_detection_config 、テーブル モニターの場合はdata_profiling_configのいずれかを指定する必要があります。
テーブル object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- テーブルの親カタログに対する MANAGE と USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する SELECT 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する MANAGE と USE_SCHEMA 、およびテーブルに対する SELECT 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する MANAGE と SELECT 。
ダッシュボードなどのワークスペース資産は、この呼び出しが行われたワークスペースに作成されます。
スキーマ object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- スキーマの親カタログに対する MANAGE および USE_CATALOG 。
- スキーマの親カタログに対する USE_CATALOG と、スキーマに対する MANAGE および USE_SCHEMA 。
databricks data-quality create-monitor OBJECT_TYPE OBJECT_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
オプション
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
例
次の例では、テーブルのデータ品質モニターを作成します。
databricks data-quality create-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{"data_profiling_config": {"enabled": true}}'
次の例では、JSON ファイルを使用してモニターを作成します。
databricks data-quality create-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json @monitor-config.json
データブリックス データ品質 作成・更新
更新を作成します。 呼び出しは、モニターが作成されたのと同じワークスペースで行う必要があります。
呼び出し元には、次のいずれかの権限セットが必要です。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する MANAGE 。
databricks data-quality create-refresh OBJECT_TYPE OBJECT_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
オプション
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
例
次の例では、テーブル モニターの更新を作成します。
databricks data-quality create-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890
次の例では、 JSONを使用して 更新 を作成します。
databricks data-quality create-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{}'
Databricks データ品質削除モニター
Unity Catalog オブジェクトのデータ品質モニターを削除します。
テーブル object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する MANAGE 。
メトリクス テーブルとダッシュボードはこの呼び出しでは削除されません。これらのアセットは手動でクリーンアップする必要があります (必要な場合)。
スキーマ object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- スキーマの親カタログに対する MANAGE および USE_CATALOG 。
- スキーマの親カタログに対する USE_CATALOG と、スキーマに対する MANAGE および USE_SCHEMA 。
databricks data-quality delete-monitor OBJECT_TYPE OBJECT_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
オプション
例
次の例では、データ品質モニターを削除します。
databricks data-quality delete-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890
データブリックス データ品質 取得モニター
Unity Catalog オブジェクトのデータ品質モニターを読み取ります。
テーブル object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する SELECT 。
スキーマ object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- スキーマの親カタログに対する MANAGE および USE_CATALOG 。
- スキーマの親カタログに対する USE_CATALOG と、スキーマに対する USE_SCHEMA 。
返される情報には、エンティティと親エンティティの構成値と、モニターによって作成されたアセットに関する情報が含まれます。いくつかの情報（例：発信者がモニターが作成されたワークスペースとは異なるワークスペースにいる場合、モニターのダッシュボードなどの他のモニターはフィルター処理されることがあります。
databricks data-quality get-monitor OBJECT_TYPE OBJECT_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
オプション
例
次の例では、データ品質モニターに関する情報を取得します。
databricks data-quality get-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890
データブリックス データ品質 更新の取得
データ品質モニターの更新情報を取得します。呼び出しは、モニターが作成されたのと同じワークスペースで行う必要があります。
テーブル object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する SELECT 。
スキーマ object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- スキーマの親カタログに対する MANAGE および USE_CATALOG 。
- スキーマの親カタログに対する USE_CATALOG と、スキーマに対する USE_SCHEMA 。
databricks data-quality get-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
REFRESH_ID
更新操作の一意の ID。
オプション
例
次の例では、更新に関する情報を取得します。
databricks data-quality get-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 refresh-12345
Databricks データ品質リスト更新
データ品質モニターの更新を一覧表示します。呼び出しは、モニターが作成されたのと同じワークスペースで行う必要があります。
テーブル object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する SELECT 。
スキーマ object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- スキーマの親カタログに対する MANAGE および USE_CATALOG 。
- スキーマの親カタログに対する USE_CATALOG と、スキーマに対する USE_SCHEMA 。
databricks data-quality list-refresh OBJECT_TYPE OBJECT_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
次のいずれかからschema_idを検索します: (1) スキーマリソースのschema_id 。（2）カタログエクスプローラーでスキーマを選択→詳細タブに移動→スキーマIDフィールド。
次のいずれかからtable_idを検索します:(1) テーブルリソースのtable_id 。（2）カタログエクスプローラーでテーブルを選択→詳細タブに移動→テーブルIDフィールド。
オプション
--page-size int
ページごとに返される更新の最大数。
--page-token string
次のページの結果を取得するためのトークン。
例
次の例では、モニターのすべての更新を一覧表示します。
databricks data-quality list-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890
次の例では、ページ区切り付きの更新をリストします。
databricks data-quality list-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --page-size 10
Databricks データ品質更新モニター
Unity Catalog オブジェクトのデータ品質モニターを更新します。
テーブル object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- テーブルの親カタログに対する MANAGE および USE_CATALOG 。
- テーブルの親カタログに対する USE_CATALOG と、テーブルの親スキーマに対する MANAGE および USE_SCHEMA 。
- テーブルの親カタログに対する USE_CATALOG 、テーブルの親スキーマに対する USE_SCHEMA 、およびテーブルに対する MANAGE 。
スキーマ object_type の場合、呼び出し元は次のいずれかの権限セットを持っている必要があります。
- スキーマの親カタログに対する MANAGE および USE_CATALOG 。
- スキーマの親カタログに対する USE_CATALOG と、スキーマに対する MANAGE および USE_SCHEMA 。
databricks data-quality update-monitor OBJECT_TYPE OBJECT_ID UPDATE_MASK OBJECT_TYPE OBJECT_ID [flags]
議論
OBJECT_TYPE
監視対象オブジェクトのタイプ。次のいずれかになります: schemaまたはtable 。
OBJECT_ID
リクエストオブジェクトの UUID。スキーマの場合はschema_id 、テーブルの場合はtable_idです。
UPDATE_MASK
更新するフィールドをコンマ区切りのリストとして指定するフィールド マスク。例の値: data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression 。
オプション
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
例
次の例では、モニターの構成を更新します。
databricks data-quality update-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 "data_profiling_config.schedule.quartz_cron_expression" table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{"data_profiling_config": {"schedule": {"quartz_cron_expression": "0 0 12 * * ?"'
グローバルフラグ
--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
該当する場合、使用するバンドルターゲット