external-metadata コマンド グループ

注

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

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

Databricks CLI 内の external-metadata コマンド グループには、Unity カタログ内の外部システムに関するメタデータを登録および管理するためのコマンドが含まれています。

databricks external-metadata create-external-metadata

呼び出し元がメタストア管理者であるか、 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、 MYSQLORACLE、 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 external-metadata delete-external-metadata

指定された名前と一致する外部メタデータ オブジェクトを削除します。 呼び出し元は、メタストア管理者、外部メタデータ オブジェクトの所有者、または MANAGE 特権を持つユーザーである必要があります。

databricks external-metadata delete-external-metadata NAME [flags]

論争

NAME

    削除する外部メタデータ オブジェクトの名前。

オプション

グローバル フラグ

例示

次の例では、外部メタデータ オブジェクトを削除します。

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

メタストア内の指定された外部メタデータ オブジェクトを取得します。 呼び出し元は、メタストア管理者、外部メタデータ オブジェクトの所有者、または BROWSE 権限を持つユーザーである必要があります。

databricks external-metadata get-external-metadata NAME [flags]

論争

NAME

    取得する外部メタデータ オブジェクトの名前。

オプション

グローバル フラグ

例示

次の例では、外部メタデータ オブジェクトを取得します。

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

メタストア内の外部メタデータ オブジェクトを一覧表示します。 呼び出し元がメタストア管理者の場合は、すべての外部メタデータ オブジェクトが取得されます。 それ以外の場合は、呼び出し元が 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 external-metadata update-external-metadata

指定された名前と一致する外部メタデータ オブジェクトを更新します。 呼び出し元は、1 つの要求の所有者または他のメタデータ フィールドのみを更新できます。 呼び出し元は、メタストア管理者、外部メタデータ オブジェクトの所有者、または MODIFY 権限を持つユーザーである必要があります。 呼び出し元が所有者を更新する場合は、 MANAGE 特権も必要です。

databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]

論争

NAME

    外部メタデータ オブジェクトの名前。

UPDATE_MASK

    フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールド パスはリソース オブジェクトに対する相対パスであり、ドット (.) を使用してサブフィールド ( author.given_name など) を移動します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。

    アスタリスク (*) フィールド マスクは、完全な置換を示します。 今後 API が変更されると意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的に一覧表示し、ワイルドカードを使用しないようにすることをお勧めします。

SYSTEM_TYPE

    外部システムの種類。 サポートされている値: AMAZON_REDSHIFT、 AZURE_SYNAPSE、 CONFLUENT、 DATABRICKS、 GOOGLE_BIGQUERY、 KAFKA、 LOOKER、 MICROSOFT_FABRIC、 MICROSOFT_SQL_SERVER、 MONGODB、 MYSQLORACLE、 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 文字列

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