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

Note

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

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

Группа apps команд в интерфейсе командной строки Databricks позволяет управлять приложениями. Приложения выполняются непосредственно на экземпляре Databricks клиента, интегрируются с данными, используют и расширяют службы Databricks и позволяют пользователям взаимодействовать через единый вход. См. статью "Приложения Databricks".

Создание приложений Databricks

Создать новое приложение.

databricks apps create NAME [flags]

Arguments

NAME

    Имя приложения. Имя должно содержать только буквенно-цифровые символы нижнего регистра и дефисы. Он должен быть уникальным в рабочей области.

Options

--budget-policy-id string

    Идентификатор политики бюджета для приложения.

--description string

    Описание приложения.

--json JSON

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

--no-compute

    Если значение true, приложение не будет запущено после создания.

--no-wait

    Не подождите, чтобы достичь состояния ACTIVE.

--timeout duration

    Максимальное время достижения состояния ACTIVE (по умолчанию 20m0s).

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

Examples

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

databricks apps create my-analytics-app --description "Analytics dashboard app"

В следующем примере создается приложение, не запуская его.

databricks apps create my-data-app --description "Data processing app" --no-compute

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

databricks apps create my-ml-app --description "Machine learning app" --timeout 30m

удалить приложения Databricks

Удаление приложения.

databricks apps delete NAME [flags]

Arguments

NAME

    Имя приложения.

Options

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

Examples

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

databricks apps delete my-analytics-app

развертывание Databricks приложений

Создайте развертывание приложения для приложения с указанным именем.

databricks apps deploy APP_NAME [flags]

Arguments

APP_NAME

    Имя приложения.

Options

--deployment-id string

    Уникальный идентификатор развертывания.

--json JSON

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

--mode AppDeploymentMode

    Режим, в котором развертывание будет управлять исходным кодом. Поддерживаемые значения: AUTO_SYNC, SNAPSHOT.

--no-wait

    Не ждите перехода в состояние SUCCEEDED.

--source-code-path string

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

--timeout duration

    Максимальное время достижения состояния SUCCEEDED (по умолчанию 20m0s).

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

Examples

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

databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC

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

databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT

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

databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app

Запрос приложений Databricks

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

databricks apps get NAME [flags]

Arguments

NAME

    Имя приложения.

Options

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

Examples

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

databricks apps get my-analytics-app

Следующий пример получает сведения о приложении в формате JSON:

databricks apps get my-data-app --output json

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

databricks apps get my-ml-app --profile production

Приложения Databricks get-deployment

Получите информацию о развертывании приложения с заданным именем и идентификатором.

databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]

Arguments

APP_NAME

    Имя приложения.

DEPLOYMENT_ID

    Уникальный идентификатор развертывания.

Options

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

Examples

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

databricks apps get-deployment my-analytics-app v1.0.0

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

databricks apps get-deployment my-data-app v2.1.0 --output json

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

databricks apps get-deployment my-ml-app latest --profile production

Список приложений "Databricks"

Вывод списка всех приложений в рабочей области.

databricks apps list [flags]

Arguments

None

Options

--page-size int

    Верхняя граница возвращаемых элементов.

--page-token string

    Токен пагинации для перехода на следующую страницу приложений.

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

Examples

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

databricks apps list

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

databricks apps list --page-size 10

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

databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

databricks apps list-deployments (команда для просмотра развертываний)

Список всех развертываний приложений для приложения с указанным именем.

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    Имя приложения.

Options

--page-size int

    Верхняя граница возвращаемых элементов.

--page-token string

    Токен пагинации для перехода на следующую страницу приложений.

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

Examples

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

databricks apps list-deployments my-analytics-app

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

databricks apps list-deployments my-data-app --page-size 10

Журналы приложений Databricks

Передавайте журналы stdout/stderr для приложения Databricks, используя его поток журналов. По умолчанию эта команда извлекает последние журналы до --tail-lines и завершает выполнение. Фильтрация на стороне сервера доступна с помощью --search, а фильтрация на стороне клиента доступна с помощью --source APP|SYSTEM.

databricks apps logs NAME [flags]

Arguments

NAME

    Имя приложения.

Options

-f, --follow

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

--tail-lines int

    Число последних строк журнала, которые будут отображаться перед потоковой передачей. Установите на 0, чтобы показать все. По умолчанию: 200

--timeout duration

    Максимальное время потоковой передачи, когда --follow установлен. Установите 0 для отключения времени ожидания.

--search string

    Перед потоковой передачей отправьте поисковый термин в службу журналов.

--source strings

    Ограничить журналы источниками APP или SYSTEM.

--output-file string

    Необязательный путь к файлу для записи журналов в дополнение к stdout.

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

Examples

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

databricks apps logs my-analytics-app

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

databricks apps logs my-analytics-app --follow

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

databricks apps logs my-data-app --tail-lines 500

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

databricks apps logs my-ml-app --follow --timeout 10m

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

databricks apps logs my-analytics-app --search "error"

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

databricks apps logs my-data-app --source APP

В следующем примере журналы записываются как в stdout, так и в файл:

databricks apps logs my-ml-app --output-file /tmp/app-logs.txt

Приложения Databricks выполняются в локальном режиме.

Запустите приложение локально.

databricks apps run-local [flags]

Arguments

None

Options

--app-port int

    Порт, на котором нужно запустить приложение (по умолчанию 8000).

--debug

    Включите режим отладки.

--debug-port string

    Порт, на котором будет запущен отладчик.

--entry-point string

    Укажите настраиваемую точку входа с конфигурацией (.yml файлом) для приложения. По умолчанию — app.yml.

--env strings

    Задайте переменные среды.

--port int

    Порт для запуска прокси-сервера приложения (по умолчанию используется 8001).

--prepare-environment

    Подготавливает среду для запуска приложения. Требуется установить uv.

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

Examples

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

databricks apps run-local

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

databricks apps run-local --app-port 9000 --port 9001

Запуск приложений Databricks

Запустите последнее активное развертывание приложения в рабочей области.

databricks apps start NAME [flags]

Arguments

NAME

    Имя приложения.

Options

--no-wait

    Не подождите, чтобы достичь состояния ACTIVE.

--timeout duration

    Максимальное время достижения состояния ACTIVE (по умолчанию 20m0s).

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

Examples

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

databricks apps start my-analytics-app

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

databricks apps start my-data-app --no-wait

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

databricks apps start my-ml-app --timeout 30m

Остановка приложений Databricks

Остановите активное развертывание приложения в рабочей области.

databricks apps stop NAME [flags]

Arguments

NAME

    Имя приложения.

Options

--no-wait

    Не ждите, пока система достигнет состояния STOPPED.

--timeout duration

    Максимальное время достижения состояния ОСТАНОВЛЕННОГО (по умолчанию 20m0s).

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

Examples

Следующий пример останавливает приложение:

databricks apps stop my-analytics-app

В следующем примере приложение останавливается без ожидания.

databricks apps stop my-data-app --no-wait

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

databricks apps stop my-ml-app --timeout 30m

обновление приложений Databricks

Обновите приложение с указанным именем.

databricks apps update NAME [flags]

Arguments

NAME

    Имя приложения. Имя должно содержать только буквенно-цифровые символы нижнего регистра и дефисы. Он должен быть уникальным в рабочей области.

Options

--budget-policy-id string

    Идентификатор политики бюджета для приложения.

--description string

    Описание приложения.

--json JSON

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

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

Examples

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

databricks apps update my-analytics-app --description "Updated analytics dashboard"

получение уровней разрешений в приложениях Databricks

Получение уровней разрешений приложения.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    Приложение, для которого нужно получить или управлять разрешениями.

Options

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

Examples

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

databricks apps get-permission-levels my-analytics-app

команды databricks apps get-permissions

Получить разрешения приложения. Приложения могут наследовать разрешения от корневого объекта.

databricks apps get-permissions APP_NAME [flags]

Arguments

APP_NAME

    Приложение, для которого нужно получить или управлять разрешениями.

Options

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

Examples

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

databricks apps get-permissions my-analytics-app

В следующем примере получение разрешений осуществляется с использованием определенного профиля.

databricks apps get-permissions my-ml-app --profile production

установка разрешений для приложений Databricks

Задайте разрешения приложения.

Задает разрешения для объекта, заменив существующие разрешения, если они существуют. Удаляет все прямые разрешения, если они не указаны. Объекты могут наследовать разрешения от корневого объекта.

databricks apps set-permissions APP_NAME [flags]

Arguments

APP_NAME

    Приложение, для которого нужно получить или управлять разрешениями.

Options

--json JSON

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

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

Examples

В следующем примере задаются разрешения с помощью конфигурации JSON:

databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

приложения databricks обновить-правила доступа

Обновите разрешения для приложения. Приложения могут наследовать разрешения от корневого объекта.

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    Приложение, для которого нужно получить или управлять разрешениями.

Options

--json JSON

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

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

Examples

В следующем примере обновляются разрешения с помощью конфигурации JSON:

databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

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

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

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