volumes группа команд

Note

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

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

Группа volumes команд в интерфейсе командной строки Databricks содержит команды для управления томами в каталоге Unity. Тома предоставляют функции для доступа, хранения, управления, организации и обработки файлов. См. статью Что такое тома каталога Unity?.

Создание томов Databricks

Создайте новый том.

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

Для успешного создания тома пользователь должен выполнить следующие условия:

• Вызывающий должен быть администратором хранилища метаданных или быть владельцем родительского каталога или родительской схемы, или иметь USE_CATALOG привилегии на родительский каталог и USE_SCHEMA привилегии на родительскую схему.
• Вызывающий объект должен иметь CREATE VOLUME права на родительскую схему.

Для внешнего тома также необходимо выполнить следующие условия:

• Вызывающий объект должен иметь CREATE EXTERNAL VOLUME привилегии на внешнему ресурсу.
• В указанном расположении хранилища отсутствуют другие таблицы и тома. — Указанное расположение хранилища не является подчинённым расположению других таблиц, ни томов, ни каталогов, ни схем.

databricks volumes create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE [flags]

Arguments

CATALOG_NAME

    Имя каталога, в котором находятся схема и том

SCHEMA_NAME

    Имя схемы, в которой находится том данных

NAME

    Имя тома

VOLUME_TYPE

    Тип тома. Внешний том находится в указанном внешнем расположении. Управляемый том находится в расположении по умолчанию, указанном родительской схемой, родительским каталогом или хранилищем метаданных. См. раздел "Управляемые и внешние тома". Поддерживаемые значения: EXTERNAL, MANAGED

Options

--comment string

    Комментарий, прикрепленный к тому.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--storage-location string

    Расположение хранилища в облаке.

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

Examples

В следующем примере создается управляемый том:

databricks volumes create my_catalog my_schema my_volume MANAGED

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

databricks volumes create my_catalog my_schema my_external_volume EXTERNAL --storage-location s3://my-bucket/my-volume --comment "External volume for data processing"

Удалить тома в databricks

Удалите том из указанного родительского каталога и схемы.

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

databricks volumes delete NAME [flags]

Arguments

NAME

    Трехуровневое (полное) имя тома

Options

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

Examples

В следующем примере удаляется том:

databricks volumes delete my_catalog.my_schema.my_volume

список томов databricks

Список томов для текущего хранилища метаданных в родительском каталоге и схеме.

Возвращаемые тома фильтруются на основе привилегий вызывающего пользователя. Например, администратор хранилища метаданных может перечислить все тома. Обычный пользователь должен быть владельцем или иметь READ VOLUME права на том для получения томов в ответе. В последнем случае вызывающий объект также должен быть владельцем или иметь USE_CATALOG привилегии в родительском каталоге и USE_SCHEMA привилегии родительской схемы.

Никакой гарантии упорядочения элементов в массиве нет.

databricks volumes list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    Идентификатор каталога

SCHEMA_NAME

    Идентификатор схемы

Options

--include-browse

    Следует ли включать тома в ответе, для которых основной субъект может получить доступ только к выборочным метаданным.

--max-results int

    Максимальное количество возвращаемых томов (длина страницы).

--page-token string

    Непрозрачный токен, возвращаемый предыдущим запросом.

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

Examples

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

databricks volumes list my_catalog my_schema

объемы данных databricks считываются

Получение тома из хранилища метаданных для определенного каталога и схемы.

Вызывающий объект должен быть администратором хранилища метаданных или владельцем тома (или иметь READ VOLUME права на том). В последнем случае вызывающий объект также должен быть владельцем или иметь USE_CATALOG привилегии в родительском каталоге и USE_SCHEMA привилегии родительской схемы.

databricks volumes read NAME [flags]

Arguments

NAME

    Трехуровневое (полное) имя тома

Options

--include-browse

    Следует ли включать тома в ответе, для которых основной субъект может получить доступ только к выборочным метаданным.

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

Examples

В следующем примере показано, как получить сведения о томе:

databricks volumes read my_catalog.my_schema.my_volume

Следующий пример получает информацию о дисковом томе, включая метаданные просмотра:

databricks volumes read my_catalog.my_schema.my_volume --include-browse

Обновление томов Databricks

Обновите указанный том в указанном родительском каталоге и схеме.

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

В настоящее время можно обновить только имя, владелец или комментарий тома.

databricks volumes update NAME [flags]

Arguments

NAME

    Трехуровневое (полное) имя тома

Options

--comment string

    Комментарий, прикрепленный к тому.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--new-name string

    Новое имя тома.

--owner string

    Идентификатор пользователя, которому принадлежит том.

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

Examples

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

databricks volumes update my_catalog.my_schema.my_volume --comment "Updated comment for my volume"

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

databricks volumes update my_catalog.my_schema.my_volume --owner someone@example.com

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

databricks volumes update my_catalog.my_schema.my_volume --new-name my_new_volume_name

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

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

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