Note
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Important
レイクウォッチは ベータ版です。 ワークスペース管理者は、[ プレビュー] ページからこの機能へのアクセスを制御できます。 ワークスペース レベルのプレビューの管理を参照してください。
Databricks CLI 内の lakewatch コマンドグループには、Lakewatch のデータソース、検出ルール、およびカタログごとの構成を管理するためのコマンドが含まれています。
Lakewatchのドキュメントを参照してください。
lakewatchコマンドグループにはDatabricks CLIバージョン1.25.0以上が必要です。 バージョンを確認するには、 databricks -vを実行します。
DataBricks LakeWatch create-datasource
Important
この機能は ベータ版です。
データソースを作成します。
新しいデータソースを作成します。
databricks lakewatch create-datasource CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE [flags]
Arguments
CATALOG_NAME
データソースを含む Unity カタログの名前。 作成時に必要で、その後に変更することはできません。 読み取りは指定された値を返します。カタログの現在の名前は effective_catalog_nameで報告されます。
SCHEMA_NAME
データソースを含む Unity カタログスキーマの名前。 作成時に必要で、その後に変更することはできません。 読み取りは指定された値を返します。スキーマの現在の名前は effective_schema_nameで報告されます。
DATASOURCE_NAME
Unity カタログ内のデータソースの名前で、そのスキーマ内で一意です。 作成時に必要で、同じカタログとスキーマ内で更新可能です。 Get は、このフィールドを現在の Unity カタログ名と同期します(これも effective_datasource_name で報告されます)。
SCHEDULE
データソースの取り込みジョブが実行されるスケジュール。 データソースは一時停止できないため、 schedule.enabled をfalseに設定するリクエストは拒否されます。 Unity カタログ接続データソースでは連続スケジュールはサポートされていません。
オプション
--compute-mode DatasourceComputeMode
データソースの取り込みジョブの計算モード。 支持する価値観: DS_COMPUTE_PERFORMANCE_OPTIMIZED、 DS_COMPUTE_STANDARD。
--description string
データソースの自由な記述。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
--name string
データソースのリソース名(形式は datasources/{datasource_id})。
--run-as-principal string
データソースが実行されるユーザーまたはサービスプリンシパル(ユーザーメールまたはサービスプリンシパルアプリケーションIDとして指定)。
--warehouse-id string
Lakewatchが作成または更新リクエストの検証(ソースおよび宛先アクセスチェックなど)を実行するチェックを実行するSQLウェアハウスのID。
DataBricks lakeWatch create-rule
Important
この機能は ベータ版です。
規則を作成します。
新しいルールを作成します。
databricks lakewatch create-rule CATALOG_NAME SCHEMA_NAME RULE_NAME SEVERITY FIDELITY SCHEDULE OUTPUT [flags]
Arguments
CATALOG_NAME
ルールを含む Unity カタログの名前。 Required. 作成後に変更することはできません。 読み取りは指定された値を返します。カタログの現在の名前は effective_catalog_nameで報告されます。
SCHEMA_NAME
ルールを含む Unity カタログスキーマの名前。 Required. 作成後に変更することはできません。 読み取りは指定された値を返します。スキーマの現在の名前は effective_schema_nameで報告されます。
RULE_NAME
Unity カタログスキーマ内のルール名。 作成時に必須;同じカタログおよびスキーマ内で更新可能です。 Get は、このフィールドを現在の Unity カタログ名と同期します(これも effective_rule_name で報告されます)。
SEVERITY
情報、中、高、または重大などの自由形式の重大度ラベル。
FIDELITY
このルールの信号品質。 サポートされている値: [FIDELITY_DEVELOPMENT, FIDELITY_HIGH, FIDELITY_INVESTIGATIVE, FIDELITY_MEDIUM]。
SCHEDULE
ルールが実行されるとき。
OUTPUT
各信号で何を記録するか。
オプション
--category string
自由形式ルールカテゴリ。
--content-resource-id string
このルールとしてインストールされた作成済みコンテンツリソースを識別する不変のUUIDv4。
--deduplication RuleDeduplication
信号重複排除モード。 サポートされている値: DEDUPLICATION_DEFAULT、DEDUPLICATION_DISABLED、DEDUPLICATION_ENABLED。
--deduplication-time-window string
重複排除のためのタイムウィンドウ(1時間、24時間、7日、または自動など)。
--description string
自由な形の説明。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
--name string
リソース名( rules/{rule_id} の形式)。
--objective string
このルールが検出する内容の詳細な説明。
--run-as-principal string
このルールのジョブが実行されるIDのプリンシパル(ユーザーメールアドレスまたはサービスプリンシパルアプリケーションIDとして指定)です。
--runbook string
作成済みルールメタデータから引き継がれる詳細な運用ガイダンス。
--suppress-until-time string
設定すると、このルールの信号は指定された時間まで新しいアラートを開きません。
DataBricks LakeWatch Delete-DataSource
Important
この機能は ベータ版です。
データソースを削除します。
リソース名でデータソースを削除します。
databricks lakewatch delete-datasource NAME [flags]
Arguments
NAME
データソースのリソース名(形式は datasources/{datasource_id})。
DataBricks lakewatch delete-rule
Important
この機能は ベータ版です。
規則を削除します。
リソース名でルールを削除します。
databricks lakewatch delete-rule NAME [flags]
Arguments
NAME
削除するルールのリソース名。 形式: rules/{rule_id}。
DataBricks LakeWatch Get-Alert-Config
Important
この機能は ベータ版です。
カタログのアラート設定を取得します。
カタログのアラート配信構成を返します。
databricks lakewatch get-alert-config NAME [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/alertConfig の形式)。
DataBricks LakeWatch get-Common-Config
Important
この機能は ベータ版です。
カタログの共通設定を取得します。
カタログの一般的な Lakewatch 構成を返します。
databricks lakewatch get-common-config NAME [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/commonConfig の形式)。
DataBricks LakeWatch Get-DataSource
Important
この機能は ベータ版です。
データソースを入手しましょう。
単一のデータソースをリソース名で返します。
databricks lakewatch get-datasource NAME [flags]
Arguments
NAME
データソースのリソース名(形式は datasources/{datasource_id})。
DataBricks LakeWatch get-datasource-config
Important
この機能は ベータ版です。
カタログのデータソース設定を取得します。
カタログのデータソース取り込み設定を返します。
databricks lakewatch get-datasource-config NAME [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/datasourceConfig の形式)。
DataBricks LakeWatch get-rule
Important
この機能は ベータ版です。
規則を取得します。
リソース名で単一のルールを返します。
databricks lakewatch get-rule NAME [flags]
Arguments
NAME
検出ルールの完全なリソース名( rules/{rule_id}の形式)。
DataBricks LakeWatch get-rule-config
Important
この機能は ベータ版です。
カタログのルール構成を取得します。
カタログの検出ルール構成を返します。
databricks lakewatch get-rule-config NAME [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/ruleConfig の形式)。
DataBricks lakeWatch List-datasources
Important
この機能は ベータ版です。
データソースを一覧表示する。
Unity カタログ内のデータソースを一覧表示し、必要に応じて1つのスキーマに絞り込むか、名前でフィルタリングします。 結果はページ分けされています。 現在も作成または削除されているデータソースは一覧表示されません。
databricks lakewatch list-datasources CATALOG_NAME [flags]
Arguments
CATALOG_NAME
データソースを一覧表示する Unity カタログ カタログの名前。 必須;各リクエストは単一のカタログのデータソースを一覧表示します。
オプション
--filter string
結果を特定の名前のデータソースに限定するフィルター式(例: datasource_name = "my_source")。
--limit int
返される結果の最大数。
--page-size int
1ページに返せる結果の最大数。
--schema-name string
catalog_name における Unity カタログスキーマの名前。
--view DatasourceView
各データソースで返すフィールドの種類。 支持する価値観: DATASOURCE_VIEW_BASIC、 DATASOURCE_VIEW_FULL。
Databricks lakewatch list-rules
Important
この機能は ベータ版です。
ルールを一覧表示します。
ルールを一覧表示し、オプションでフィルタリングやページ付けが可能です。
databricks lakewatch list-rules CATALOG_NAME [flags]
Arguments
CATALOG_NAME
ルールを一覧表示する Unity カタログの一覧名。 Required.
オプション
--filter string
rule_name = "my_rule" のように、その名前のルールのみを返すように結果を制限するフィルター式を使います。
--limit int
返される結果の最大数。
--page-size int
返すルールの最大数。
--schema-name string
catalog_name における Unity カタログスキーマの名前。
--view RuleView
それぞれのルールをどれくらい返すべきか。 支持する価値観: RULE_VIEW_BASIC、 RULE_VIEW_FULL。
DataBricks LakeWatch update-alert-config
Important
この機能は ベータ版です。
カタログのアラート設定を更新します。
カタログのアラート配信設定を更新します。
databricks lakewatch update-alert-config NAME UPDATE_MASK [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/alertConfig の形式)。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールドパスはリソースオブジェクトに対して相対的であり、サブフィールド(例: author.given_name)を移動するには点(.)を使用します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
*のフィールド マスクは、完全な置換を示します。 更新対象フィールドを明示的にリストし、ワイルドカードの使用は避けること * 推奨されます。なぜなら、将来的にAPIが変更された場合に意図しない結果を招く恐れがあるからです。
オプション
--default-security-alert-collation-window string
シグナルをセキュリティアラートにまとめるためのウィンドウ。
--default-system-alert-collation-window string
SystemEvents をシステムアラートにまとめるためのウィンドウ。
--etag string
Optimistic-concurrency 前提条件:設定してもリソースの現在のetagと一致しない場合、更新は競合として拒否されます(HTTP 409)。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
DataBricks LakeWatch Update-Common-Config
Important
この機能は ベータ版です。
カタログの共通設定を更新します。
カタログの一般的な Lakewatch 設定を更新します。
databricks lakewatch update-common-config NAME UPDATE_MASK [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/commonConfig の形式)。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールドパスはリソースオブジェクトに対して相対的であり、サブフィールド(例: author.given_name)を移動するには点(.)を使用します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
*のフィールド マスクは、完全な置換を示します。 更新対象フィールドを明示的にリストし、ワイルドカードの使用は避けること * 推奨されます。なぜなら、将来的にAPIが変更された場合に意図しない結果を招く恐れがあるからです。
オプション
--custom-content-pack-path string
ユーザー作成のカスタムコンテンツパック(例: /Volumes/{catalog}/{schema}/{volume})を格納する Unity カタログのボリュームパス。 既定値はありません。 未設定の場合、組み込みのコンテンツパックのみが適用されます。
--custom-presets-path string
ユーザー作成のカスタムプリセット(例: /Volumes/{catalog}/{schema}/{volume})を格納する Unity カタログのボリュームパス。 既定値はありません。 未設定の場合、組み込みプリセットのみが適用されます。
--etag string
Optimistic-concurrency 前提条件:設定してもリソースの現在のetagと一致しない場合、更新は競合として拒否されます(HTTP 409)。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
--per-resource-permissions-enabled
ユーザーがフォルダーレベルだけでなく個々のリソースに対して権限を付与できるかどうか。
DataBricks LakeWatch update-datasource
Important
この機能は ベータ版です。
データソースを更新します。
既存のデータソースを更新します。
databricks lakewatch update-datasource NAME UPDATE_MASK CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE [flags]
Arguments
NAME
データソースのリソース名(形式は datasources/{datasource_id})。 データソースの Unity カタログの場所(catalog_name、 schema_name、 datasource_name)とは異なり、Unity カタログでデータソースやそのカタログ、スキーマの名前を変更しても名前は変わりません。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールドパスはリソースオブジェクトに対して相対的であり、サブフィールド(例: author.given_name)を移動するには点(.)を使用します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
*のフィールド マスクは、完全な置換を示します。 更新対象フィールドを明示的にリストし、ワイルドカードの使用は避けること * 推奨されます。なぜなら、将来的にAPIが変更された場合に意図しない結果を招く恐れがあるからです。
CATALOG_NAME
データソースを含む Unity カタログの名前。 作成時に必要で、その後に変更することはできません。 読み取りは指定された値を返します。カタログの現在の名前は effective_catalog_nameで報告されます。
SCHEMA_NAME
データソースを含む Unity カタログスキーマの名前。 作成時に必要で、その後に変更することはできません。 読み取りは指定された値を返します。スキーマの現在の名前は effective_schema_nameで報告されます。
DATASOURCE_NAME
Unity カタログ内のデータソースの名前で、そのスキーマ内で一意です。 作成時に必要で、同じカタログとスキーマ内で更新可能です。 Get は、このフィールドを現在の Unity カタログ名と同期します(これも effective_datasource_name で報告されます)。
SCHEDULE
データソースの取り込みジョブが実行されるスケジュール。 データソースは一時停止できないため、 schedule.enabled をfalseに設定するリクエストは拒否されます。 Unity カタログ接続データソースでは連続スケジュールはサポートされていません。
オプション
--compute-mode DatasourceComputeMode
データソースの取り込みジョブの計算モード。 支持する価値観: DS_COMPUTE_PERFORMANCE_OPTIMIZED、 DS_COMPUTE_STANDARD。
--description string
データソースの自由な記述。
--etag string
Optimistic-concurrency前提条件:リソースの現在のetagと一致しない非空の値に設定された場合、更新は競合として拒否されます(HTTP 409)。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
--name string
データソースのリソース名(形式は datasources/{datasource_id})。
--run-as-principal string
データソースが実行されるユーザーまたはサービスプリンシパル(ユーザーメールまたはサービスプリンシパルアプリケーションIDとして指定)。
--warehouse-id string
Lakewatchが作成または更新リクエストの検証(ソースおよび宛先アクセスチェックなど)を実行するチェックを実行するSQLウェアハウスのID。
DataBricks LakeWatch Update-datasource-config
Important
この機能は ベータ版です。
カタログのデータソース設定を更新します。
カタログのデータソース取り込み設定を更新します。
databricks lakewatch update-datasource-config NAME UPDATE_MASK [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/datasourceConfig の形式)。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールドパスはリソースオブジェクトに対して相対的であり、サブフィールド(例: author.given_name)を移動するには点(.)を使用します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
*のフィールド マスクは、完全な置換を示します。 更新対象フィールドを明示的にリストし、ワイルドカードの使用は避けること * 推奨されます。なぜなら、将来的にAPIが変更された場合に意図しない結果を招く恐れがあるからです。
オプション
--default-compute-mode DatasourceComputeMode
個々のデータソースが取り込みジョブを上書きしない場合に、既定のコンピュートモードが適用されます。 支持する価値観: DS_COMPUTE_PERFORMANCE_OPTIMIZED、 DS_COMPUTE_STANDARD。
--default-folder string
リクエストでスキーマが指定されていない場合に新しいデータソースが配置される登録フォルダー(このカタログ内の)スキーマ名。
--etag string
Optimistic-concurrency 前提条件:設定してもリソースの現在のetagと一致しない場合、更新は競合として拒否されます(HTTP 409)。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
DataBricks LakeWatch update-rule
Important
この機能は ベータ版です。
ルールを更新します。
既存のルールを更新します。
databricks lakewatch update-rule NAME UPDATE_MASK CATALOG_NAME SCHEMA_NAME RULE_NAME SEVERITY FIDELITY SCHEDULE OUTPUT [flags]
Arguments
NAME
リソース名( rules/{rule_id} の形式)。 サーバーが作成時に割り当てます。更新時に必須です。
UPDATE_MASK
更新するフィールドのセット。 マスクで指定されたフィールドのみが変更されます。
CATALOG_NAME
ルールを含む Unity カタログの名前。 Required. 作成後に変更することはできません。 読み取りは指定された値を返します。カタログの現在の名前は effective_catalog_nameで報告されます。
SCHEMA_NAME
ルールを含む Unity カタログスキーマの名前。 Required. 作成後に変更することはできません。 読み取りは指定された値を返します。スキーマの現在の名前は effective_schema_nameで報告されます。
RULE_NAME
Unity カタログスキーマ内のルール名。 作成時に必須;同じカタログおよびスキーマ内で更新可能です。 Get は、このフィールドを現在の Unity カタログ名と同期します(これも effective_rule_name で報告されます)。
SEVERITY
情報、中、高、または重大などの自由形式の重大度ラベル。
FIDELITY
このルールの信号品質。 サポートされている値: [FIDELITY_DEVELOPMENT, FIDELITY_HIGH, FIDELITY_INVESTIGATIVE, FIDELITY_MEDIUM]。
SCHEDULE
ルールが実行されるとき。
OUTPUT
各信号で何を記録するか。
オプション
--category string
自由形式ルールカテゴリ。
--content-resource-id string
このルールとしてインストールされた作成済みコンテンツリソースを識別する不変のUUIDv4。
--deduplication RuleDeduplication
信号重複排除モード。 サポートされている値: DEDUPLICATION_DEFAULT、DEDUPLICATION_DISABLED、DEDUPLICATION_ENABLED。
--deduplication-time-window string
重複排除のためのタイムウィンドウ(1時間、24時間、7日、または自動など)。
--description string
自由な形の説明。
--etag string
最新の読み取りから得たOptimistic-concurrencyトークン。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
--name string
リソース名( rules/{rule_id} の形式)。
--objective string
このルールが検出する内容の詳細な説明。
--run-as-principal string
このルールのジョブが実行されるIDのプリンシパル(ユーザーメールアドレスまたはサービスプリンシパルアプリケーションIDとして指定)です。
--runbook string
作成済みルールメタデータから引き継がれる詳細な運用ガイダンス。
--suppress-until-time string
設定すると、このルールの信号は指定された時間まで新しいアラートを開きません。
DataBricks LakeWatch update-rule-config
Important
この機能は ベータ版です。
カタログのルール設定を更新します。
カタログの検出ルール構成を更新します。
databricks lakewatch update-rule-config NAME UPDATE_MASK [flags]
Arguments
NAME
構成のリソース名( catalogs/{catalog}/ruleConfig の形式)。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールドパスはリソースオブジェクトに対して相対的であり、サブフィールド(例: author.given_name)を移動するには点(.)を使用します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
*のフィールド マスクは、完全な置換を示します。 更新対象フィールドを明示的にリストし、ワイルドカードの使用は避けること * 推奨されます。なぜなら、将来的にAPIが変更された場合に意図しない結果を招く恐れがあるからです。
オプション
--default-folder string
リクエストでスキーマが指定されていない場合に新しいルールが配置される登録済みフォルダー(このカタログ内)のスキーマ名。
--default-signal-collation-window string
ルールが独自の要素を設定しない場合のシグナル重複排除のデフォルト期間で、 5d や 1hなどのコンパクトな日、時、分、秒の構成要素として表記されます。 既定値はありません。 空の値はクリアされます。
--etag string
Optimistic-concurrency 前提条件:設定してもリソースの現在のetagと一致しない場合、更新は競合として拒否されます(HTTP 409)。
--json JSON
インラインJSON文字列かリクエストボディ付き @path/to/file.json のいずれかです。
グローバル フラグ
--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 ストリング
該当する場合は、使用するバンドル ターゲット