catalogs コマンド グループ

注記

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

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

Databricks CLI 内の catalogs コマンド グループを使用すると、Unity Catalog でカタログを管理できます。カタログは、Unity Catalog の 3 レベル名前空間の最初のレイヤーです。これは、データ資産を整理するために使用されます。「 Unity Catalog とは」を参照してください。

databricks catalogs create

呼び出し元がメタストア管理者であるか、 CREATE_CATALOG 権限を持っている場合は、親メタストアに新しいカタログ インスタンスを作成します。

databricks catalogs create NAME [flags]

引数

NAME

カタログ名

オプション

--comment string

ユーザー指定の自由形式テキストの説明

--connection-name string

外部データソースへの接続の名前

--json JSON

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

--provider-name string

デルタ共有プロバイダーの名前

--share-name string

共有プロバイダーの下にある共有の名前

--storage-root string

カタログ内のマネージドテーブルのストレージルートURL

グローバルフラグ

例

次の例では、 salesという名前のカタログを作成します。

Bash

databricks catalogs create sales

次の例では、コメントを含むカタログを作成します。

Bash

databricks catalogs create sales --comment "Sales data catalog"

databricks catalogs delete

指定した名前に一致するカタログを削除します。呼び出し元は、メタストア管理者またはカタログの所有者である必要があります。

databricks catalogs delete NAME [flags]

引数

NAME

カタログの名前

オプション

--force

カタログが空でなくても強制的に削除

グローバルフラグ

例

次の例では、 salesという名前のカタログを削除します。

Bash

databricks catalogs delete sales

次の例では、空でないカタログを強制的に削除します。

Bash

databricks catalogs delete sales --force

databricks catalogs get

メタストアで指定されたカタログを取得します。呼び出し元は、メタストア管理者、カタログの所有者、またはアカウントの USE_CATALOG 権限セットを持つユーザーである必要があります。

databricks catalogs get NAME [flags]

引数

NAME

カタログの名前

オプション

--include-browse

プリンシパルが選択的なメタデータにのみアクセスできるカタログを応答に含めるかどうか

グローバルフラグ

例

次の例では、 salesという名前のカタログに関する情報を取得します。

Bash

databricks catalogs get sales

次の例では、参照専用カタログを含むカタログ情報を取得します。

Bash

databricks catalogs get sales --include-browse

databricks catalogs list

メタストア内のカタログを一覧表示します。呼び出し元がメタストア管理者の場合、すべてのカタログが取得されます。それ以外の場合は、呼び出し元が所有する (または呼び出し元が USE_CATALOG 特権を持っている) カタログのみが取得されます。配列内の要素の特定の順序を保証するものではありません。

databricks catalogs list [flags]

オプション

--include-browse

プリンシパルが選択的なメタデータにのみアクセスできるカタログを応答に含めるかどうか

--max-results int

返却するカタログの最大数

--page-token string

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

グローバルフラグ

例

次の例は、すべてのカタログを一覧表示します。

Bash

databricks catalogs list

次の例は、最大 10 個の結果を持つカタログを一覧表示します。

Bash

databricks catalogs list --max-results 10

次の例は、参照専用カタログを含むカタログをリストします。

Bash

databricks catalogs list --include-browse

databricks catalogs update

指定された名前に一致するカタログを更新します。呼び出し元は、カタログの所有者またはメタストア管理者 (カタログの所有者フィールドを変更する場合) である必要があります。

databricks catalogs update NAME [flags]

引数

NAME

カタログの名前

オプション

--comment string

ユーザー指定の自由形式テキストの説明

--enable-predictive-optimization EnablePredictiveOptimization

このオブジェクトとその下のオブジェクトに対して予測的最適化を有効にする必要があるかどうか。 サポートされている値: DISABLE、 ENABLE、 INHERIT

--isolation-mode CatalogIsolationMode

現在のセキュリティ保護可能オブジェクトにすべてのワークスペースからアクセスできるか、特定のワークスペース セットからアクセスできるか。サポートされている値: ISOLATED、 OPEN

--json JSON

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

--new-name string

カタログの新しい名前

--owner string

カタログの現在の所有者のユーザー名

グローバルフラグ

例

次の例では、カタログのコメントを更新します。

Bash

databricks catalogs update sales --comment "Updated sales data catalog"

次の例では、カタログの名前を変更します。

Bash

databricks catalogs update sales --new-name sales-prod

次の例では、カタログの所有者を変更します。

Bash

databricks catalogs update sales --owner someone@example.com

次の例では、カタログの予測的最適化を有効にします。

Bash

databricks catalogs update sales --enable-predictive-optimization ENABLE

グローバルフラグ

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

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