`shares` コマンドグループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI はパブリックプレビュー段階です。

Databricks CLI 使用には、使用状況データを含む Databricks ライセンスおよび Databricks プライバシー通知が適用されます。

Databricks CLI 内の shares コマンドグループを使用すると、Unity Catalog で共有を管理できます。

共有は、 shares createでインスタンス化されたコンテナーです。作成したら、を使用してメタストア内で定義された既存のデータ資産のコレクションを反復登録する shares updateを使用できます。あなたはすることができます登録するデータ資産元の名前で、元のスキーマで修飾するか、または別の公開名を指定します。

databricks shares create

データオブジェクトの新しい共有を作成します。データオブジェクトは、 updateで作成後に追加できます。呼び出し元は、メタストア管理者であるか、メタストアに対する CREATE_SHARE 特権を持っている必要があります。

databricks shares create NAME [flags]

引数

NAME

共有の名前。

オプション

--comment string

ユーザー指定の自由形式のテキスト説明。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--storage-root string

共有のストレージルート URL。

グローバルフラグ

例

次の例では、コメント付きの my-analytics-share という名前の共有を作成します。

Bash
databricks shares create my-analytics-share --comment "Sales analytics data share"

次の例では、特定のストレージルートを持つ共有を作成します。

Bash

databricks shares create my-analytics-share --storage-root "s3://my-bucket/share-data"

databricks shares delete

メタストアから共有を削除します。呼び出し元は、共有の所有者である必要があります。

databricks shares delete NAME [flags]

引数

NAME

共有の名前。

オプション

グローバルフラグ

例

次の例では、 my-analytics-shareという名前の共有を削除します。

Bash

databricks shares delete my-analytics-share

databricks shares get

メタストアから共有を取得します。呼び出し元は、メタストア管理者または共有の所有者である必要があります。

databricks shares get NAME [flags]

引数

NAME

共有の名前。

オプション

--include-shared-data

共有に含めるデータを照会します。

グローバルフラグ

例

次の例では、 my-analytics-shareという名前の共有に関する情報を取得します。

Bash

databricks shares get my-analytics-share

次の例では、共有データに関する詳細を含む共有を取得します。

Bash

databricks shares get my-analytics-share --include-shared-data

databricks shares list

メタストアから共有を一覧表示します。呼び出し元は、メタストア管理者または共有の所有者である必要があります。配列内の要素の特定の順序を保証するものではありません。

databricks shares list [flags]

引数

なし

オプション

--max-results int

返す株式の最大数。

--page-token string

前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。

グローバルフラグ

例

次の例は、すべての共有を一覧表示します。

Bash

databricks shares list

databricks shares update

要求の変更とデータオブジェクトを使用して共有を更新します。呼び出し元は、共有の所有者またはメタストア管理者である必要があります。

呼び出し元がメタストア管理者の場合、更新できるのは owner フィールドのみです。

共有名が変更された場合、 updateShare 呼び出し元が共有の所有者であり、 CREATE_SHARE 権限を持っている必要があります。

共有にノートブックファイルがある場合、[ storage_root ] フィールドは更新できません。

この方法で追加される各表について、共有所有者は表に対する SELECT 特権も持っている必要があります。この特権は、受信者がテーブルにアクセスできるように無期限に維持する必要があります。通常、共有所有者としてグループを使用する必要があります。

update による表の削除には、追加の権限は必要ありません。

databricks shares update NAME [flags]

引数

NAME

共有の名前。

オプション

--comment string

ユーザー指定の自由形式のテキスト説明。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--new-name string

共有の新しい名前。

--owner string

共有の現在の所有者のユーザー名。

--storage-root string

共有のストレージルート URL。

グローバルフラグ

例

次の例では、共有のコメントを更新します。

Bash
databricks shares update my-analytics-share --comment "Updated sales analytics data share"

次の例では、共有の名前を変更します。

Bash

databricks shares update my-analytics-share --new-name "sales-analytics-share"

次の例では、共有の所有者を更新します。

Bash
databricks shares update my-analytics-share --owner "someone@example.com"

次の例では、JSON 構成を使用して共有を更新します。

Bash
databricks shares update my-analytics-share --json '{
  "comment": "Updated share with new tables",
  "objects": [
    {
      "name": "sales.customers",
      "data_object_type": "TABLE"
    }
  ]
}'

メタストアからデータ共有のアクセス許可を取得します。呼び出し元は、メタストア管理者または共有の所有者である必要があります。

databricks shares share-permissions NAME [flags]

引数

NAME

共有の名前。

オプション

--max-results int

返すアクセス許可の最大数。

--page-token string

前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。

グローバルフラグ

例

次の例では、 my-analytics-shareという名前の共有のアクセス許可を取得します。

Bash

databricks shares share-permissions my-analytics-share

databricks shares update-permissions

メタストア内のデータ共有のアクセス許可を更新します。呼び出し元は、メタストア管理者または共有の所有者である必要があります。

新しい受信者の許可の場合、ユーザーは受信者の所有者またはメタストア管理者である必要もあります。受信者の失効には追加の権限は必要ありません。

databricks shares update-permissions NAME [flags]

引数

NAME

共有の名前。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--omit-permissions-list

随意。

グローバルフラグ

例

次の例では、受信者にアクセス許可を付与します。

Bash
databricks shares update-permissions my-analytics-share --json '{
  "changes": [
    {
      "principal": "recipient-name",
      "add": ["SELECT"]
    }
  ]
}'

次の例では、受信者のアクセス許可を取り消します。

Bash
databricks shares update-permissions my-analytics-share --json '{
  "changes": [
    {
      "principal": "recipient-name",
      "remove": ["SELECT"]
    }
  ]
}'

グローバルフラグ

--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

該当する場合は、使用するバンドル・ターゲット

databricks shares create​

引数​

オプション​

例​

databricks shares delete​

引数​

オプション​

例​

databricks shares get​

引数​

オプション​

例​

databricks shares list​

引数​

オプション​

例​

databricks shares update​

引数​

オプション​

例​

databricks shares share-permissions​

引数​

オプション​

例​

databricks shares update-permissions​

引数​

オプション​

例​

グローバルフラグ​

databricks shares create

引数

オプション

例

databricks shares delete

引数

オプション

例

databricks shares get

引数

オプション

例

databricks shares list

引数

オプション

例

databricks shares update

引数

オプション

例

databricks shares share-permissions

引数

オプション

例

databricks shares update-permissions

引数

オプション

例

グローバルフラグ