data-quality コマンド グループ

注

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

data-quality 内の コマンド グループには、Unity Catalog オブジェクトのデータ品質を管理するコマンドが含まれています。 データ品質の監視を参照してください。

databricks データ品質の cancel-refresh

データ品質モニターの更新を取り消します。 現在、テーブル object_typeでのみサポートされています。 呼び出しは、モニターが作成された場所と同じワークスペースで行う必要があります。

呼び出し元には、次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログ、テーブルの親スキーマにUSE_SCHEMA、テーブルの MANAGE をUSE_CATALOGします。
databricks data-quality cancel-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]

論争

OBJECT_TYPE

    監視対象オブジェクトの型。 schemaまたはtableのいずれかを指定できます。

OBJECT_ID

    要求オブジェクトの UUID。 スキーマ用に schema_id され、テーブル用に table_id されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idからtable_idを見つけます。 (2) カタログ エクスプローラー で→テーブルを選択→、[テーブル ID] フィールド→ [詳細] タブに移動します。

REFRESH_ID

    更新操作の一意の ID。

オプション

グローバル フラグ

例示

次の例では、更新操作を取り消します。

databricks data-quality cancel-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 refresh-12345

databricks データ品質の create-monitor

Unity Catalog オブジェクトにデータ品質モニターを作成します。 呼び出し元は、スキーマ モニターの anomaly_detection_config またはテーブル モニターの data_profiling_config を指定する必要があります。

テーブル object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログ、テーブルの親スキーマにUSE_SCHEMA、テーブルのをSELECTしてUSE_CATALOGします。
  2. テーブルの親カタログのUSE_CATALOG、テーブルの親スキーマに対する MANAGE とUSE_SCHEMA、テーブルのSELECT。
  3. テーブルの親カタログのUSE_CATALOG、テーブルの親スキーマにUSE_SCHEMAし、テーブルの MANAGE とSELECTを行います。

ダッシュボードなどのワークスペース 資産は、この呼び出しが行われたワークスペースに作成されます。

スキーマ object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. スキーマの親カタログの管理とUSE_CATALOG。
  2. スキーマの親カタログに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 されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idから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

databricks データ品質の create-refresh

更新を作成します。 呼び出しは、モニターが作成された場所と同じワークスペースで行う必要があります。

呼び出し元には、次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログ、テーブルの親スキーマにUSE_SCHEMA、テーブルの MANAGE をUSE_CATALOGします。
databricks data-quality create-refresh OBJECT_TYPE OBJECT_ID [flags]

論争

OBJECT_TYPE

    監視対象オブジェクトの型。 schemaまたはtableのいずれかを指定できます。

OBJECT_ID

    要求オブジェクトの UUID。 スキーマ用に schema_id され、テーブル用に table_id されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idから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 データ品質 delete-monitor

Unity Catalog オブジェクトのデータ品質モニターを削除します。

テーブル object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログ、テーブルの親スキーマにUSE_SCHEMA、テーブルの MANAGE をUSE_CATALOGします。

Important

メトリック テーブルとダッシュボードは、この呼び出しの一部として削除されません。これらの資産は手動でクリーンアップする必要があります (必要な場合)。

スキーマ object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. スキーマの親カタログの管理とUSE_CATALOG。
  2. スキーマの親カタログに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 されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idからtable_idを見つけます。 (2) カタログ エクスプローラー で→テーブルを選択→、[テーブル ID] フィールド→ [詳細] タブに移動します。

オプション

グローバル フラグ

例示

次の例では、データ品質モニターを削除します。

databricks data-quality delete-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890

databricks データ品質 get-monitor

Unity Catalog オブジェクトのデータ品質モニターを読み取ります。

テーブル object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログでUSE_CATALOG、テーブルの親スキーマにUSE_SCHEMAし、テーブルにSELECTします。

スキーマ object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. スキーマの親カタログの管理とUSE_CATALOG。
  2. スキーマの親カタログに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 されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idからtable_idを見つけます。 (2) カタログ エクスプローラー で→テーブルを選択→、[テーブル ID] フィールド→ [詳細] タブに移動します。

オプション

グローバル フラグ

例示

次の例では、データ品質モニターに関する情報を取得します。

databricks data-quality get-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890

databricks データ品質の get-refresh

データ品質モニターの更新情報を取得します。 呼び出しは、モニターが作成された場所と同じワークスペースで行う必要があります。

テーブル object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログでUSE_CATALOG、テーブルの親スキーマにUSE_SCHEMAし、テーブルにSELECTします。

スキーマ object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. スキーマの親カタログの管理とUSE_CATALOG。
  2. スキーマの親カタログに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 されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idからtable_idを見つけます。 (2) カタログ エクスプローラー で→テーブルを選択→、[テーブル ID] フィールド→ [詳細] タブに移動します。

REFRESH_ID

    更新操作の一意の ID。

オプション

グローバル フラグ

例示

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

databricks data-quality get-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 refresh-12345

databricks データ品質リストの更新

データ品質モニターの更新を一覧表示します。 呼び出しは、モニターが作成された場所と同じワークスペースで行う必要があります。

テーブル object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログでUSE_CATALOG、テーブルの親スキーマにUSE_SCHEMAし、テーブルにSELECTします。

スキーマ object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. スキーマの親カタログの管理とUSE_CATALOG。
  2. スキーマの親カタログに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 されます。

    (1) Schemas リソースのschema_idからschema_idを見つけます。 (2) カタログ エクスプローラー でスキーマ→選択→、[スキーマ ID] フィールド→ [詳細] タブに移動します。

    (1) Tables リソースのtable_idから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 データ品質 update-monitor

Unity Catalog オブジェクトのデータ品質モニターを更新します。

テーブル object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. テーブルの親カタログの管理とUSE_CATALOG。
  2. テーブルの親カタログにUSE_CATALOGし、テーブルの親スキーマで MANAGE とUSE_SCHEMAします。
  3. テーブルの親カタログ、テーブルの親スキーマにUSE_SCHEMA、テーブルの MANAGE をUSE_CATALOGします。

スキーマ object_typeの場合、呼び出し元には次のいずれかのアクセス許可セットが必要です。

  1. スキーマの親カタログの管理とUSE_CATALOG。
  2. スキーマの親カタログに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 文字列

    出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では 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