Поделиться через

Интерфейс командной строки каталога Unity (устаревшая версия)

  • Статья

Внимание

Поддержка этой документации прекращена, она может больше не обновляться.

Эта информация относится к устаревшим интерфейсам командной строки Databricks версии 0.18 и ниже. Databricks рекомендует использовать более новую версию Интерфейса командной строки Databricks версии 0.205 или более поздней. См. сведения о интерфейсе командной строки Databricks?. Чтобы найти версию интерфейса командной строки Databricks, выполните команду databricks -v.

Сведения о миграции из Databricks CLI версии 0.18 или ниже в Databricks CLI версии 0.205 или более поздней, см. в статье Databricks CLI.

Примечание.

Unity Catalog CLI предоставляется в экспериментальной версии.

Для интерфейса командной строки каталога Unity требуется интерфейс командной строки Databricks (устаревшая версия) 0.17.0 или более поздней версии, настроенная с проверкой подлинности. Сведения об обновлении интерфейса командной строки Databricks или выводе сведений об установленной версии см. в разделе Обновление CLI.

Значения для параметров и полей в примерах ниже приведены только для иллюстрации.

Используйте интерфейс командной строки каталога Unity для работы с:

Чтобы запустить подкоманды CLI Catalog, добавьте их в databricks unity-catalog. Эти вложенные команды вызывают API каталога Unity, который также включает 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

Хранилища метаданных

Используйте подкоманду unity-catalog metastores для работы с хранилищами метаданных.

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog metastores --help.

Создание хранилища метаданных

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog metastores create --help. См. также раздел Создание хранилища метаданных каталога Unity.

Примечание.

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

При выполнении этой команды в рабочей области, которая уже имеет назначенное хранилище метаданных, вы обновите назначенное хранилище метаданных такой рабочей области.

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

Чтобы получить идентификатор рабочей области, см. раздел Имена, URL-адреса и идентификаторы экземпляров рабочих областей.

Чтобы получить идентификатор хранилища метаданных, выполните команду databricks unity-catalog metastores get-summary. Примеры см. в разделе Получение сводной информации о текущем хранилище метаданных.

Выходные данные:

{}

См. также раздел Создание хранилища метаданных каталога Unity.

Обновление параметров хранилища метаданных

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog metastores update --help.

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

Чтобы получить идентификатор хранилища метаданных, выполните команду databricks unity-catalog metastores get-summary. Примеры см. в разделе Получение сводной информации о текущем хранилище метаданных.

update-metastore.json:

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

Чтобы получить идентификатор корневых учетных данных хранилища см. раздел Получение сведений об учетных данных хранилища.

Вывод доступных хранилищ метаданных

Чтобы просмотреть документацию по использованию, выполните команду 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. Примеры см. в разделе Получение сводной информации о текущем хранилище метаданных.

Получение сводной информации о текущем хранилище метаданных

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

Чтобы получить идентификатор рабочей области, см. раздел Имена, URL-адреса и идентификаторы экземпляров рабочих областей.

Чтобы получить идентификатор хранилища метаданных, выполните команду databricks unity-catalog metastores get-summary. Примеры см. в разделе Получение сводной информации о текущем хранилище метаданных.

Выходные данные:

{}

Удаление хранилища метаданных

Предупреждение

Перед удалением хранилища метаданных необходимо удалить все рабочие области, использующие хранилище метаданных, или удалить ссылку хранилища метаданных на эти рабочие области. Чтобы получить помощь по удалению ссылок хранилища метаданных из рабочих областей, обратитесь в службу поддержки Azure Databricks.

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog metastores delete --help.

Чтобы принудительно удалить хранилище метаданных, используйте параметр --force.

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

Чтобы получить идентификатор хранилища метаданных, выполните команду databricks unity-catalog metastores get-summary. Примеры см. в разделе Получение сводной информации о текущем хранилище метаданных.

Если операция выполнена успешно, результаты не возвращаются.

Учетные данные хранилища

unity-catalog storage-credentials Используйте подкоманда для работы с учетными данными хранилища. См. статью "Создание учетных данных хранилища" для подключения к Azure Data Lake Storage 2-го поколения.

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog storage-credentials --help.

Создание учетных данных хранилища

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog storage-credentials create --help.

См. также сведения о создании учетных данных хранения для подключения к Azure Data Lake Storage 2-го поколения.

Обновление параметров учетных данных хранилища

Чтобы просмотреть документацию по использованию, выполните команду 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 не поддерживается. Сведения о создании таблиц см. в статье "Что такое таблицы и представления?", а также руководство. Создание первой таблицы и предоставление привилегий.

Чтобы просмотреть документацию по использованию, выполните команду 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 для работы с общими папками, которые являются объектами с коллекциями таблиц в хранилище метаданных Unity Catalog с поддержкой разностного общего доступа, к которым вы хотите предоставить общий доступ в виде группы с получателями разностного общего доступа. Общий ресурс может содержать таблицы только из одного хранилища метаданных. См. статью "Создание общих папок" и управление ими для разностного общего доступа.

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog shares --help.

Создание общей папки

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog shares create --help. См. также статью "Создание общих папок" и управление ими для разностного общего доступа.

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

Если операция выполнена успешно, результаты не возвращаются.

Получатели

Используйте подкоманду unity-catalog recipients для работы с получателями данных для хранилищ метаданных Unity Catalog с поддержкой разностного общего доступа. Получатели данных — это люди или группы, которым пользователь Azure Databricks предоставляет общий доступ к данным за пределами организации пользователя Azure Databricks. См. статью "Создание получателей данных" и управление ими для разностного общего доступа.

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog recipients --help.

Создание получателя

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog recipients create --help. См. также сведения о создании получателей данных и управлении ими для разностного общего доступа.

Чтобы создать новый 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. См. раздел "Управление поставщиками разностного общего доступа" (для получателей данных).

Чтобы просмотреть документацию по использованию, выполните команду databricks unity-catalog providers --help.

Создание поставщика

Если вы являетесь получателем данных, которым предоставлен общий доступ с помощью открытого протокола общего доступа, и вы используете рабочую область Databricks, подключенную к хранилищу метаданных каталога Unity, можно создать объект поставщика в хранилище метаданных каталога Unity. Затем вы можете управлять доступом к общим данным с помощью каталога Unity.

Внимание

Этот сценарий является редким. Если вы используете рабочую область Databricks, которая включена для каталога Unity, а другой клиент Databricks предоставляет вам общий доступ к данным, они должны использовать совместное использование Databricks to Databricks. При совместном использовании Databricks to 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

Если операция выполнена успешно, результаты не возвращаются.