注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の external-lineage コマンド グループには、Databricks オブジェクトと外部システム間の系列関係を定義および管理するためのコマンドが含まれています。
databricks external-lineage create-external-lineage-relationship
Databricks または外部メタデータ オブジェクトと別の外部メタデータ オブジェクトの間に外部系列リレーションシップを作成します。
databricks external-lineage create-external-lineage-relationship SOURCE TARGET [flags]
論争
SOURCE
外部系列リレーションシップのソース オブジェクト。
TARGET
外部系列リレーションシップのターゲット オブジェクト。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
例示
次の例では、JSON を使用して外部系列リレーションシップを作成します。
databricks external-lineage create-external-lineage-relationship source_object target_object --json '{"column_mappings": [{"source_column": "id", "target_column": "external_id"}]}'
次の例では、JSON ファイルを使用して外部系列リレーションシップを作成します。
databricks external-lineage create-external-lineage-relationship source_object target_object --json @lineage.json
databricks external-lineage delete-external-lineage-relationship
Databricks または外部メタデータ オブジェクトと別の外部メタデータ オブジェクトの間の外部系列リレーションシップを削除します。
databricks external-lineage delete-external-lineage-relationship [flags]
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
例示
次の例では、JSON を使用して外部系列リレーションシップを削除します。
databricks external-lineage delete-external-lineage-relationship --json '{"source": "source_object", "target": "target_object"}'
次の例では、JSON ファイルを使用して外部系列リレーションシップを削除します。
databricks external-lineage delete-external-lineage-relationship --json @delete-lineage.json
databricks external-lineage list-external-lineage-relationships
指定された方向を指定して、Databricks オブジェクトまたは外部メタデータの外部系列リレーションシップを一覧表示します。
databricks external-lineage list-external-lineage-relationships [flags]
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
--page-size int
ページごとに返される外部系列リレーションシップの最大数。
--page-token string
結果の次のページを取得するトークン。
例示
次の例では、JSON を使用した外部系列リレーションシップの一覧を示します。
databricks external-lineage list-external-lineage-relationships --json '{"object": "my_catalog.my_schema.my_table", "direction": "DOWNSTREAM"}'
次の例では、改ページ位置を持つ外部系列リレーションシップの一覧を示します。
databricks external-lineage list-external-lineage-relationships --json '{"object": "my_catalog.my_schema.my_table", "direction": "UPSTREAM"}' --page-size 10
次の例では、JSON ファイルを使用した外部系列リレーションシップの一覧を示します。
databricks external-lineage list-external-lineage-relationships --json @list-lineage.json
databricks external-lineage update-external-lineage-relationship
Databricks または外部メタデータ オブジェクトと別の外部メタデータ オブジェクトの間の外部系列リレーションシップを更新します。
databricks external-lineage update-external-lineage-relationship UPDATE_MASK SOURCE TARGET [flags]
論争
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールド パスはリソース オブジェクトに対する相対パスであり、ドット (.) を使用してサブフィールド ( author.given_name など) を移動します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
アスタリスク (*) フィールド マスクは、完全な置換を示します。 今後 API が変更されると意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的に一覧表示し、ワイルドカードを使用しないようにすることをお勧めします。
SOURCE
外部系列リレーションシップのソース オブジェクト。
TARGET
外部系列リレーションシップのターゲット オブジェクト。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
例示
次の例では、JSON を使用して外部系列リレーションシップを更新します。
databricks external-lineage update-external-lineage-relationship "column_mappings" source_object target_object --json '{"column_mappings": [{"source_column": "updated_id", "target_column": "new_external_id"}]}'
次の例では、JSON ファイルを使用して外部系列リレーションシップを更新します。
databricks external-lineage update-external-lineage-relationship "column_mappings" source_object target_object --json @update-lineage.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 文字列
該当する場合は、使用するバンドル ターゲット