external-metadataコマンドグループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリック プレビュー段階です。
Databricks CLI使用には、使用状況データ プロビジョニングを含むDatabricksライセンスおよびDatabricksプライバシー通知が適用されます。
Databricks CLI内のexternal-metadataコマンド グループにはUnity Catalog内の外部システムに関するメタデータを登録および管理するためのコマンドが含まれています。
Databricks 外部メタデータ 外部メタデータの作成
呼び出し元がメタストア管理者であるか、 CREATE_EXTERNAL_METADATA 権限を持っている場合は、親メタストアに新しい外部メタデータ オブジェクトを作成します。デフォルトでは、作成時にすべてのアカウント ユーザーに BROWSE 権限を付与します。
databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]
議論
NAME
外部メタデータ オブジェクトの名前。
SYSTEM_TYPE
外部システムのタイプ。サポートされている値: AMAZON_REDSHIFT 、 AZURE_SYNAPSE 、 CONFLUENT 、 DATABRICKS 、 GOOGLE_BIGQUERY 、 KAFKA 、 LOOKER 、 MICROSOFT_FABRIC 、 MICROSOFT_SQL_SERVER 、 MONGODB 、 MYSQL 、 ORACLE 、 OTHER 、 POSTGRESQL 、 POWER_BI 、 SALESFORCE 、 SAP 、 SERVICENOW 、 SNOWFLAKE 、 STREAM_NATIVE 、 TABLEAU 、 TERADATA 、 WORKDAY 。
ENTITY_TYPE
外部システム内のエンティティの種類。
オプション
--description string
ユーザーが提供する自由形式のテキスト説明。
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
--owner string
外部メタデータ オブジェクトの所有者。
--url string
外部メタデータ オブジェクトに関連付けられた URL。
例
次の例では、Snowflake テーブルの外部メタデータ オブジェクトを作成します。
databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"
次の例では、JSON を使用して外部メタデータ オブジェクトを作成します。
databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'
次の例では、JSON ファイルを使用して外部メタデータ オブジェクトを作成します。
databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json
Databricks 外部メタデータ 外部メタデータの削除
指定された名前に一致する外部メタデータ オブジェクトを削除します。呼び出し元は、メタストア管理者、外部メタデータ オブジェクトの所有者、または MANAGE 権限を持つユーザーである必要があります。
databricks external-metadata delete-external-metadata NAME [flags]
議論
NAME
削除する外部メタデータ オブジェクトの名前。
オプション
例
次の例では、外部メタデータ オブジェクトを削除します。
databricks external-metadata delete-external-metadata my_snowflake_table
Databricks 外部メタデータ 外部メタデータの取得
メタストア内の指定された外部メタデータ オブジェクトを取得します。呼び出し元は、メタストア管理者、外部メタデータ オブジェクトの所有者、または BROWSE 権限を持つユーザーである必要があります。
databricks external-metadata get-external-metadata NAME [flags]
議論
NAME
取得する外部メタデータ オブジェクトの名前。
オプション
例
次の例では、外部メタデータ オブジェクトを取得します。
databricks external-metadata get-external-metadata my_snowflake_table
Databricks 外部メタデータ リスト外部メタデータ
メタストア内の外部メタデータ オブジェクトを一覧表示します。呼び出し元がメタストア管理者の場合、すべての外部メタデータ オブジェクトが取得されます。それ以外の場合は、呼び出し元が BROWSE 権限を持つ外部メタデータ オブジェクトのみが取得されます。配列内の要素の特定の順序は保証されません。
databricks external-metadata list-external-metadata [flags]
オプション
--page-size int
ページごとに返される外部メタデータ オブジェクトの最大数。
--page-token string
次のページの結果を取得するためのトークン。
例
次の例では、すべての外部メタデータ オブジェクトを一覧表示します。
databricks external-metadata list-external-metadata
次の例では、ページ区切り付きの外部メタデータ オブジェクトを一覧表示します。
databricks external-metadata list-external-metadata --page-size 10
Databricks 外部メタデータ 外部メタデータの更新
指定された名前に一致する外部メタデータ オブジェクトを更新します。呼び出し元は、1 回のリクエストで所有者またはその他のメタデータ フィールドのいずれかのみを更新できます。呼び出し元は、メタストア管理者、外部メタデータ オブジェクトの所有者、または MODIFY 権限を持つユーザーである必要があります。呼び出し元が所有者を更新する場合は、 MANAGE 権限も必要です。
databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]
議論
NAME
外部メタデータ オブジェクトの名前。
UPDATE_MASK
フィールド マスクは単一の文字列で、複数のフィールドはコンマ (スペースなし) で区切る必要があります。フィールド パスはリソース オブジェクトを基準とし、ドット ( . ) を使用してサブフィールド (例: author.given_name ) を移動します。コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。フィールド名はリソース フィールド名と完全に一致する必要があります。
アスタリスク ( * ) フィールド マスクは完全置換を示します。将来 API が変更された場合に意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的にリストし、ワイルドカードの使用を避けることをお勧めします。
SYSTEM_TYPE
外部システムのタイプ。サポートされている値: AMAZON_REDSHIFT 、 AZURE_SYNAPSE 、 CONFLUENT 、 DATABRICKS 、 GOOGLE_BIGQUERY 、 KAFKA 、 LOOKER 、 MICROSOFT_FABRIC 、 MICROSOFT_SQL_SERVER 、 MONGODB 、 MYSQL 、 ORACLE 、 OTHER 、 POSTGRESQL 、 POWER_BI 、 SALESFORCE 、 SAP 、 SERVICENOW 、 SNOWFLAKE 、 STREAM_NATIVE 、 TABLEAU 、 TERADATA 、 WORKDAY 。
ENTITY_TYPE
外部システム内のエンティティの種類。
オプション
--description string
ユーザーが提供する自由形式のテキスト説明。
--json JSON
インラインJSON文字列またはリクエストボディを含むJSONファイルへの@path
--owner string
外部メタデータ オブジェクトの所有者。
--url string
外部メタデータ オブジェクトに関連付けられた URL。
例
次の例では、外部メタデータ オブジェクトの説明を更新します。
databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"
次の例では、外部メタデータ オブジェクトの所有者を更新します。
databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"
次の例では、JSON を使用して外部メタデータ オブジェクトを更新します。
databricks external-metadata update-external-metadata my_snowflake_table "description,url" SNOWFLAKE TABLE --json '{"description": "Latest sales data", "url": "https://example.snowflakecomputing.com/table/sales_v2"}'
グローバルフラグ
--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
該当する場合、使用するバンドルターゲット