Unity Catalog CLI (レガシ)

[アーティクル]
08/06/2024

重要

このドキュメントは廃止され、更新されない可能性があります。

この情報は、レガシ Databricks CLI バージョン 0.18 以前に適用されます。 Databricks では、代わりにバージョン 0.205 以降の新しい Databricks CLI を使うことをお勧めします。「Databricks CLI について」を参照してください。お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行する場合は、「Databricks CLI の移行」を参照してください。

Note

Unity Catalog CLI は試験段階です。

Unity Catalog CLI には、認証が設定された Databricks CLI (レガシ) 0.17.0 以降が必要です。 Databricks CLI を更新する方法、またはインストールされているバージョンを一覧表示する方法については、「CLI を更新する」を参照してください。

次の各例のオプションとフィールドサンプルの値は、例示のみを目的としています。

Unity Catalog CLI を使用して、次の操作を行います。

メタストア、ストレージの資格情報、外部の場所、カタログ、スキーマ、テーブルなどの Unity Catalog リソース。
共有、受信者、プロバイダーなどの Delta Sharing リソース。

Unity Catalog CLI サブコマンドを実行するには、databricks unity-catalog に追加します。これらのサブコマンドは、Delta Sharing API も含む Unity Catalog API を呼び出します。

使用に関するドキュメントを表示するには、databricks unity-catalog --help を実行します。

出力:

Usage: databricks unity-catalog [OPTIONS] COMMAND [ARGS]...

  Utility to interact with Databricks Unity Catalog.

Options:
  -v, --version  0.17.1
  -h, --help     Show this message and exit.

Commands:
  catalogs
  external-locations
  lineage
  metastores
  permissions
  providers
  recipients
  schemas
  shares
  storage-credentials
  tables

metastore

メタストアを操作するには、unity-catalog metastores サブコマンドを使用します。

使用に関するドキュメントを表示するには、databricks unity-catalog metastores --help を実行します。

メタストアの作成
メタストアをワークスペースにリンクする
メタストアの設定を更新する
使用可能なメタストアを一覧表示する
メタストアに関する情報を取得する
現在のメタストアに関する概要情報を取得する
ワークスペースの現在のメタストア割り当てを取得する
メタストアをワークスペースからリンク解除する
メタストアを削除する

メタストアの作成

使用に関するドキュメントを表示するには、databricks unity-catalog metastores create --help を実行します。「Unity Catalog メタストアを作成する」も参照してください。

注意

メタストアを作成しても、そのメタストアはワークスペースやストレージの資格情報に自動的に関連付けられません。このタスクを実行する場合は、「メタストアをワークスペースにリンクする」、「ストレージの資格情報を作成する」、「メタストアの設定を更新する」を参照してください。

メタストアをワークスペースにリンクする

メタストアが既に割り当てられているワークスペースでこのコマンドを実行すると、そのワークスペースに割り当てられたメタストアが更新されます。

使用に関するドキュメントを表示するには、databricks unity-catalog metastores assign --help を実行します。

databricks unity-catalog metastores assign --workspace-id 1234567890123456 \
                                           --metastore-id 12a345b6-7890-1cd2-3456-e789f0a12b34 \
                                           --default-catalog-name main

ワークスペース ID の取得方法については、「ワークスペースのインスタンス名、URL、および ID」を参照してください。

メタストア ID を取得するには、databricks unity-catalog metastores get-summary を実行します。例については、「現在のメタストアに関する概要情報を取得する」参照してください。

出力:

{}

「Unity Catalog メタストアを作成する」も参照してください。

メタストアの設定を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog metastores update --help を実行します。

databricks unity-catalog metastores update --id 12a345b6-7890-1cd2-3456-e789f0a12b34 \
                                           --json-file update-metastore.json

update-metastore.json:

{
  "storage_root_credential_id": "12a345b6-7890-1cd2-3456-e789f0a12b34"
}

ストレージルート資格情報 ID の取得方法については、「ストレージの資格情報に関する情報を取得する」を参照してください。

使用可能なメタストアを一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog metastores list --help を実行します。

databricks unity-catalog metastores list

メタストアに関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog metastores get --help を実行します。

databricks unity-catalog metastores get --id 12a345b6-7890-1cd2-3456-e789f0a12b34

現在のメタストアに関する概要情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog metastores get-summary --help を実行します。

databricks unity-catalog metastores get-summary

ワークスペースの現在のメタストア割り当てを取得する

使用に関するドキュメントを表示するには、databricks unity-catalog metastores get-assignment --help を実行します。

databricks unity-catalog metastores get-assignment

出力:

{
  "workspace_id": 1234567890123456,
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "default_catalog_name": "main"
}

メタストアをワークスペースからリンク解除する

使用に関するドキュメントを表示するには、databricks unity-catalog metastores unassign --help を実行します。

databricks unity-catalog metastores unassign --workspace-id 1234567890123456 \
                                             --metastore-id 12a345b6-7890-1cd2-3456-e789f0a12b34

ワークスペース ID の取得方法については、「ワークスペースのインスタンス名、URL、および ID」を参照してください。

出力:

{}

メタストアを削除する

警告

メタストアを削除する前に、メタストアが使用されているすべてのワークスペースを削除するか、それらのワークスペースへのメタストアリンクを削除する必要があります。ワークスペースからメタストアリンクを削除する方法については、Azure Databricks サポートにお問い合わせください。

使用に関するドキュメントを表示するには、databricks unity-catalog metastores delete --help を実行します。

メタストアを強制的に削除するには、--force オプションを使用します。

databricks unity-catalog metastores delete --id 12a345b6-7890-1cd2-3456-e789f0a12b34

操作が成功した場合、結果は返されません。

ストレージ資格情報

ストレージの資格情報を操作するには、unity-catalog storage-credentials サブコマンドを使用します。「Azure Data Lake Storage Gen2 に接続するためのストレージ資格情報の作成」を参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog storage-credentials --help を実行します。

ストレージの資格情報を作成する
ストレージの資格情報の設定を更新する
使用可能なストレージの資格情報を一覧表示する
ストレージの資格情報に関する情報を取得する
ストレージの資格情報を削除する

ストレージの資格情報を作成する

使用に関するドキュメントを表示するには、databricks unity-catalog storage-credentials create --help を実行します。

「Azure Data Lake Storage Gen2 に接続するためのストレージ資格情報の作成」も参照してください。

ストレージの資格情報の設定を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog storage-credentials update --help を実行します。

使用可能なストレージの資格情報を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog storage-credentials list --help を実行します。

databricks unity-catalog storage-credentials list

ストレージの資格情報に関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog storage-credentials get --help を実行します。

databricks unity-catalog storage-credentials get --name my-storage-root-credential

ストレージの資格情報を削除する

使用に関するドキュメントを表示するには、databricks unity-catalog storage-credentials delete --help を実行します。

ストレージの資格情報を強制的に削除するには、--force オプションを使用します。

databricks unity-catalog storage-credentials delete --name my-storage-root-credential

操作が成功した場合、結果は返されません。

外部の場所

外部の場所を操作するには、unity-catalog external-locations サブコマンドを使用します。「クラウドストレージを Azure Databricks に接続するための外部の場所の作成」を参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations --help を実行します。

外部の場所を作成する
外部の場所と資格情報のペアを検証する
- 外部の場所名と資格情報のペアを作成した後に検証する
外部の場所の設定を更新する
使用可能な外部の場所を一覧表示する
外部の場所に関する情報を取得する
外部の場所を削除する

外部の場所を作成する

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations create --help を実行します。「クラウドストレージを Azure Databricks に接続するための外部の場所の作成」も参照してください。

外部の場所と資格情報のペアを検証する

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations validate --help を実行します。

外部の場所名と資格情報のペアを作成した後に検証する

databricks unity-catalog external-locations validate --name my-external-location \
                                                     --cred-name my-storage-root-credential

出力:

{
  "isDir": true,
  "results": [
    {
      "operation": "READ",
      "result": "PASS"
    },
    {
      "operation": "LIST",
      "result": "PASS"
    },
    {
      "operation": "WRITE",
      "result": "PASS"
    },
    {
      "operation": "DELETE",
      "result": "PASS"
    }
  ]
}

外部の場所の設定を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations update --help を実行します。

databricks unity-catalog external-locations update --name my-external-location \
                                                   --json-file update-external-location.json

udpate-external-location.json:

{
  "name": "my-external-location-2"
}

使用可能な外部の場所を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations list --help を実行します。

databricks unity-catalog external-locations list

外部の場所に関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations get --help を実行します。

databricks unity-catalog external-locations get --name my-external-location

外部の場所を削除する

使用に関するドキュメントを表示するには、databricks unity-catalog external-locations delete --help を実行します。

外部の場所を強制的に削除するには、--force オプションを使用します。

databricks unity-catalog external-locations delete --name my-external-location

操作が成功した場合、結果は返されません。

カタログ

カタログを操作するには、unity-catalog catalogs サブコマンドを使用します。

使用に関するドキュメントを表示するには、databricks unity-catalog catalogs --help を実行します。

カタログを作成する
カタログの設定を更新する
使用可能なカタログを一覧表示する
カタログに関する情報を取得する
カタログを削除する

カタログを作成する

使用に関するドキュメントを表示するには、databricks unity-catalog catalogs create --help を実行します。「カタログの作成」も参照してください。

databricks unity-catalog catalogs create --name my-catalog

出力:

{
  "name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656113178995,
  "created_by": "someone@example.com",
  "updated_at": 1656113178995,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

カタログの設定を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog catalogs update --help を実行します。

databricks unity-catalog catalogs update --name my-catalog \
                                         --json-file update-catalog.json

update-catalog.json:

{
  "name": "my-catalog-2",
  "owner": "someone@example.com"
}

出力:

{
  "name": "my-catalog-2",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656355967835,
  "created_by": "someone@example.com",
  "updated_at": 1656356095989,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

使用可能なカタログを一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog catalogs list --help を実行します。

databricks unity-catalog catalogs list

出力:

{
  "catalogs": [
    {
      "name": "main",
      "owner": "someone@example.com",
      "comment": "Main catalog (auto-created)",
      "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656112029355,
      "created_by": "someone@example.com",
      "updated_at": 1656112029355,
      "updated_by": "someone@example.com",
      "catalog_type": "MANAGED_CATALOG"
    },
    {
      "...": "..."
    }
  ]
}

カタログに関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog catalogs get --help を実行します。

databricks unity-catalog catalogs get --name my-catalog

出力:

{
  "name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656113178995,
  "created_by": "someone@example.com",
  "updated_at": 1656113178995,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

カタログを削除する

使用に関するドキュメントを表示するには、databricks unity-catalog catalogs delete --help を実行します。「カタログを削除する」も参照してください。

カタログを強制的に削除するには、--purge オプションを使用します。

databricks unity-catalog catalogs delete --name my-catalog

操作が成功した場合、結果は返されません。

スキーマ

スキーマを操作するには、unity-catalog schemas サブコマンドを使用します。

使用に関するドキュメントを表示するには、databricks unity-catalog schemas --help を実行します。

スキーマの作成
スキーマの設定を変更する
使用可能なスキーマを一覧表示する
スキーマに関する情報を取得する
スキーマを削除する

スキーマの作成

使用に関するドキュメントを表示するには、databricks unity-catalog schemas create --help を実行します。「スキーマの作成」も参照してください。

databricks unity-catalog schemas create --catalog-name my-catalog \
                                        --name my-schema

出力:

{
  "name": "my-schema",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema",
  "created_at": 1656113607800,
  "created_by": "someone@example.com",
  "updated_at": 1656113607800,
  "updated_by": "someone@example.com"
}

スキーマの設定を変更する

使用に関するドキュメントを表示するには、databricks unity-catalog schemas update --help を実行します。

databricks unity-catalog schemas update --full-name my-catalog.my-schema \
                                        --json-file update-schema.json

update-schema.json:

{
  "name": "my-schema-2",
  "owner": "someone@example.com"
}

出力:

{
  "name": "my-schema-2",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "comment": "Default schema (auto-created)",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema-2",
  "created_at": 1656355967837,
  "created_by": "someone@example.com",
  "updated_at": 1656356592786,
  "updated_by": "someone@example.com"
}

使用可能なスキーマを一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog schemas list --help を実行します。

databricks unity-catalog schemas list --catalog-name my-catalog

出力:

{
  "schemas": [
    {
      "name": "default",
      "catalog_name": "my-catalog",
      "owner": "someone@example.com",
      "comment": "Default schema (auto-created)",
      "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "full_name": "my-catalog.default",
      "created_at": 1656113178996,
      "created_by": "someone@example.com",
      "updated_at": 1656113178996,
      "updated_by": "someone@example.com"
    },
    {
      "...": "..."
    }
  ]
}

スキーマに関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog schemas get --help を実行します。

databricks unity-catalog schemas get --full-name my-catalog.my-schema

出力:

{
  "name": "my-schema",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema",
  "created_at": 1656113607800,
  "created_by": "someone@example.com",
  "updated_at": 1656113607800,
  "updated_by": "someone@example.com"
}

スキーマを削除する

使用に関するドキュメントを表示するには、databricks unity-catalog schemas delete --help を実行します。「スキーマを削除する」も参照してください。

スキーマを強制的に削除するには、--purge オプションを使用します。

databricks unity-catalog schemas delete --full-name my-catalog.my-schema

操作が成功した場合、結果は返されません。

テーブル

テーブルを操作するには、unity-catalog tables サブコマンドを使用します。

注意

Unity Catalog CLI を使用したテーブルの作成はサポートされていません。テーブルを作成するには、「テーブルとは」と「チュートリアル: 最初のテーブルを作成して特権を付与する」を参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog tables --help を実行します。

使用可能なテーブルを一覧表示する
使用可能なテーブルの概要を表示する
テーブルに関する情報を取得する
テーブルを削除する

使用可能なテーブルを一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog tables list --help を実行します。

databricks unity-catalog tables list --catalog-name main \
                                     --schema-name default

使用可能なテーブルの概要を表示する

使用に関するドキュメントを表示するには、databricks unity-catalog tables list-summaries --help を実行します。

databricks unity-catalog tables list-summaries --catalog-name main

出力:

{
  "tables": [
    {
      "full_name": "main.default.mytable",
      "table_type": "MANAGED"
    },
    {
      "...": "..."
    }
  ]
}

テーブルに関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog tables get --help を実行します。

databricks unity-catalog tables get --full-name main.default.mytable

テーブルを削除する

使用に関するドキュメントを表示するには、databricks unity-catalog tables delete --help を実行します。

databricks unity-catalog tables delete --full-name main.default.mytable

操作が成功した場合、結果は返されません。

系列

テーブルと列の系列を操作するには、unity-catalog lineage サブコマンドを使用します。

使用に関するドキュメントを表示するには、databricks unity-catalog lineage --help を実行します。

テーブルの系列を一覧表示する
列の系列を一覧表示する

テーブルの系列を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog lineage table --help を実行します。

databricks unity-catalog lineage table --table-name main.default.mytable \
                                       --level 1

列の系列を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog lineage column --help を実行します。

databricks unity-catalog lineage column --table-name main.default.mytable \
                                        --column-name id

アクセス許可

セキュリティ保護可能なオブジェクトのアクセス許可を操作するには、unity-catalog permissions サブコマンドを使用します。「Unity Catalog の特権の管理」も参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog permissions --help を実行します。

セキュリティ保護可能なオブジェクトのアクセス許可に関する情報を取得する
セキュリティ保護可能なオブジェクトのアクセス許可を更新する

セキュリティ保護可能なオブジェクトのアクセス許可に関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog permissions get --help を実行します。「Unity Catalog の権限とセキュリティ保護可能なオブジェクト」も参照してください。

カタログ

databricks unity-catalog permissions get --catalog main

出力:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "USE CATALOG"
      ]
    }
  ]
}

スキーマ

databricks unity-catalog permissions get --schema main.default

出力:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "USE SCHEMA"
      ]
    }
  ]
}

テーブル

databricks unity-catalog permissions get --table main.default.mytable

出力:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "SELECT"
      ]
    }
  ]
}

ストレージの資格情報

databricks unity-catalog permissions get --storage-credential my-storage-root-credential

出力:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "READ_FILES"
      ]
    }
  ]
}

外部の場所

databricks unity-catalog permissions get --external-location my-external-location

出力:

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "READ_FILES"
      ]
    }
  ]
}

セキュリティ保護可能なオブジェクトのアクセス許可を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog permissions update --help を実行します。「Unity Catalog の権限とセキュリティ保護可能なオブジェクト」も参照してください。

カタログ

databricks unity-catalog permissions update --catalog \
                                            --json-file update-catalog-permissions.json

update-catalog-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": [ "USE CATALOG" ],
      "remove": [ "CREATE SCHEMA" ]
    }
  ]
}

スキーマ

databricks unity-catalog permissions update --schema \
                                            --json-file update-schema-permissions.json

update-schema-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": [ "USE SCHEMA" ],
      "remove": [ "CREATE TABLE" ]
    },
    {
      "principal": "admin team",
      "add": [ "CREATE TABLE" ]
    }
  ]
}

テーブル

databricks unity-catalog permissions update --table \
                                            --json-file update-table-permissions.json

update-table-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": [ "SELECT" ],
      "remove": [ "MODIFY" ]
    },
    {
      "principal": "admin team",
      "add": [ "ALL" ]
    }
  ]
}

ストレージの資格情報

databricks unity-catalog permissions update --storage-credential \
                                            --json-file update-storage-credential-permissions.json

update-storage-credential-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "remove": [ "READ FILES" ]
    },
    {
      "principal": "storage team",
      "add": [ "READ FILES",
               "WRITE FILES",
               "CREATE EXTERNAL TABLE"
             ]
    },
    {
      "principal": "admin team",
      "add": [ "ALL" ]
    }
  ]
}

外部の場所

databricks unity-catalog permissions update --external-location \
                                            --json-file update-external-location-permissions.json

update-external-location-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "remove": [ "READ FILES" ]
    },
    {
      "principal": "storage team",
      "add": [ "READ FILES",
               "WRITE FILES",
               "CREATE EXTERNAL TABLE"
             ]
    },
    {
      "principal": "admin team",
      "add": [ "ALL" ]
    }
  ]
}

共有を操作するには、unity-catalog shares サブコマンドを使用します。共有は、グループとして Delta Sharing 受信者と共有する Delta Sharing 対応 Unity Catalog メタストア内のテーブルのコレクションが含まれているオブジェクトです。共有には、1 つのメタストアからのテーブルのみを含めることができます。「Delta Sharing の共有を作成および管理する」参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog shares --help を実行します。

共有を作成する
共有の設定を更新する
- 共有にテーブルを追加する
- 共有からテーブルを削除する
共有のアクセス許可を更新する
使用可能な共有を一覧表示する
共有に関する情報を取得する
共有のアクセス許可を一覧表示する
共有を削除する

使用に関するドキュメントを表示するには、databricks unity-catalog shares create --help を実行します。「Delta Sharing の共有を作成および管理する」参照してください。

databricks unity-catalog shares create --name my-share

出力:

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

共有の設定を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog shares update --help を実行します。共有の更新に関する記事も参照してください。

databricks unity-catalog shares update --name my-share \
                                       --add-table main.default.mytable

出力:

{
  "name": "my-share",
  "objects": [
    {
      "name": "main.default.mytable",
      "data_object_type": "TABLE",
      "added_at": 1656434168847,
      "added_by": "someone@example.com",
      "shared_as": "default.mytable",
      "cdf_enabled": false
    }
  ],
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

「共有にテーブルを追加する」も参照してください。

databricks unity-catalog shares update --name my-share \
                                       --remove-table main.default.mytable

出力:

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

「共有にテーブルを追加する」も参照してください。

共有のアクセス許可を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog shares update-permissions --help を実行します。 Delta Sharing データ共有へのアクセスの管理 (プロバイダーの場合) に関する記事も参照してください。

databricks unity-catalog shares update-permissions --name my-share \
                                                   --json-file update-share-permissions.json

update-share-permissions.json:

{
  "privilege_assignments": [
    {
      "principal": "my-recipient",
      "privileges": [
        "SELECT"
      ]
    }
  ]
}

使用可能な共有を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog shares list --help を実行します。「共有と共有の詳細を表示する」も参照してください。

databricks unity-catalog shares list

出力:

{
  "shares": [
    {
      "name": "my-share",
      "created_at": 1656433327533,
      "created_by": "someone@example.com",
      "owner": "someone@example.com"
    },
    {
      "...": "..."
    }
  ]
}

使用に関するドキュメントを表示するには、databricks unity-catalog shares get --help を実行します。「共有と共有の詳細を表示する」も参照してください。

databricks unity-catalog shares get --name my-share

出力:

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

共有のアクセス許可を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog shares list-permissions --help を実行します。「共有に対するアクセス許可を持つ受信者を表示する」も参照してください。

databricks unity-catalog shares list-permissions --name my-share

出力:

{
  "privilege_assignments": [
    {
      "principal": "my-recipient",
      "privileges": [
        "SELECT"
      ]
    }
  ]
}

使用に関するドキュメントを表示するには、databricks unity-catalog shares delete --help を実行します。「共有を削除する」も参照してください。

databricks unity-catalog shares delete --name my-share

操作が成功した場合、結果は返されません。

Recipients

Delta Sharing 対応 Unity Calalog メタストアのデータ受信者を操作するには、unity-catalog recipients サブコマンドを使用します。データ受信者とは、Azure Databricks ユーザーがデータを共有する、そのユーザーの組織の外部の人員またはグループです。「Delta Sharing のデータ受信者を作成および管理する」を参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog recipients --help を実行します。

受信者を作成する
受信者の設定を変更する
受信者のトークンをローテーションする
使用可能な受信者を一覧表示する
受信者の共有アクセス許可を一覧表示する
受信者に関する情報を取得する
受信者を削除する

受信者の作成

使用に関するドキュメントを表示するには、databricks unity-catalog recipients create --help を実行します。「Delta Sharing のデータ受信者を作成および管理する」も参照してください。

受信者の新しいアクティブ化 URL を生成するには、databricks unity-catalog recipients rotate-token を実行します。例については、「受信者のトークンをローテーションする」を参照してください。

databricks unity-catalog recipients create --name my-recipient

出力:

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656521688006,
      "updated_at": 1656435288006,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

受信者の設定を変更する

使用に関するドキュメントを表示するには、databricks unity-catalog recipients update --help を実行します。

databricks unity-catalog recipients update --name my-recipient \
                                           --json-file update-recipient-settings.json

update-recipient-settings.json:

{
  "name": "my-recipient-2"
}

出力:

{
  "name": "my-recipient-2",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "expiration_time": 1656436808507,
      "updated_at": 1656435908507,
      "updated_by": "someone@example.com"
    },
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435908509,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656522308510,
      "updated_at": 1656435908510,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656436740986,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

受信者のトークンをローテーションする

使用に関するドキュメントを表示するには、databricks unity-catalog recipients rotate-token --help を実行します。「受信者トークンを管理する (共有を開く)」も参照してください。

databricks unity-catalog recipients rotate-token --name my-recipient \
                                                 --existing-token-expire-in-seconds 900

出力:

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "expiration_time": 1656436808507,
      "updated_at": 1656435908507,
      "updated_by": "someone@example.com"
    },
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435908509,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656522308510,
      "updated_at": 1656435908510,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

使用可能な受信者を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog recipients list --help を実行します。「受信者を表示する」も参照してください。

databricks unity-catalog recipients list

出力:

{
  "recipients": [
    {
      "name": "my-recipient",
      "created_at": 1656435288003,
      "created_by": "someone@example.com",
      "tokens": [
        {
          "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
          "created_at": 1656435288005,
          "created_by": "someone@example.com",
          "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
          "expiration_time": 1656521688006,
          "updated_at": 1656435288006,
          "updated_by": "someone@example.com"
        }
      ],
      "authentication_type": "TOKEN",
      "updated_at": 1656435288003,
      "updated_by": "someone@example.com",
      "owner": "someone@example.com"
    }
  ]
}

使用に関するドキュメントを表示するには、databricks unity-catalog recipients list-permissions --help を実行します。「受信者の共有アクセス許可を一覧表示する」も参照してください。

databricks unity-catalog recipients list-permissions --name my-recipient

出力:

{
  "permissions_out": [
    {
      "share_name": "my-share",
      "privilege_assignments": [
        {
          "privileges": [
            "SELECT"
          ]
        }
      ]
    }
  ]
}

受信者に関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog recipients get --help を実行します。「受信者の詳細を表示する」も参照してください。

databricks unity-catalog recipients get --name my-recipient

出力:

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656521688006,
      "updated_at": 1656435288006,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

受信者の削除

使用に関するドキュメントを表示するには、databricks unity-catalog recipients delete --help を実行します。「受信者の削除」も参照してください。

databricks unity-catalog recipients delete --name my-recipient

操作が成功した場合、結果は返されません。

プロバイダー

Delta Sharing 共有データ受信者の場合は、unity-catalog providers サブコマンドを使用して Delta Sharing データプロバイダーを操作します。「Delta Sharing プロバイダーを管理する (データ受信者の場合)」を参照してください。

使用に関するドキュメントを表示するには、databricks unity-catalog providers --help を実行します。

プロバイダーを作成する
プロバイダーの設定を更新する
使用可能なプロバイダーを一覧表示する
プロバイダーに関する情報を取得する
プロバイダーの使用可能な共有を一覧表示する
プロバイダーを削除する

プロバイダーを作成する

オープン共有プロトコルを使用して共有されるデータの受信者で、Unity Catalog メタストアにアタッチされている Databricks ワークスペースを使用している場合は、Unity Catalog メタストアにプロバイダーオブジェクトを作成できます。その後、Unity Catalog を使用して共有データへのアクセスを管理できます。

重要

このシナリオはまれです。 Unity カタログで有効になっている Databricks ワークスペースを使用していて、別の Databricks のお客様がデータを共有している場合は、Databricks から Databricks への共有を使用する必要があります。 Databricks から Databricks への共有では、プロバイダーオブジェクトが Unity カタログに自動的に作成されます。

プロバイダーを作成するには、次の要件を満たす必要があります。

メタストア管理者であるか、メタストアの CREATE_PROVIDER 特権を持つユーザーである。
ダウンロードした資格情報ファイルにアクセスできる。「オープン共有モデルでアクセスを取得する」を参照してください。

次のコマンドを実行し、my-provider をプロバイダーに指定する名前に置き換え、config.share をダウンロードした資格情報ファイルのパス (既定では config.share という名前) に置き換えます。

databricks unity-catalog providers create --name my-provider  \
                  --recipient-profile-json-file config.share

プロバイダーの設定を更新する

使用に関するドキュメントを表示するには、databricks unity-catalog providers update --help を実行します。

databricks unity-catalog providers update --name my-provider \
                                          --new-name my-provider-2

使用可能なプロバイダーを一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog providers list --help を実行します。

databricks unity-catalog providers list

プロバイダーに関する情報を取得する

使用に関するドキュメントを表示するには、databricks unity-catalog providers get --help を実行します。

databricks unity-catalog providers get --name my-provider

プロバイダーの使用可能な共有を一覧表示する

使用に関するドキュメントを表示するには、databricks unity-catalog providers list-shares --help を実行します。

databricks unity-catalog providers list-shares --name my-provider

プロバイダーを削除する

使用に関するドキュメントを表示するには、databricks unity-catalog providers delete --help を実行します。

databricks unity-catalog providers delete --name my-provider

操作が成功した場合、結果は返されません。

次の方法で共有

Unity Catalog CLI (レガシ)

metastore

メタストアの作成

メタストアをワークスペースにリンクする

メタストアの設定を更新する

使用可能なメタストアを一覧表示する

メタストアに関する情報を取得する

現在のメタストアに関する概要情報を取得する

ワークスペースの現在のメタストア割り当てを取得する

メタストアをワークスペースからリンク解除する

メタストアを削除する

ストレージ資格情報

ストレージの資格情報を作成する

ストレージの資格情報の設定を更新する

使用可能なストレージの資格情報を一覧表示する

ストレージの資格情報に関する情報を取得する

ストレージの資格情報を削除する

外部の場所

外部の場所を作成する

外部の場所と資格情報のペアを検証する

外部の場所名と資格情報のペアを作成した後に検証する

外部の場所の設定を更新する

使用可能な外部の場所を一覧表示する

外部の場所に関する情報を取得する

外部の場所を削除する

カタログ

カタログを作成する

カタログの設定を更新する

使用可能なカタログを一覧表示する

カタログに関する情報を取得する

カタログを削除する

スキーマ

スキーマの作成

スキーマの設定を変更する

使用可能なスキーマを一覧表示する

スキーマに関する情報を取得する

スキーマを削除する

テーブル

使用可能なテーブルを一覧表示する

使用可能なテーブルの概要を表示する

テーブルに関する情報を取得する

テーブルを削除する

系列

テーブルの系列を一覧表示する

列の系列を一覧表示する

アクセス許可

セキュリティ保護可能なオブジェクトのアクセス許可に関する情報を取得する

カタログ

スキーマ

テーブル

ストレージの資格情報

外部の場所

セキュリティ保護可能なオブジェクトのアクセス許可を更新する

カタログ

スキーマ

テーブル

ストレージの資格情報

外部の場所

共有

共有を作成する

共有の設定を更新する

共有にテーブルを追加する

共有からテーブルを削除する

共有のアクセス許可を更新する

使用可能な共有を一覧表示する

共有に関する情報を取得する

共有のアクセス許可を一覧表示する

共有を削除する

Recipients

受信者の作成

受信者の設定を変更する

受信者のトークンをローテーションする

使用可能な受信者を一覧表示する

受信者の共有アクセス許可を一覧表示する

受信者に関する情報を取得する

受信者の削除

プロバイダー

プロバイダーを作成する

プロバイダーの設定を更新する