external-metadata группа команд

Замечание

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

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

Группа external-metadata команд в интерфейсе командной строки Databricks содержит команды для регистрации метаданных внешних систем в каталоге Unity и управления ими.

databricks external-metadata create-external-metadata

Создайте новый внешний объект метаданных в родительском хранилище метаданных, если вызывающий объект является администратором хранилища метаданных или имеет права CREATE_EXTERNAL_METADATA . Предоставляет ОБЗОР всем пользователям учетной записи при создании по умолчанию.

databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]

Аргументы

NAME

    Имя внешнего объекта метаданных.

SYSTEM_TYPE

    Тип внешней системы. Поддерживаемые значения: AMAZON_REDSHIFT, CONFLUENTTERADATATABLEAUSTREAM_NATIVESERVICENOWSAPGOOGLE_BIGQUERYSALESFORCESNOWFLAKEPOSTGRESQLLOOKERDATABRICKSMICROSOFT_FABRICPOWER_BIAZURE_SYNAPSEOTHERORACLEMICROSOFT_SQL_SERVERKAFKAMONGODBMYSQL. WORKDAY

ENTITY_TYPE

    Тип сущности во внешней системе.

Options

--description string

    Описание текста произвольной формы, предоставленного пользователем.

--json JSON

    Встроенная строка JSON или JSON-файл @path с текстом запроса

--owner string

    Владелец внешнего объекта метаданных.

--url string

    URL-адрес, связанный с внешним объектом метаданных.

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

Примеры

В следующем примере создается внешний объект метаданных для таблицы Snowflake:

databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"

В следующем примере создается внешний объект метаданных с помощью JSON:

databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'

В следующем примере создается внешний объект метаданных с помощью JSON-файла:

databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json

databricks external-metadata delete-external-metadata

Удалите внешний объект метаданных, соответствующий указанному имени. Вызывающий объект должен быть администратором хранилища метаданных, владельцем внешнего объекта метаданных или пользователем с правами MANAGE .

databricks external-metadata delete-external-metadata NAME [flags]

Аргументы

NAME

    Имя удаленного объекта внешних метаданных.

Options

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

Примеры

В следующем примере удаляется внешний объект метаданных:

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

Получение указанного объекта внешних метаданных в хранилище метаданных. Вызывающий объект должен быть администратором хранилища метаданных, владельцем внешнего объекта метаданных или пользователем с правами BROWSE .

databricks external-metadata get-external-metadata NAME [flags]

Аргументы

NAME

    Имя объекта внешних метаданных для получения.

Options

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

Примеры

В следующем примере получается внешний объект метаданных:

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

Вывод списка внешних объектов метаданных в хранилище метаданных. Если вызывающий объект является администратором хранилища метаданных, будут извлечены все внешние объекты метаданных. В противном случае извлекаются только внешние объекты метаданных, на которые вызывается вызывающий объект BROWSE . Никакой гарантии упорядочения элементов в массиве нет.

databricks external-metadata list-external-metadata [flags]

Options

--page-size int

    Максимальное количество объектов внешних метаданных, возвращаемых на страницу.

--page-token string

    Маркер для получения следующей страницы результатов.

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

Примеры

В следующем примере перечислены все внешние объекты метаданных:

databricks external-metadata list-external-metadata

В следующем примере перечислены внешние объекты метаданных с разбивкой на страницы:

databricks external-metadata list-external-metadata --page-size 10

databricks external-metadata update-external-metadata

Обновите внешний объект метаданных, соответствующий указанному имени. Вызывающий объект может обновить только владельца или другие поля метаданных в одном запросе. Вызывающий объект должен быть администратором хранилища метаданных, владельцем внешнего объекта метаданных или пользователем с привилегией MODIFY . Если вызывающий объект обновляет владельца, он также должен иметь привилегию MANAGE .

databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]

Аргументы

NAME

    Имя внешнего объекта метаданных.

UPDATE_MASK

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

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

SYSTEM_TYPE

    Тип внешней системы. Поддерживаемые значения: AMAZON_REDSHIFT, CONFLUENTTERADATATABLEAUSTREAM_NATIVESERVICENOWSAPGOOGLE_BIGQUERYSALESFORCESNOWFLAKEPOSTGRESQLLOOKERDATABRICKSMICROSOFT_FABRICPOWER_BIAZURE_SYNAPSEOTHERORACLEMICROSOFT_SQL_SERVERKAFKAMONGODBMYSQL. WORKDAY

ENTITY_TYPE

    Тип сущности во внешней системе.

Options

--description string

    Описание текста произвольной формы, предоставленного пользователем.

--json JSON

    Встроенная строка JSON или JSON-файл @path с текстом запроса

--owner string

    Владелец внешнего объекта метаданных.

--url string

    URL-адрес, связанный с внешним объектом метаданных.

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

Примеры

В следующем примере обновляется описание внешнего объекта метаданных:

databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"

В следующем примере обновляется владелец внешнего объекта метаданных:

databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"

В следующем примере обновляется внешний объект метаданных с помощью JSON:

databricks external-metadata update-external-metadata my_snowflake_table "description,url" SNOWFLAKE TABLE --json '{"description": "Latest sales data", "url": "https://example.snowflakecomputing.com/table/sales_v2"}'

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

--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 струна

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