注
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Databricks CLI 内の entity-tag-assignments コマンド グループには、Unity カタログ エンティティ全体のタグ割り当てを作成、更新、削除、および一覧表示するためのコマンドが含まれています。 タグは、Unity カタログのエンティティを整理および分類するために使用できるキーと省略可能な値を含む属性です。 「Unity Catalog のセキュリティ保護可能なオブジェクトにタグを適用する」をご覧ください。
databricks entity-tag-assignments create
Unity カタログ エンティティのタグ割り当てを作成します。
Unity カタログ エンティティにタグを追加するには、エンティティを所有しているか、次の権限を持っている必要があります。
- エンティティに対する TAG の適用
- USE SCHEMA エンティティの親スキーマ
- USE CATALOG エンティティの親カタログ
管理タグを Unity カタログ エンティティに追加するには、タグ ポリシーに 対する ASSIGN または MANAGE アクセス許可も必要です。 タグ ポリシーのアクセス許可の管理を参照してください。
databricks entity-tag-assignments create ENTITY_NAME TAG_KEY ENTITY_TYPE [flags]
論争
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
タグのキー。
ENTITY_TYPE
タグが割り当てられているエンティティの型。 使用できる値は、 catalogs、 schemas、 tables、 columns、 volumesです。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
--tag-value string
タグの値。
例示
次の例では、テーブルのタグ割り当てを作成します。
databricks entity-tag-assignments create my_catalog.my_schema.my_table environment tables --tag-value production
次の例では、JSON を使用してタグの割り当てを作成します。
databricks entity-tag-assignments create my_catalog.my_schema.my_table department tables --json '{"tag_value": "finance"}'
databricks entity-tag-assignments delete
Unity カタログ エンティティのタグ割り当てをキーで削除します。
Unity カタログ エンティティからタグを削除するには、エンティティを所有しているか、次の権限を持っている必要があります。
- エンティティに対する TAG の適用
- エンティティの親スキーマのUSE_SCHEMA
- エンティティの親カタログのUSE_CATALOG
Unity カタログ エンティティから管理タグを削除するには、タグ ポリシーに 対する ASSIGN または MANAGE アクセス許可も必要です。 タグ ポリシーのアクセス許可の管理を参照してください。
databricks entity-tag-assignments delete ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
論争
ENTITY_TYPE
タグが割り当てられているエンティティの型。 使用できる値は、 catalogs、 schemas、 tables、 columns、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
削除するタグのキー。
オプション
例示
次の例では、テーブルからタグの割り当てを削除します。
databricks entity-tag-assignments delete tables my_catalog.my_schema.my_table environment
databricks entity-tag-assignments get
タグ キーを使用して Unity カタログ エンティティのタグ割り当てを取得します。
databricks entity-tag-assignments get ENTITY_TYPE ENTITY_NAME TAG_KEY [flags]
論争
ENTITY_TYPE
タグが割り当てられているエンティティの型。 使用できる値は、 catalogs、 schemas、 tables、 columns、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
タグのキー。
オプション
例示
次の例では、テーブルのタグ割り当てを取得します。
databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment
databricks entity-tag-assignments リスト
Unity カタログ エンティティのタグ割り当てを一覧表示します。
Important
API は既定でページ分割され、ページには結果が 0 個含まれている可能性があり、next_page_tokenは提供されます。 クライアントは、next_page_tokenが存在しないまでページの読み取りを続行する必要があります。これは、結果の終了に達したことを示す唯一の兆候です。
databricks entity-tag-assignments list ENTITY_TYPE ENTITY_NAME [flags]
論争
ENTITY_TYPE
タグが割り当てられているエンティティの型。 使用できる値は、 catalogs、 schemas、 tables、 columns、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
オプション
--max-results int
返される結果の最大数。
--page-token string
結果の次のページを取得するトークン。
例示
次の例では、テーブルのすべてのタグ割り当てを一覧表示します。
databricks entity-tag-assignments list tables my_catalog.my_schema.my_table
次の例では、改ページ位置付きのタグの割り当てを一覧表示します。
databricks entity-tag-assignments list tables my_catalog.my_schema.my_table --max-results 10
databricks entity-tag-assignments の更新
Unity カタログ エンティティの既存のタグ割り当てを更新します。
Unity カタログ エンティティにタグを更新するには、エンティティを所有しているか、次の権限を持っている必要があります。
- エンティティに対する TAG の適用
- USE SCHEMA エンティティの親スキーマ
- USE CATALOG エンティティの親カタログ
管理タグを Unity カタログ エンティティに更新するには、タグ ポリシーに 対する ASSIGN または MANAGE アクセス許可も必要です。 タグ ポリシーのアクセス許可の管理を参照してください。
databricks entity-tag-assignments update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK [flags]
論争
ENTITY_TYPE
タグが割り当てられているエンティティの型。 使用できる値は、 catalogs、 schemas、 tables、 columns、 volumesです。
ENTITY_NAME
タグが割り当てられているエンティティの完全修飾名。
TAG_KEY
タグのキー。
UPDATE_MASK
フィールド マスクは 1 つの文字列で、複数のフィールドをコンマで区切る必要があります (スペースなし)。 フィールド パスはリソース オブジェクトに対する相対パスであり、ドット (.) を使用してサブフィールド ( author.given_name など) を移動します。 コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。 フィールド名は、リソース フィールド名と完全に一致する必要があります。
アスタリスク (*) フィールド マスクは、完全な置換を示します。 今後 API が変更されると意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的に一覧表示し、ワイルドカードを使用しないようにすることをお勧めします。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
--tag-value string
タグの値。
例示
次の例では、テーブルのタグ割り当てを更新します。
databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --tag-value staging
次の例では、JSON を使用してタグの割り当てを更新します。
databricks entity-tag-assignments update tables my_catalog.my_schema.my_table environment "tag_value" --json '{"tag_value": "development"}'
グローバル フラグ
--debug
デバッグ ログを有効にするかどうかを指定します。
-h または --help
Databricks CLI、または関連コマンド グループ、または関連コマンドのヘルプの表示。
--log-file 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット