DeltaクライアントからDatabricksテーブルにアクセスする
このページでは、Unity REST API使用して、外部DeltaクライアントからUnity Catalog管理対象および外部テーブルを作成、読み取り、書き込む方法について説明します。 サポートされている統合機能の完全なリストについては、 Unity Catalog統合機能を参照してください。
Unity REST API を使用して作成、読み取り、書き込みを行います。
ベータ版
DeltaクライアントからのUnity Catalogマネージドテーブルの作成と書き込みはベータ版です。
Unity REST API 、外部クライアントがUnity Catalogに登録されているテーブルを作成、読み取り、書き込みアクセスできるようにします。 ワークスペースのURLをエンドポイントとして使用してアクセスを設定します。以下のテーブルタイプが利用可能です。
テーブルタイプ | 読み取り | 書き込み | 作成 |
|---|---|---|---|
Deltaをマネージド | はい | はい* | はい* |
外部Delta | はい | はい | はい |
*カタログコミット付きのマネージドDeltaテーブルでサポートされます。
データ破損やデータ損失といった潜在的な問題を回避するため、Databricksは、S3に保存されている同じDelta Lakeテーブルを、異なるライタークライアントから変更しないことを推奨します。
必要条件
Databricks 、 Unity Catalogの一部として、テーブルへのUnity REST APIアクセスをサポートしています。 これらのエンドポイントを使用するには、ワークスペースでUnity Catalog有効にする必要があります。
Unity REST APIを使用してDeltaクライアントからテーブルへのアクセスを設定するには、以下の設定項目も完了する必要があります。
-
メタストアの 外部データ アクセス を有効にします。 「 メタストアでの外部データ アクセスの有効化」を参照してください。
-
外部からデータにアクセスするプリンシパルに、オブジェクトを含むスキーマに対する
EXTERNAL USE SCHEMA権限を付与します。プリンシパルにUnity Catalog権限を付与するを参照してください。 -
パスでアクセスされる外部テーブルの場合:テーブルパスを含む外部ロケーションに対して、プリンシパルに
EXTERNAL USE LOCATION権限を付与します。プリンシパルにUnity Catalog権限を付与するを参照してください。 -
校長が適切な権限を持っていることを確認してください。
SELECT読み取り用のテーブルMODIFY書き込み用のテーブルCREATEテーブル作成のスキーマについて- 管理対象のDeltaテーブルへの外部書き込みの場合、書き込み先のテーブルでカタログが有効になっていることを確認してください。
-
次のいずれかの方法で認証します。
- Personal アクセス (PAT): 「 Databricksリソースへのアクセスを承認する」を参照してください。
- OAuth マシン間 (M2M) 認証: 長時間実行される Spark ジョブ (1 時間以上) の自動資格情報とトークンの更新をサポートします。「 OAuthを使用したDatabricksへのサービスプリンシパル アクセスの承認」を参照してください。
制限事項
- IcebergCompatV3を使用したUniFormテーブルへの外部アクセスは、現在サポートされていません。UniFormテーブルに外部から書き込んだ後は、Databricksで
MSCK REPAIR TABLE実行してIcebergメタデータを生成する必要があります。 - マネージドテーブルでは、外部クライアントからのスキーマ変更 (例:
ALTER TABLE)、テーブル プロパティの更新、およびテーブル機能の変更は現在サポートされていません。 - 外部クライアントは、管理対象の Delta テーブルに対して、
OPTIMIZE、VACUUM、ANALYZEなどのテーブルメンテナンス操作を実行できません。 - 外部クライアントは浅いクローンを作成することはできません。
- 外部クライアントは、生成列、デフォルト列、または制約列を含むテーブルを作成することはできません。
- 外部テーブルを作成する際は、列定義がApache Sparkと互換性のある形式になっていることを確認するために、DatabricksはApache Sparkを使用することを推奨しています。APIは列指定の正当性を検証しません。仕様がApache Sparkと互換性がない場合、Databricks Runtimeはテーブルを読み取れない可能性があります。
PAT認証を使用してApache SparkでDeltaテーブルにアクセスする
外部SparkクライアントのPAT認証には以下が必要です。
- Unity Catalog Sparkクライアントバージョン0.4.1以上(
io.unitycatalog:unitycatalog-spark) - Apache Spark 4.0以降
- Delta Spark 4.2.0以降
- Unity Catalogにアクセスするプリンシパル用の個人アクセストークン。Databricksリソースへのアクセスを承認する」を参照してください。
Apache SparkでPAT認証を使用してUnity Catalog管理テーブルおよび外部Deltaテーブルへの読み書きを行うには、以下の設定が必要です。
"spark.sql.extensions": "io.delta.sql.DeltaSparkSessionExtension",
"spark.sql.catalog.spark_catalog": "io.unitycatalog.spark.UCSingleCatalog",
"spark.sql.catalog.<uc-catalog-name>": "io.unitycatalog.spark.UCSingleCatalog",
"spark.sql.catalog.<uc-catalog-name>.uri": "<workspace-url>",
"spark.sql.catalog.<uc-catalog-name>.token": "<token>",
"spark.sql.defaultCatalog": "<uc-catalog-name>",
"spark.hadoop.fs.s3.impl": "org.apache.hadoop.fs.s3a.S3AFileSystem",
"spark.jars.packages": "io.delta:delta-spark_4.1_2.13:4.2.0,io.unitycatalog:unitycatalog-spark_2.13:0.4.1,org.apache.hadoop:hadoop-aws:3.4.2"
次の変数を代入します。
-
<uc-catalog-name>: テーブルを含む Unity Catalog のカタログの名前。 -
<token>: 統合を構成するプリンシパル用の個人アクセストークン (PAT)。 -
<workspace-url>: DatabricksワークスペースのURL 。例えば、cust-success.cloud.databricks.com。
上記に表示されているパッケージのバージョンは、このページが最後に更新された時点でのものです。より新しいバージョンが利用可能になっている可能性があります。パッケージのバージョンが、お使いのSparkのバージョンと互換性があることを確認してください。
クラウド オブジェクト ストレージ用に Apache Spark を構成する方法の詳細については、 Unity Catalog OSS ドキュメントを参照してください。
カタログコミットが有効になっているテーブルの読み取り、書き込み、または作成を行うには、Databricks Runtime 16.4以降が必要です。既存のテーブルでカタログコミットを有効または無効にするには、Databricks Runtime 18.0以降が必要です。
カタログコミットを使用してマネージドDeltaテーブルを作成するには、次のSQLを使用します。
CREATE TABLE <uc-catalog-name>.<schema-name>.<table-name> (id INT, desc STRING)
TBLPROPERTIES ('delta.feature.catalogManaged' = 'supported') USING delta;
外部Deltaテーブルを作成するには、次のSQLを使用します。
CREATE TABLE <uc-catalog-name>.<schema-name>.<table-name> (id INT, desc STRING)
USING delta
LOCATION <path>;
OAuth認証を使用してApache SparkでDeltaテーブルにアクセスする
Databricksは、OAuthによるマシン間(M2M)認証もサポートしています。OAuth 、 Unity Catalog認証の認証情報の更新を自動的に処理します。
外部 Spark クライアントの OAuth 認証には次のものが必要です。
- Unity Catalog Sparkクライアントバージョン0.4.1以降(
io.unitycatalog:unitycatalog-spark) - Apache Spark 4.0以降
- Delta Spark 4.2.0以降
- 適切な権限を持つOAuth M2M サービスプリンシパル。 「 OAuthを使用したDatabricksへのサービスプリンシパル アクセスの承認」を参照してください。
OAuth認証を使用してApache SparkでUnity Catalogマネージドテーブルと外部Deltaテーブルを作成、読み取り、または書き込みするには、次の設定が必要です。
"spark.sql.extensions": "io.delta.sql.DeltaSparkSessionExtension",
"spark.sql.catalog.spark_catalog": "io.unitycatalog.spark.UCSingleCatalog",
"spark.sql.catalog.<uc-catalog-name>": "io.unitycatalog.spark.UCSingleCatalog",
"spark.sql.catalog.<uc-catalog-name>.uri": "<workspace-url>",
"spark.sql.catalog.<uc-catalog-name>.auth.type": "oauth",
"spark.sql.catalog.<uc-catalog-name>.auth.oauth.uri": "<oauth-token-endpoint>",
"spark.sql.catalog.<uc-catalog-name>.auth.oauth.clientId": "<oauth-client-id>",
"spark.sql.catalog.<uc-catalog-name>.auth.oauth.clientSecret": "<oauth-client-secret>",
"spark.sql.defaultCatalog": "<uc-catalog-name>",
"spark.hadoop.fs.s3.impl": "org.apache.hadoop.fs.s3a.S3AFileSystem",
"spark.jars.packages": "io.delta:delta-spark_4.1_2.13:4.2.0,io.unitycatalog:unitycatalog-spark_2.13:0.4.1,org.apache.hadoop:hadoop-aws:3.4.2"
次の変数を代入します。
-
<uc-catalog-name>: テーブルを含む Unity Catalog のカタログの名前。 -
<oauth-token-endpoint>: OAuth トークンのエンドポイント URL。この URL を構築するには:- DatabricksワークスペースのURLを探してください。
- 次の形式を使用します:
https://<workspace-url>/oidc/v1/token
-
<oauth-client-id>: サービスプリンシパルのOAuthクライアント ID。 「 OAuthを使用したDatabricksへのサービスプリンシパル アクセスの承認」を参照してください。 -
<oauth-client-secret>: サービスプリンシパルのOAuthクライアント シークレット。 「 OAuthを使用したDatabricksへのサービスプリンシパル アクセスの承認」を参照してください。 -
<workspace-url>: DatabricksワークスペースのURL 。例えば、cust-success.cloud.databricks.com。
上記に表示されているパッケージのバージョンは、このページが最後に更新された時点でのものです。より新しいバージョンが利用可能になっている可能性があります。パッケージのバージョンが、お使いのSparkのバージョンと互換性があることを確認してください。