tables コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のtablesコマンド グループには、Unity Catalogのテーブルを管理するためのコマンドが含まれています。テーブルは、Unity Catalog の 3 レベル名前空間の 3 番目のレイヤーに存在します。テーブルにはデータの行が含まれています。
Databricksテーブルの作成
指定されたカタログとスキーマに新しいテーブルを作成します。
このAPIは 外部Deltaテーブルの 作成のみをサポートしています。TABLE_TYPE=EXTERNALとDATA_SOURCE_FORMAT=DELTAのみがサポートされています。このAPIを使用してテーブルを作成する場合、列マスクはサポートされていません。
外部Deltaテーブルを作成するには、呼び出し元は標準のUSE_CATALOG 、 CREATE_TABLE 、 USE_SCHEMA 、およびCREATE_EXTERNAL_TABLE権限に加えて、親スキーマに対するEXTERNAL_USE_SCHEMAと外部ロケーションに対するEXTERNAL_USE_LOCATIONを持っている必要があります。 columnsフィールドは Spark 互換フォーマットである必要があります。
databricks tables create NAME CATALOG_NAME SCHEMA_NAME TABLE_TYPE DATA_SOURCE_FORMAT STORAGE_LOCATION [flags]
引数
NAME
親スキーマからの相対パスで表したテーブル名。
CATALOG_NAME
親カタログの名前。
SCHEMA_NAME
親スキーマの名前（親カタログからの相対パス）。
TABLE_TYPE
テーブルの種類。サポートされている値: EXTERNAL 、 EXTERNAL_SHALLOW_CLONE 、 FOREIGN 、 MANAGED 、 MANAGED_SHALLOW_CLONE 、 MATERIALIZED_VIEW 、 METRIC_VIEW 、 STREAMING_TABLE 、 VIEW 。
DATA_SOURCE_FORMAT
テーブルのデータソース形式。サポートされている値: AVRO 、 CSV 、 DELTA 、 DELTASHARING 、 HIVE 、 ICEBERG 、 JSON 、 ORC 、 PARQUET 、 TEXT 、その他。
STORAGE_LOCATION
テーブルのストレージルートURL（ MANAGEDおよびEXTERNALテーブルに必須）。
オプション
--json JSON
インラインJSON構文、またはリクエストボディを含むJSONファイルへの@path。
例
次の例では、外部のDeltaテーブルを作成します。
databricks tables create my_table my_catalog my_schema EXTERNAL DELTA s3://my-bucket/my-table
databricks tables delete
指定した親カタログとスキーマからテーブルを削除します。呼び出し元は、親カタログの所有者であり、親カタログに対する USE_CATALOG 特権を持ち、親スキーマの所有者であるか、または表の所有者であり、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks tables delete FULL_NAME [flags]
引数
FULL_NAME
テーブルのフルネーム。
オプション
例
次の例では、テーブルを削除します。
databricks tables delete my_catalog.my_schema.my_table
databricks tables exists
特定のカタログとスキーマのメタストアにテーブルが存在するかどうかを取得します。呼び出し元は、次のいずれかの要件を満たす必要があります。
- メタストア管理者になる
- 親カタログの所有者であること
- 親スキーマの所有者であり、親カタログに対する
USE_CATALOG権限を持っている - 親カタログに対する
USE_CATALOG権限と親スキーマに対するUSE_SCHEMA権限を持ち、テーブル所有者またはテーブルに対するSELECT権限のいずれかを持っている。 - 親カタログに対する
BROWSE特権を持つ - 親スキーマに対する
BROWSE特権を持っている。
databricks tables exists FULL_NAME [flags]
引数
FULL_NAME
テーブルのフルネーム。
オプション
例
次の例では、テーブルが存在するかどうかを確認します。
databricks tables exists my_catalog.my_schema.my_table
databricks tables get
特定のカタログとスキーマのテーブルをメタストアから取得します。呼び出し元は、次のいずれかの要件を満たす必要があります。
- メタストア管理者になる
- 親カタログの所有者であること
- 親スキーマの所有者であり、親カタログに対する
USE_CATALOG権限を持っている - 親カタログに対する
USE_CATALOG権限と親スキーマに対するUSE_SCHEMA権限を持ち、テーブル所有者またはテーブルに対するSELECT権限のいずれかを持っている。
databricks tables get FULL_NAME [flags]
引数
FULL_NAME
テーブルのフルネーム。
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるテーブルを応答に含めるかどうか。
--include-delta-metadata
デルタ メタデータを応答に含める必要があるかどうか。
--include-manifest-capabilities
テーブルに持つ機能を含むマニフェストを含めるかどうか。
例
次の例では、テーブルに関する情報を取得します。
databricks tables get my_catalog.my_schema.my_table
次の例では、差分メタデータを含むテーブルを取得します。
databricks tables get my_catalog.my_schema.my_table --include-delta-metadata
databricks tables list
親カタログとスキーマの下にある現在のメタストアのすべてのテーブルを一覧表示します。呼び出し元は、メタストア管理者、またはテーブルの所有者 (またはテーブルに対する SELECT 特権を持っている) である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。配列内の要素の特定の順序を保証するものではありません。
databricks tables list CATALOG_NAME SCHEMA_NAME [flags]
引数
CATALOG_NAME
対象テーブルの親カタログの名前。
SCHEMA_NAME
テーブルの親スキーマ。
オプション
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるテーブルを応答に含めるかどうか。
--include-delta-metadata
デルタ メタデータを応答に含める必要があるかどうか。
--include-manifest-capabilities
テーブルに持つ機能を含むマニフェストを含めるかどうか。
--max-results int
返すテーブルの最大数。
--omit-columns
応答からテーブルの列を省略するかどうか。
--omit-properties
応答からテーブルのプロパティを省略するかどうか。
--omit-username
テーブルのユーザー名を省略するかどうか (例:
--page-token string
結果の次のページ(ページネーション)に送信する不透明なトークン。
例
次の例は、カタログとスキーマ内のすべてのテーブルをリストします。
databricks tables list my_catalog my_schema
次の例は、列が省略されたテーブルを一覧表示します。
databricks tables list my_catalog my_schema --omit-columns
databricks tables list-summaries
メタストア内のスキーマとカタログのテーブルの概要を一覧表示します。返されるテーブルの概要は次のとおりです。
- テーブルの概要 (現在のメタストアと親のカタログとスキーマ内)、ユーザーがメタストア管理者の場合、
- または、ユーザーがテーブルに対する所有権または
SELECT特権、およびスキーマに対する所有権またはUSE_SCHEMA特権を持っているテーブルとスキーマ(現在のメタストアおよび親カタログ内)の概要(ユーザーが親カタログに対する所有権またはUSE_CATALOG特権も持っている場合)。
配列内の要素の特定の順序を保証するものではありません。
databricks tables list-summaries CATALOG_NAME [flags]
引数
CATALOG_NAME
対象テーブルの親カタログの名前。
オプション
--include-manifest-capabilities
テーブルに持つ機能を含むマニフェストを含めるかどうか。
--max-results int
テーブルが返す集計の最大数。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
--schema-name-pattern string
スキーマ名の SQL LIKE パターン (% と _)。
--table-name-pattern string
テーブル名の sql LIKE パターン (% と _)。
例
次の例は、カタログのテーブルの概要をリストします。
databricks tables list-summaries my_catalog
次の例は、スキーマ名パターンのテーブルの概要をリストします。
databricks tables list-summaries my_catalog --schema-name-pattern "prod_%"
次の例は、テーブル名パターンのテーブルサマリーをリストします。
databricks tables list-summaries my_catalog --table-name-pattern "fact_%"
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット