database コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のdatabaseコマンド グループには、データベース インスタンスを管理するコマンドが含まれています。データベース・インスタンスは、ストレージおよびコンピュート・リソースを管理し、ユーザーが接続するエンドポイントを提供します。
databricks database create-database-catalog
データベースカタログを作成します。
databricks database create-database-catalog NAME DATABASE_INSTANCE_NAME DATABASE_NAME [flags]
引数
NAME
Unity Catalog のカタログの名前。
DATABASE_INSTANCE_NAME
データベースを格納する DatabaseInstance の名前。
DATABASE_NAME
カタログに関連付けられているデータベース (インスタンス内) の名前。
オプション
--create-database-if-not-exists
データベースが存在しない場合は、データベースを作成します。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、データベース・カタログを作成します。
databricks database create-database-catalog my-catalog my-instance my-database
databricks database create-database-instance
データベースインスタンスを作成します。
databricks database create-database-instance NAME [flags]
引数
NAME
インスタンスの名前。これは、インスタンスの一意の識別子です。
オプション
--capacity string
インスタンスの SKU。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--stopped
インスタンスが停止されているかどうか。
例
次の例では、データベースインスタンスを作成します。
databricks database create-database-instance my-instance --capacity small
databricks database create-database-table
データベース表を作成します。
databricks database create-database-table NAME [flags]
引数
NAME
テーブルの完全な 3 つの部分 (カタログ、スキーマ、テーブル) 名。
オプション
--database-instance-name string
ターゲット・データベース・インスタンスの名前。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--logical-database-name string
このテーブルのターゲット Postgres データベース オブジェクト (論理データベース) 名。
例
次の例では、データベース表を作成します。
databricks database create-database-table catalog.schema.table --database-instance-name my-instance
databricks database create-synced-database-table
同期されたデータベーステーブルを作成します。
databricks database create-synced-database-table NAME [flags]
引数
NAME
テーブルの完全な 3 つの部分 (カタログ、スキーマ、テーブル) 名。
オプション
--database-instance-name string
ターゲット・データベース・インスタンスの名前。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--logical-database-name string
このテーブルのターゲット Postgres データベース オブジェクト (論理データベース) 名。
例
次の例では、同期されたデータベース表を作成します。
databricks database create-synced-database-table catalog.schema.table --database-instance-name my-instance
databricks database delete-database-catalog
データベース・カタログを削除します。
databricks database delete-database-catalog NAME [flags]
引数
NAME
削除するカタログの名前。
オプション
例
次の例では、データベースカタログを削除します。
databricks database delete-database-catalog my-catalog
databricks database 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 database delete-database-table
データベース表を削除します。
databricks database delete-database-table NAME [flags]
引数
NAME
削除するテーブルの完全な 3 つの部分 (カタログ、スキーマ、テーブル) の名前。
オプション
例
次の例では、データベース表を削除します。
databricks database delete-database-table catalog.schema.table
databricks database delete-synced-database-table
同期されたデータベース表を削除します。
databricks database delete-synced-database-table NAME [flags]
引数
NAME
削除する同期されたテーブルの完全な 3 つの部分 (カタログ、スキーマ、テーブル) の名前。
オプション
例
次の例では、同期されたデータベース表を削除します。
databricks database delete-synced-database-table catalog.schema.table
databricks database find-database-instance-by-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 database 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 database get-database-catalog
データベースカタログを取得します。
databricks database get-database-catalog NAME [flags]
引数
NAME
取得するカタログの名前。
オプション
例
次の例では、データベースカタログに関する情報を取得します。
databricks database get-database-catalog my-catalog
databricks database get-database-instance
データベース インスタンスを取得します。
databricks database get-database-instance NAME [flags]
引数
NAME
取得するクラスタリングの名前。
オプション
例
次の例では、データベース・インスタンスに関する情報を取得します。
databricks database get-database-instance my-instance
databricks database get-database-table
データベーステーブルを取得します。
databricks database get-database-table NAME [flags]
引数
NAME
取得するテーブルの完全な 3 つの部分 (カタログ、スキーマ、テーブル) 名。
オプション
例
次の例では、データベース表に関する情報を取得します。
databricks database get-database-table catalog.schema.table
databricks database get-synced-database-table
同期されたデータベーステーブルを取得します。
databricks database get-synced-database-table NAME [flags]
引数
NAME
取得する同期テーブルの完全な 3 つの部分 (カタログ、スキーマ、テーブル) の名前。
オプション
例
次の例では、同期されたデータベース表に関する情報を取得します。
databricks database get-synced-database-table catalog.schema.table
databricks database 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 database 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 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
該当する場合は、使用するバンドル・ターゲット