メインコンテンツまでスキップ

metastores コマンド グループ

注記

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

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI 内の metastores コマンド グループを使用すると、メタストアを管理できます。メタストアは、Unity Catalog 内のオブジェクトの最上位のコンテナーです。データ資産 (テーブルとビュー) と、それらへのアクセスを管理する権限が格納されます。「 メタストア」を参照してください。

databricks metastores assign

新しいメタストアの割り当てを作成します。同じ workspace_id の割り当てが存在する場合は、新しい metastore_iddefault_catalog_nameによって上書きされます。発信者はアカウント管理者である必要があります。

databricks metastores assign WORKSPACE_ID METASTORE_ID DEFAULT_CATALOG_NAME [flags]

引数

WORKSPACE_ID

ワークスペース ID。

METASTORE_ID

メタストアの一意の ID。

DEFAULT_CATALOG_NAME

廃止。「デフォルト Namespace API」を使用して、 Databricks ワークスペースのデフォルトカタログを設定します。 メタストア内の Default カタログの名前。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

次の例では、メタストアをワークスペースに割り当てます。

Bash
databricks metastores assign 123456789 abc123-def456-ghi789 main

databricks metastores create

指定された名前とオプションのストレージ ルート パスに基づいて新しいメタストアを作成します。デフォルトでは (owner フィールドが設定されていない場合)、新しいメタストアの所有者は、createMetastore API を呼び出すユーザーです。所有者フィールドが空の文字列 (""に設定されている場合、所有権は代わりにシステム ユーザーに割り当てられます。

databricks metastores create NAME [flags]

引数

NAME

メタストアのユーザー指定の名前。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--region string

メタストアがサービスを提供するクラウドリージョン(us-west-2、westusなど)。

--storage-root string

メタストアのストレージ ルート URL。

グローバルフラグ

次の例では、名前とストレージ ルートを持つメタストアを作成します。

Bash
databricks metastores create my-metastore --storage-root s3://my-bucket/metastore-root --region us-west-2

databricks metastores current

アクセスするワークスペースのメタストア割り当てを取得します。

databricks metastores current [flags]

オプション

グローバルフラグ

次の例では、現在のメタストアの割り当てを取得します。

Bash
databricks metastores current

databricks metastores delete

メタストアを削除します。呼び出し元はメタストア管理者である必要があります。

databricks metastores delete ID [flags]

引数

ID

メタストアの一意の ID。

オプション

--force

メタストアが空でなくても強制的に削除します。

グローバルフラグ

次の例では、メタストアを削除します。

Bash
databricks metastores delete abc123-def456-ghi789

次の例では、メタストアが空でなくても、メタストアを強制的に削除します。

Bash
databricks metastores delete abc123-def456-ghi789 --force

databricks metastores get

指定された ID に一致するメタストアを取得します。この情報を取得するには、呼び出し元がメタストア管理者である必要があります。

databricks metastores get ID [flags]

引数

ID

メタストアの一意の ID。

オプション

グローバルフラグ

次の例では、特定のメタストアに関する情報を取得します。

Bash
databricks metastores get abc123-def456-ghi789

databricks metastores list

使用可能なメタストアを一覧表示します。この情報を取得するには、発信者が管理者である必要があります。リスト内の項目の特定の順序を保証するものではありません。

databricks metastores list [flags]

オプション

--max-results int

返すメタストアの最大数。

--page-token string

前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。

グローバルフラグ

次の例は、使用可能なすべてのメタストアの一覧です。

Bash
databricks metastores list

次の例は、ページネーションを使用したメタストアの一覧です。

Bash
databricks metastores list --max-results 10 --page-token abc123token

databricks metastores summary

メタストアに関する概要情報を取得します。この概要には、ストレージ資格情報、クラウド ベンダー、クラウド リージョン、およびグローバル メタストア ID が含まれます。

databricks metastores summary [flags]

オプション

グローバルフラグ

次の例では、メタストアの概要を取得します。

Bash
databricks metastores summary

databricks metastores unassign

メタストアの割り当てを削除します。発信者はアカウント管理者である必要があります。

databricks metastores unassign WORKSPACE_ID METASTORE_ID [flags]

引数

WORKSPACE_ID

ワークスペース ID。

METASTORE_ID

削除するメタストアの ID を照会します。

オプション

グローバルフラグ

次の例では、ワークスペースからメタストアの割り当てを解除します。

Bash
databricks metastores unassign 123456789 abc123-def456-ghi789

databricks metastores update

特定のメタストアの情報を更新します。呼び出し元はメタストア管理者である必要があります。所有者フィールドが空の文字列 (""に設定されている場合、所有権はシステム・ユーザーに更新されます。

databricks metastores update ID [flags]

引数

ID

メタストアの一意の ID。

オプション

--delta-sharing-organization-name string

Databricks-to-Databricks Delta Sharingで正式名称として使用されるDelta Sharingエンティティの組織名。

--delta-sharing-recipient-token-lifetime-in-seconds int

差分共有受信者トークンの有効期間 (秒単位)。

--delta-sharing-scope DeltaSharingScopeEnum

メタストアに対して有効になっている Delta Sharing のスコープ。サポートされている値: INTERNALINTERNAL_AND_EXTERNAL

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--new-name string

メタストアの新しい名前。

--owner string

メタストアの所有者。

--privilege-model-version string

metastore の特権モデル バージョン (major.minor 形式 (例: 1.0)。

--storage-root-credential-id string

メタストアstorage_rootにアクセスするためのストレージ資格情報の UUID。

グローバルフラグ

次の例では、メタストア名を更新します。

Bash
databricks metastores update abc123-def456-ghi789 --new-name my-updated-metastore

次の例では、Delta Sharing 構成を使用してメタストアを更新します。

Bash
databricks metastores update abc123-def456-ghi789 --delta-sharing-scope INTERNAL_AND_EXTERNAL --delta-sharing-organization-name my-org

databricks metastores update-assignment

メタストアの割り当てを更新します。この操作は、ワークスペースにメタストアが既に割り当てられている場合、指定したワークスペースの metastore_id または default_catalog_name を更新するために使用できます。発信者は、 metastore_idを更新するにはアカウント管理者である必要があります。それ以外の場合、発信者はワークスペース管理者になる可能性があります。

databricks metastores update-assignment WORKSPACE_ID [flags]

引数

WORKSPACE_ID

ワークスペース ID。

オプション

--default-catalog-name string

メタストア内の Default カタログの名前。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--metastore-id string

メタストアの一意の ID。

グローバルフラグ

次の例では、メタストア割り当てのデフォルト カタログを更新します。

Bash
databricks metastores update-assignment 123456789 --default-catalog-name new-default-catalog

次の例では、メタストア割り当てのメタストア ID を更新します。

Bash
databricks metastores update-assignment 123456789 --metastore-id new-metastore-id

グローバルフラグ

--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

進行状況ログを表示する形式: defaultappendinplacejson

-t, --target string

該当する場合は、使用するバンドル・ターゲット