Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
catalogs 内の コマンド グループを使用すると、Unity カタログでカタログを管理できます。 カタログは、Unity カタログの 3 レベル名前空間の最初のレイヤーです。 これは、データ資産を整理するために使用されます。 「Unity Catalog とは」を参照してください。
databricks カタログを作成する
呼び出し元がメタストア管理者であるか、 CREATE_CATALOG 特権を持っている場合は、親メタストアに新しいカタログ インスタンスを作成します。
databricks catalogs create NAME [flags]
Arguments
NAME
カタログの名前
オプション
--comment string
ユーザー指定の自由形式のテキストの説明
--connection-name string
外部データ ソースへの接続の名前
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
--provider-name string
デルタ共有プロバイダーの名前
--share-name string
共有プロバイダーに属する共有の名前
--storage-root string
カタログ内のマネージド テーブルのストレージ ルート URL
Examples
次の例では、 salesという名前のカタログを作成します。
databricks catalogs create sales
次の例では、コメントを含むカタログを作成します。
databricks catalogs create sales --comment "Sales data catalog"
databricks カタログを削除
指定された名前と一致するカタログを削除します。 呼び出し元は、メタストア管理者またはカタログの所有者である必要があります。
databricks catalogs delete NAME [flags]
Arguments
NAME
カタログの名前
オプション
--force
カタログが空でない場合でも強制的に削除する
Examples
次の例では、 salesという名前のカタログを削除します。
databricks catalogs delete sales
次の例では、空でないカタログが強制的に削除されます。
databricks catalogs delete sales --force
Databricks カタログを取得する
メタストア内の指定されたカタログを取得します。 呼び出し元は、メタストア管理者、カタログの所有者、またはアカウントの USE_CATALOG 特権が設定されているユーザーである必要があります。
databricks catalogs get NAME [flags]
Arguments
NAME
カタログの名前
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできる応答にカタログを含めるかどうか
Examples
次の例では、 salesという名前のカタログに関する情報を取得します。
databricks catalogs get sales
次の例では、参照専用カタログを含むカタログ情報を取得します。
databricks catalogs get sales --include-browse
databricks カタログの一覧
メタストア内のカタログを一覧表示します。 呼び出し元がメタストア管理者の場合、すべてのカタログが取得されます。 それ以外の場合は、呼び出し元が所有するカタログ (または呼び出し元が USE_CATALOG 特権を持つカタログ) のみが取得されます。 配列内の要素の特定の順序は保証されません。
databricks catalogs list [flags]
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできる応答にカタログを含めるかどうか
--max-results int
返されるカタログの最大数
--page-token string
前のクエリに基づいて次のページに移動する不透明な改ページ トークン
Examples
次の例では、すべてのカタログを一覧表示します。
databricks catalogs list
次の例では、最大 10 件の結果を含むカタログを一覧表示します。
databricks catalogs list --max-results 10
次の例では、参照専用カタログを含むカタログを一覧表示します。
databricks catalogs list --include-browse
databricks カタログ更新
指定した名前と一致するカタログを更新します。 呼び出し元は、カタログの所有者であるか、メタストア管理者である必要があります (カタログの所有者フィールドを変更する場合)。
databricks catalogs update NAME [flags]
Arguments
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
カタログの現在の所有者のユーザー名
Examples
次の例では、カタログのコメントを更新します。
databricks catalogs update sales --comment "Updated sales data catalog"
次の例では、カタログの名前を変更します。
databricks catalogs update sales --new-name sales-prod
次の例では、カタログの所有者を変更します。
databricks catalogs update sales --owner someone@example.com
次の例では、カタログの予測最適化を有効にします。
databricks catalogs update sales --enable-predictive-optimization ENABLE
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット