注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
database 内の コマンド グループには、データベース インスタンスを管理するためのコマンドが含まれています。 データベース インスタンスは、ストレージリソースとコンピューティング リソースを管理し、ユーザーが接続するエンドポイントを提供します。
「データベース インスタンスとは」を参照してください。
databricks データベース create-database-catalog (データベースカタログの作成)
データベース カタログを作成します。
databricks database create-database-catalog NAME DATABASE_INSTANCE_NAME DATABASE_NAME [flags]
論争
NAME
Unity カタログ内のカタログの名前。
DATABASE_INSTANCE_NAME
データベースを格納している DatabaseInstance の名前。
DATABASE_NAME
カタログに関連付けられている (インスタンス内の) データベースの名前。
オプション
--create-database-if-not-exists
データベースが存在しない場合は作成します。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。 JSON リファレンスについては、「 データベース カタログ」を参照してください。
例示
次の例では、データベース カタログを作成します。
databricks database create-database-catalog my-catalog my-instance my-database
databricks データベース create-database-instance
データベース インスタンスを作成します。
注
引数として使用できない入れ子になったフィールドを設定するには、 --json オプションを使用して要求本文全体を指定します。
databricks database create-database-instance NAME [flags]
論争
NAME
インスタンスの名前。 これは、インスタンスの一意の識別子です。
オプション
--capacity string
インスタンスの容量 SKU。 有効な値は、 CU_1、 CU_2、 CU_4、 CU_8です。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。 JSON リファレンスについては、「 データベース インスタンス」を参照してください。
--stopped
インスタンスが停止されているかどうか。
例示
次の例では、データベース インスタンスを作成します。
databricks database create-database-instance my-instance --capacity CU_1
databricks データベース create-database-table
データベース テーブルを作成します。
databricks database create-database-table NAME [flags]
論争
NAME
テーブルのカタログ、スキーマ、テーブルの3部構成の完全な名称。
オプション
--database-instance-name string
ターゲット データベース インスタンスの名前。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。 JSON リファレンスについては、「 データベース テーブル」を参照してください。
--logical-database-name string
このテーブルのターゲット Postgres データベース オブジェクト (論理データベース) 名。
例示
次の例では、データベース テーブルを作成します。
databricks database create-database-table my-catalog.my-schema.my-table --database-instance-name my-instance --logical-database-name dbname
databricks データベース create-synced-database-table
同期されたデータベース テーブルを作成します。
注
引数として使用できない入れ子になったフィールドを設定するには、 --json オプションを使用して要求本文全体を指定します。
databricks database create-synced-database-table NAME [flags]
論争
NAME
テーブルのカタログ、スキーマ、テーブルの3部構成の完全な名称。
オプション
--database-instance-name string
ターゲット データベース インスタンスの名前。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。 JSON リファレンスについては、「 同期されたデータベース テーブル」を参照してください。
--logical-database-name string
このテーブルのターゲット Postgres データベース オブジェクト (論理データベース) 名。
例示
次の例では、同期されたデータベース テーブルを作成します。
databricks database create-synced-database-table --json '{"name": "main.my-schema.my-table", "database_instance_name": "my-instance", "logical_database_name": "testdb", "spec": {"primary_key_columns": ["col1"], "existing_pipeline_id": "999999z9-dz9b-4zf7-c178-15b777772e6z", "scheduling_policy": "SNAPSHOT", "source_table_full_name": "main.my-instance.t"}}'
databricks データベース delete-database-catalog
データベース カタログを削除します。
databricks database delete-database-catalog NAME [flags]
論争
NAME
削除するカタログの名前。
オプション
例示
次の例では、データベース カタログを削除します。
databricks database delete-database-catalog my-catalog
databricks データベース delete-database-instance
データベース インスタンスを削除します。
databricks database delete-database-instance NAME [flags]
論争
NAME
削除するインスタンスの名前。
オプション
--force
既定では、PITR を使用して作成された子孫インスタンスがある場合、インスタンスは削除できません。
--purge
purge=false は開発中です。
例示
次の例では、データベース インスタンスを削除します。
databricks database delete-database-instance my-instance --force
databricks データベース delete-database-table
データベース テーブルを削除します。
databricks database delete-database-table NAME [flags]
論争
NAME
削除するテーブルの完全な 3 部構成 (カタログ、スキーマ、テーブル) 名。
オプション
例示
次の例では、データベース テーブルを削除します。
databricks database delete-database-table catalog.schema.table
databricks データベース delete-synced-database-table
同期されたデータベース テーブルを削除します。
databricks database delete-synced-database-table NAME [flags]
論争
NAME
削除する同期テーブルの完全な 3 部構成 (カタログ、スキーマ、テーブル) 名。
オプション
例示
次の例では、同期されたデータベース テーブルを削除します。
databricks database delete-synced-database-table catalog.schema.table
databricks データベース データベースインスタンスをUIDで検索
uid でデータベース インスタンスを検索します。
databricks database find-database-instance-by-uid [flags]
オプション
--uid string
取得するクラスターの UID。
例示
次の例では、UID によってデータベース インスタンスを検索します。
databricks database find-database-instance-by-uid --uid 12345-abcdef-67890
databricks データベース generate-database-credential
データベース インスタンスへのアクセスに使用できる資格情報を生成します。
databricks database generate-database-credential [flags]
オプション
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--request-id string
資格情報生成の要求 ID。
例示
次の例では、データベース資格情報を生成します。
databricks database generate-database-credential --request-id my-request-123
databricks データベース get-database-catalog
データベース カタログを取得します。
databricks database get-database-catalog NAME [flags]
論争
NAME
取得するカタログの名前。
オプション
例示
次の例では、データベース カタログに関する情報を取得します。
databricks database get-database-catalog my-catalog
databricks データベース get-database-instance
データベース インスタンスを取得します。
databricks database get-database-instance NAME [flags]
論争
NAME
取得するクラスターの名前。
オプション
例示
次の例では、データベース インスタンスに関する情報を取得します。
databricks database get-database-instance my-instance
databricks データベース get-database-table
データベースのテーブルを取得します。
databricks database get-database-table NAME [flags]
論争
NAME
取得するテーブルの完全な 3 部構成 (カタログ、スキーマ、テーブル) 名。
オプション
例示
次の例では、データベース テーブルに関する情報を取得します。
databricks database get-database-table catalog.schema.table
databricks データベース get-synced-database-table
同期されたデータベース テーブルを取得します。
databricks database get-synced-database-table NAME [flags]
論争
NAME
取得する同期テーブルの完全な 3 部構成 (カタログ、スキーマ、テーブル) 名。
オプション
例示
次の例では、同期されたデータベース テーブルに関する情報を取得します。
databricks database get-synced-database-table catalog.schema.table
databricks データベース list-database-instances
データベース インスタンスを一覧表示します。
databricks database list-database-instances [flags]
オプション
--page-size int
返される項目の上限。
--page-token string
データベース インスタンスの次のページに移動する改ページ トークン。
例示
次の例では、すべてのデータベース インスタンスを一覧表示します。
databricks database list-database-instances
次の例では、改ページ位置付きのデータベース インスタンスの一覧を示します。
databricks database list-database-instances --page-size 10
databricks データベース update-database-instance
データベース インスタンスを更新します。
databricks database update-database-instance NAME [flags]
論争
NAME
インスタンスの名前。 これは、インスタンスの一意の識別子です。
オプション
--capacity string
インスタンスの SKU。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--stopped
インスタンスが停止されているかどうか。
例示
次の例では、データベース インスタンスの容量を更新します。
databricks database update-database-instance my-instance --capacity large
次の例では、データベース インスタンスを停止します。
databricks database update-database-instance my-instance --stopped
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット