entity-tag-assignments группа команд

Замечание

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

Использование интерфейса командной строки Databricks подчиняется лицензии Databricks и уведомлению о конфиденциальности Databricks, включая любые положения о данных использования.

Группа entity-tag-assignments команд в интерфейсе командной строки Databricks содержит команды для создания, обновления, удаления и перечисления назначений тегов в сущностях каталога Unity. Теги — это атрибуты, включающие ключи и необязательные значения, которые можно использовать для упорядочивания и классификации сущностей в каталоге Unity. См. раздел "Применение тегов к защищаемым объектам каталога Unity".

databricks entity-tag-assignments create

Создайте назначение тегов для сущности каталога Unity.

Чтобы добавить теги в сущности каталога Unity, необходимо владеть сущностью или иметь следующие привилегии:

• ПРИМЕНЕНИЕ ТЕГа к сущности
• 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

Options

--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, необходимо владеть сущностью или иметь следующие привилегии:

• ПРИМЕНЕНИЕ ТЕГа к сущности
• 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

    Ключ тега для удаления.

Options

Глобальные флаги

Примеры

В следующем примере удаляется назначение тега из таблицы:

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

    Ключ тега.

Options

Глобальные флаги

Примеры

В следующем примере возвращается назначение тега для таблицы:

databricks entity-tag-assignments get tables my_catalog.my_schema.my_table environment

databricks entity-tag-assignments list

Вывод списка назначений тегов для сущности каталога Unity.

Это важно

API по умолчанию разбиен на страницы, страница может содержать нулевые результаты, предоставляя 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

    Полное имя сущности, которой назначается тег.

Options

--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, необходимо владеть сущностью или иметь следующие привилегии:

• ПРИМЕНЕНИЕ ТЕГа к сущности
• 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

    Маска поля должна быть одной строкой, с несколькими полями, разделенными запятыми (без пробелов). Путь к полю относительно объекта ресурса, используя точку (.) для навигации по вложенным полям (например, author.given_name). Спецификация элементов в полях последовательности или карты запрещена, так как можно указать только все поле коллекции. Имена полей должны точно совпадать с именами полей ресурсов.

    Маска поля звездочки (*) указывает на полную замену. Рекомендуется всегда явно перечислять обновляемые поля и избегать использования подстановочных знаков, так как это может привести к непредвиденным результатам, если API изменится в будущем.

Options

--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, связанной группе команд или отдельной команде.

--log-file струна

    Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

    Тип формата журнала: text или json. Значение по умолчанию — text.

--log-level струна

    Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

    Тип выходных данных команды: text или json. Значение по умолчанию — text.

-p, --profile струна

    Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если этот флаг не указан, при наличии используется профиль с именем DEFAULT.

--progress-format формат

    Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

    Если применимо, целевой объект пакета для использования