データベースを Unity Catalog に登録する

備考

プレビュー

この機能は、us-east-1、 us-west-2、 eu-west-1、 ap-southeast-1、 ap-southeast-2、 eu-central-1、 us-east-2、 ap-south-1のリージョンでパブリック プレビューとして提供されています。

このページでは、Lakebase データベースを読み取り専用の Unity Catalog カタログとして登録する方法について説明します。これにより、Unity Catalog 特権を使用してデータ アクセスを管理し、マネージド データ同期などの統合を活用できます。

所有権と権限

• データベースが存在 しない場合は 、カタログと一緒に作成できます。この場合、オブジェクトの所有権は これらのガイドラインに従います。
• カタログ作成者は、さらに Unity Catalog メタストアに対する CREATE CATALOG 特権を持っている必要があります。

カタログを作成する

データベースを Unity Catalog に登録するには、Databricks UI、API 呼び出し、Python SDK、または CLI を使用します。

UI

1. ワークスペースのサイドバーで「 コンピュート 」をクリックします。

2. [ データベース インスタンス] タブで、データベース インスタンスを選択します。

3. [ カタログ] タブで、[ カタログの作成 ] をクリックします。

4. 既存のデータベースを Unity Catalog カタログとして登録することも、新しいデータベースを作成することもできます。次のいずれかのオプションを使用します。

   • 既存のデータベースを使用するには、目的の Unity Catalog カタログ名と既存の Postgres データベースの名前を入力します。デフォルトのデータベース databricks_postgres をデータベース名として使用できます。
   • 新しい Postgres データベースと Unity Catalog カタログを同時に作成するには、目的のカタログ名を入力し、 [ 新しいデータベースの作成 ] をオンにします。

5. 作成 をクリックします。

6. 作成後、 カタログ リストでカタログをクリックして、カタログ エクスプローラービューを表示します。

Python SDK

Python

from databricks.sdk import WorkspaceClient
from databricks.sdk.service.database import DatabaseCatalog

# Initialize the Workspace client
w = WorkspaceClient()

# Register an existing database as a UC catalog
catalog = w.database.create_database_catalog(
    DatabaseCatalog(
        name="my_catalog",                    # Name of the UC catalog to create
        database_instance_name="my-instance", # Name of the database instance
        database_name="databricks_postgres",  # Name of the existing Postgres database
    )
)
print(f"Created database catalog: {catalog.name}")

# Create a new database and register it as a UC catalog
catalog = w.database.create_database_catalog(
    DatabaseCatalog(
        name="new_catalog",                   # Name of the UC catalog to create
        database_instance_name="my-instance", # Name of the database instance
        database_name="new_database",         # Name of the Postgres database to register (and optionally create)
        create_database_if_not_exists=True    # Create the database if it doesn't exist
    )
)
print(f"Created new database and catalog: {catalog.name}")

CLI

Bash

# Register an existing database as a UC catalog
databricks database create-database-catalog my_catalog my-instance databricks_postgres

# Create a new database and register it as a UC catalog
databricks database create-database-catalog new_catalog my-instance new_database \
  --create-database-if-not-exists

curl

Bash

export PG_DATABASE_NAME="<name of the PG database to sync to UC>"
export CATLAOG_NAME="<name of UC catalog to create>"

Bash

// Optional
export CREATE_DATABASE_IF_NOT_EXISTS="<whether to create a new database>"

Bash

curl -X POST --header "Authorization: Bearer ${DATABRICKS_TOKEN}" https://$WORKSPACE/api/2.0/database/catalogs \
--data-binary @- << EOF
{
  "name": "$CATALOG_NAME",
  "database_name": "$PG_DATABASE_NAME",
  "instance_name": "$INSTANCE_NAME",
  "create_database_if_not_exists": "$CREATE_DATABASE_IF_NOT_EXISTS" // optional
}

制限

• データベース名には、英数字またはアンダースコアのみを含める必要があります。メモ データベース名にハイフンを含めることはできません。

• データベースに基づいて Unity Catalog で作成されたカタログは読み取り専用です。

• カタログ名は、Unity Catalog セキュリティ保護可能なオブジェクト名の 既存の制約 に従う必要があります。

データベース カタログを使用して Unity Catalog で Postgres オブジェクトを調べる

カタログを表示するには、実行中のサーバレス SQLウェアハウスが接続されていることを確認します。

1. ワークスペースのサイドバーで カタログ をクリックします。
2. カタログ ブラウザでクラスターをクリックし、実行中のサーバレス SQLウェアハウスをコンピュート リソースとして選択します。
3. 開始して閉じる をクリックします。

カタログ、スキーマ、およびテーブルを開くと、同期が自動的にトリガーされます。ただし、UI は Postgres リクエストの数を減らすためにデータをキャッシュする可能性があるため、新しいオブジェクトがすぐに表示されない場合があります。

完全な更新をトリガーするには、[ ] をクリックします。

Unity Catalog でデータベース カタログを削除する

データベース カタログを削除するには、データベース カタログの所有者またはメタストア管理者である必要があります。

Databricks では、最初にデータベース カタログから同期されたすべてのテーブルを削除することをお勧めします。各ソース テーブルは 20 個の同期テーブルの作成にのみ使用でき、データベース カタログが削除された後、同期されたテーブルが Unity Catalog でクリーンアップされるまでに最大 3 日かかる場合があります。Unity Catalog で削除が保留されている同期テーブルは、ソース テーブルあたり 20 個の同期テーブルの制限にカウントされます。

Databricks UI、Python SDK、CLI、または API を使用して、データベース カタログを削除します。

UI

1. ワークスペースのサイドバーで カタログ をクリックします。
2. [ カタログ] ペインから削除するデータベース カタログを選択します。
3. [ ] をクリックし、[ 削除] をクリックします。

Python SDK

Python

from databricks.sdk import WorkspaceClient

# Initialize the Workspace client
w = WorkspaceClient()

# Delete a database catalog
catalog_name = "my_catalog"
w.database.delete_database_catalog(name=catalog_name)
print(f"Deleted database catalog: {catalog_name}")

CLI

Bash

# Delete a database catalog
databricks database delete-database-catalog my_catalog

curl

Bash

curl -X DELETE --header "Authorization: Bearer ${DATABRICKS_TOKEN}" https://$WORKSPACE/api/2.0/database/catalogs/$CATALOG_NAME

カタログを削除した後、Postgres データベースの名前を変更したり、削除したりできます。