schemas コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のschemasコマンド グループには、 Unity Catalogのスキーマを管理するコマンドが含まれています。スキーマは、Unity Catalog の 3 レベル名前空間の 2 番目のレイヤーです。スキーマは、テーブル、ビュー、および関数を整理します。「 Databricks のスキーマとは」を参照してください。
databricks schemas create
メタストアでカタログの新しいスキーマを作成します。呼び出し元は、メタストア管理者であるか、親カタログの CREATE_SCHEMA 特権を持っている必要があります。
databricks schemas create NAME CATALOG_NAME [flags]
引数
NAME
親カタログを基準としたスキーマの名前。
CATALOG_NAME
親カタログの名前。
オプション
--comment string
ユーザー指定の自由形式のテキスト説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--storage-root string
スキーマ内のマネージドテーブルのストレージルートURL。
例
次の例では、main カタログに analytics という名前の新しいスキーマを作成します。
databricks schemas create analytics main
次の例では、コメントを使用して新しいスキーマを作成します。
databricks schemas create analytics main --comment "Schema for analytics data"
databricks schemas delete
指定したスキーマを親カタログから削除します。呼び出し元は、スキーマの所有者または親カタログの所有者である必要があります。
databricks schemas delete FULL_NAME [flags]
引数
FULL_NAME
スキーマのフルネーム。
オプション
--force
スキーマが空でなくても強制的に削除します。
例
次の例では、スキーマを削除します。
databricks schemas delete main.analytics
次の例では、スキーマが空でなくてもスキーマを強制的に削除します。
databricks schemas delete main.analytics --force
databricks schemas get
メタストア内で指定されたスキーマを取得します。呼び出し元は、メタストア管理者、スキーマの所有者、またはスキーマに対する USE_SCHEMA 権限を持つユーザーである必要があります。
databricks schemas get FULL_NAME [flags]
引数
FULL_NAME
スキーマのフルネーム。
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるスキーマを応答に含めるかどうか。
例
次の例では、スキーマに関する情報を取得します。
databricks schemas get main.analytics
次の例では、参照アクセス許可を含むスキーマ情報を取得します。
databricks schemas get main.analytics --include-browse
databricks schemas list
メタストア内のカタログのスキーマを一覧表示します。呼び出し元がメタストア管理者または親カタログの所有者である場合は、カタログのすべてのスキーマが取得されます。それ以外の場合は、呼び出し元が所有する (または呼び出し元が USE_SCHEMA 権限を持っている) スキーマのみが取得されます。配列内の要素の特定の順序を保証するものではありません。
databricks schemas list CATALOG_NAME [flags]
引数
CATALOG_NAME
対象のスキーマの親カタログ。
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるスキーマを応答に含めるかどうか。
--max-results int
返すスキーマの最大数。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
例
次の例は、 main カタログ内のすべてのスキーマをリストします。
databricks schemas list main
次の例は、最大 10 個の結果を持つスキーマをリストします。
databricks schemas list main --max-results 10
次の例は、ページネーションを使用したスキーマの一覧です。
databricks schemas list main --page-token <token>
databricks schemas update
カタログのスキーマを更新します。呼び出し元は、スキーマの所有者またはメタストア管理者である必要があります。呼び出し元がメタストア管理者の場合、更新プログラムで変更できるのは owner フィールドのみです。name フィールドを更新する必要がある場合、呼び出し元はメタストア管理者であるか、親カタログに対するCREATE_SCHEMA特権を持っている必要があります。
databricks schemas update FULL_NAME [flags]
引数
FULL_NAME
スキーマのフルネーム。
オプション
--comment string
ユーザー指定の自由形式のテキスト説明。
--enable-predictive-optimization EnablePredictiveOptimization
このオブジェクトとその下のオブジェクトに対して予測的最適化を有効にする必要があるかどうか。 サポートされている値: [DISABLE, ENABLE, INHERIT]
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--new-name string
スキーマの新しい名前。
--owner string
スキーマの現在の所有者のユーザー名。
例
次の例では、スキーマのコメントを更新します。
databricks schemas update main.analytics --comment "Updated analytics schema"
次の例では、スキーマの所有者を変更します。
databricks schemas update main.analytics --owner someone@example.com
次の例では、スキーマの名前を変更します。
databricks schemas update main.analytics --new-name analytics_v2
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット