Команды CLI Databricks

Note

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

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

В этой статье содержатся сведения о доступных командах CLI Databricks. Эта информация дополняет справку командной строки. Дополнительные сведения об установке и использовании интерфейса командной строки Databricks см. в разделе "Установка или обновление интерфейса командной строки Databricks" и "Что такое интерфейс командной строки Databricks?".

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

• databricks <command-group> -h
• databricks <command-group> <command-name> -h
• databricks <command-group> <command-name> <subcommand-name> -h

Многие команды CLI сопоставляются с операциями, которые описаны в справочнике по REST API Azure Databricks.

Команды рабочей области

Group	Описание и команды
fs	Команды для управления файлами и файловой системой: cat, , cpls, mkdirrm
Учетные данные git	Команды для регистрации личных маркеров доступа для Databricks для выполнения операций от имени пользователя: create, , deleteget, listupdate
repos	Команды, позволяющие пользователям управлять репозиториями Git: create, , deleteget, listupdate get-permission-levels get-permissions set-permissions update-permissions
secrets	Команды для управления секретами, областями секретов и разрешениями доступа: create-scope, delete-acl, delete-scopedelete-secretget-aclget-secretlist-aclslist-scopeslist-secretsput-aclput-secret
workspace	Команды для перечисления, импорта, экспорта и удаления записных книжек и папок в рабочей области: delete, export, export-dirget-statusimportimport-dirlistmkdirs get-permission-levels get-permissions set-permissions update-permissions

Команды вычислений

Group	Описание и команды
Политики кластера	Команды для управления способностью пользователей настраивать кластеры на основе набора правил: create, , deleteedit, getlist get-permission-levels get-permissions set-permissions update-permissions
clusters	Команды, позволяющие создавать, запускать, изменять, перечислять, завершать и удалять кластеры: change-owner, create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete, pin, resize, restart, spark-versions, start, unpin get-permission-levels get-permissions set-permissions update-permissions
global-init-scripts	Команды, позволяющие администраторам рабочих областей настраивать сценарии глобальной инициализации для своей рабочей области: create, , deleteget, listupdate
пулы экземпляров	Команды для создания, редактирования, удаления и перечисления пулов экземпляров с использованием готовых к использованию облачных экземпляров, что позволяет сократить время запуска кластера и автоматического масштабирования: create, , deleteedit, getlist get-permission-levels get-permissions set-permissions update-permissions
Профили экземпляров	Команды, которые позволяют администраторам добавлять, просматривать и удалять профили экземпляров, с помощью которых пользователи могут запускать кластеры: add edit list remove
Библиотеки	Команды для установки, удаления и получения состояния библиотек в кластере: all-cluster-statuses cluster-status install uninstall
семейства политик	Команды для просмотра доступных семейств политик: get, list

Команды заданий

Group	Описание и команды
jobs	Команды для управления заданиями: cancel-all-runs, cancel-runcreatedeletedelete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdate get-permission-levels get-permissions set-permissions update-permissions

Команды декларативных конвейеров Lakeflow Spark

Group	Описание и команды
pipelines	Команды для создания, редактирования, удаления, запуска и просмотра сведений о конвейерах: create, delete, getget-updatelist-pipeline-eventslist-pipelineslist-updatesstart-updatestopupdate get-permission-levels get-permissions set-permissions update-permissions

команды машинного обучения

Group	Описание и команды
experiments	Команды для взаимодействия с экспериментами, которые являются основным подразделением организации в MLflow; Все запуски MLflow относятся к эксперименту: create-experiment create-run, delete-experimentdelete-rundelete-runsdelete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run get-permission-levels get-permissions set-permissions update-permissions
проектирование признаков	Команды для взаимодействия с функциями в Хранилище компонентов Databricks, который предоставляет центральный реестр для функций, используемых в моделях искусственного интеллекта и машинного обучения. create-feature, , delete-featureget-feature, list-featuresupdate-feature
реестр моделей	Команды для реестра моделей рабочей области: approve-transition-request, create-comment, create-model, create-model-version, create-transition-request, create-webhook, delete-comment, delete-model, delete-model-tag, delete-model-version, delete-model-version-tag, delete-transition-request, delete-webhook, get-latest-versions, get-model, get-model-version, get-model-version-download-uri, list-models, list-transition-requests, list-webhooks, reject-transition-request, rename-model, search-model-versions, search-models, set-model-tag, set-model-version-tag, test-registry-webhook, transition-stage, update-comment, update-model, update-model-version, update-webhook get-permission-levels get-permissions set-permissions update-permissions

Команды обслуживания в режиме реального времени

Group	Описание и команды
обслуживающие конечные точки	Команды для создания, обновления и удаления конечных точек обслуживания моделей: build-logs, create, deleteexport-metricsgetlistlogspatchputqueryupdate-config get-permission-levels get-permissions set-permissions update-permissions

Команды управления удостоверениями и доступом

Group	Описание и команды
account	Команды для управления учетными записями Databricks: Удостоверение и доступ: access-control, groups, service-principals, users, workspace-assignment Каталог Unity: metastore-assignments, metastores, storage-credentials Параметры: ip-access-lists, network-connectivity, settings Подготовка: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces Выставление счетов: billable-usage, log-delivery OAuth: custom-app-integration, o-auth-published-apps, published-app-integrationservice-principal-secrets
auth	Команды для проверки подлинности: describe, , envlogin, profilestoken
current-user	Команды для получения сведений о пользователе или субъекте-службе, прошедших проверку подлинности: me
groups	Команды для групп, упрощающих управление удостоверениями, что упрощает назначение доступа к рабочей области Databricks, данным и другим защищаемым объектам: create, , deletegetlistpatch,update
permissions	Команды для создания доступа для чтения, записи, редактирования, обновления и управления доступом для различных пользователей в различных объектах и конечных точках: get, , setupdate get-permission-levels
субъекты-службы	Команды для управления идентификаторами, используемыми в задачах, автоматизированных инструментах и системах, таких как скрипты, приложения и платформы CI/CD. create, , deletegetlistpatch,update
users	Команды для удостоверений пользователей, распознаваемых системой Databricks и представленных адресами электронной почты: create, , deletegetlistpatch,update get-permission-levels get-permissions set-permissions update-permissions

Команды, связанные с SQL

Group	Описание и команды
alerts	Команды для выполнения операций с оповещениями: create, , deleteget, listupdate
устаревшие оповещения	Команды для выполнения операций с устаревшими оповещениями: create, , deleteget, listupdate
источники данных	Команды для создания новых объектов запроса: list
queries	Команды для выполнения операций с определениями запросов: create, , deletegetlistrestore,update
запросы устаревших систем	Команды для выполнения операций с устаревшими определениями запросов: create, , deletegetlistrestore,update
журнал запросов	Команды для доступа к журналу запросов через хранилища SQL: list
Склады	Команды для управления хранилищами SQL, которые являются вычислительным ресурсом, который позволяет выполнять команды SQL на объектах данных в Databricks SQL: create, deleteeditgetget-workspace-warehouse-configlistset-workspace-warehouse-configstartstop get-permission-levels get-permissions set-permissions update-permissions

Команды каталога Unity

Group	Описание и команды
Артефакты-списки разрешений	Команды для управления списками разрешённых артефактов. В Databricks Runtime 13.3 и более поздних версиях можно добавлять библиотеки и скрипты инициализации в список разрешений в UC, чтобы пользователи могли использовать эти артефакты для вычислений, настроенных в стандартном режиме доступа: get, update
catalogs	Команды для управления каталогами— первый уровень трехуровневого пространства имен каталога Unity: create, , deleteget, listupdate
верительные грамоты	Команды для управления учетными данными, которые являются механизмом проверки подлинности и авторизации для доступа к службам в вашем облачном клиенте. Все учетные данные подлежат политикам управления доступом каталога Unity, которые управляют доступом пользователей и групп к учетным данным. create-credential, delete-credential, generate-temporary-service-credentialget-credentiallist-credentialsupdate-credentialvalidate-credential
connections	Команды для создания подключения к внешнему источнику данных: create, , deleteget, listupdate
external-locations	Команды для управления внешними расположениями, которые объединяют путь к облачному хранилищу с учетными данными хранения, которые разрешают доступ к пути к облачному хранилищу: create, , deleteget, listupdate
functions	Команды для управления определяемыми пользователем функциями в каталоге Unity: create, , deleteget, listupdate
grants	Команды для предоставления доступа к данным в каталоге Unity: get, , get-effectiveupdate
хранилища метаданных	Команды для управления хранилищами метаданных, которые являются контейнером верхнего уровня объектов в каталоге Unity: assign, create, currentdeletegetlistsummaryunassignupdateupdate-assignment
версии модели	Команды для управления версиями модели. Databricks предоставляет размещенную версию реестра моделей MLflow в каталоге Unity. delete, , getget-by-alias, listupdate
онлайн-таблицы	Команды для управления онлайн-таблицами, которые обеспечивают меньшую задержку и более высокую пропускную способность запросов для доступа к данным из таблиц Delta. create, , deleteget
мониторы качества	Команды для управления мониторами, которые вычисляют и отслеживают данные или метрики качества модели для таблицы с течением времени: create, delete, getget-refreshlist-refreshesrun-refreshupdate
зарегистрированные модели	Команды для управления зарегистрированными моделями. Databricks предоставляет размещенную версию реестра моделей MLflow в каталоге Unity. create, delete, delete-aliasgetlistset-aliasupdate
квоты ресурсов	Команды для управления квотами ресурсов, применяемыми каталогом Unity для всех защищаемых объектов, которые ограничивают количество ресурсов, которые можно создать. get-quota, list-quotas
schemas	Команды для управления схемами, которые являются вторым слоем трехуровневого пространства имен каталога Unity: create, , deleteget, listupdate
учетные данные для доступа к хранилищу	Команды для управления учетными данными хранилища, которые являются механизмом проверки подлинности и авторизации для доступа к данным, хранящимся в вашем облачном клиенте: create, , deletegetlistupdate,validate
системные схемы	Команды для управления системными схемами, которые являются схемами, которые находятся в системных каталогах: disable, , enablelist
ограничения таблицы	Команды для управления ограничениями первичного ключа и внешнего ключа, которые кодируют связи между полями в таблицах: create, delete
tables	Команды для управления таблицами, которые находятся на третьем уровне трехуровневого пространства имен каталога Unity: delete, , existsget, listlist-summaries
временные учетные данные для таблицы	Команды для управления временными учетными данными таблиц, которые являются кратковременными, ограниченными по доступу учетными данными, используемыми для доступа к местам облачного хранилища, где данные таблицы хранятся в Databricks. generate-temporary-table-credentials
volumes	Команды для управления томами, которые являются возможностью каталога Unity (UC) для доступа, хранения, управления, организации и обработки файлов: create, , deletelist, readupdate
привязки рабочей области	Команды для управления защищаемыми привязками рабочей области. Защищаемые объекты в Databricks можно настроить как OPEN или ISOLATED. get get-bindings update update-bindings

Команды Delta Sharing

Group	Описание и команды
providers	Команды для управления поставщиками данных, которые представляют организации, которым предоставляется общий доступ к данным: create, , deletegetlistlist-shares,update
активация получателя	Команды для управления активацией получателя, которая применима только в открытой модели общего доступа, где объект получателя имеет тип проверки подлинности TOKEN: get-activation-url-info, retrieve-token
recipients	Команды для управления получателями, которые вы создаете с помощью :method:recipients/create, чтобы обозначить организацию, которой вы хотите предоставить доступ к общим ресурсам: create, , deletegetlistrotate-token,update share-permissions
акции	Команды для управления общими ресурсами, которые являются контейнерами, созданными с помощью :method:shares/create: create, , deletegetlistlist-shares,update share-permissions, update-permissions

Команды параметров

Group	Описание и команды
Ip-доступ-листы	Команды, позволяющие администраторам настраивать списки IP-доступа: create, , deletegetlistreplace,update
адресаты уведомлений	Команды для управления местами назначения уведомлений рабочей области. create, , deleteget, listupdate
settings	Команды, позволяющие пользователям управлять параметрами на уровне рабочей области: automatic-cluster-update, , csp-enablementdefault-namespace, esm-enablementrestrict-workspace-admins
Управление токенами	Команды, позволяющие администраторам получать все маркеры и удалять маркеры для других пользователей: create-obo-token delete get list get-permission-levels get-permissions set-permissions update-permissions
Токены	Команды для создания, перечисления и отзыва маркеров, которые можно использовать для проверки подлинности и доступа к REST API Databricks: create, , deletelist
workspace-conf	Команды для обновления параметров рабочей области: get-status, set-status

Команды инструментов разработчика

Group	Описание и команды
bundle	Команды для управления пакетами активов Databricks, которые позволяют выразить проекты Databricks в виде кода: deploy, deployment, destroygenerateinitopenplanrunschemasummarysyncvalidate
sync	Синхронизация локального каталога с каталогом рабочей области.

Команды поиска векторов

Group	Описание и команды
vector-search-endpoints	Команды для управления конечными точками векторного поиска, которые представляют вычислительные ресурсы для индексов векторного поиска: create-endpoint delete-endpoint get-endpoint list-endpoints
vector-search-indexes	Команды для управления индексами векторного поиска, представляющими ваши векторы встраивания, которые обеспечивают поддержку запросов поиска в реальном времени и эффективные запросы поиска приблизительных ближайших соседей (ANN). create-index, delete-data-vector-index, delete-indexget-indexlist-indexesquery-indexsync-indexupsert-data-vector-index

Команды панели мониторинга

Group	Описание и команды
dashboards	Команды для изменения устаревших панелей мониторинга: create, , deletegetlistrestore,update
genie	Команды для изменения Genie, которая предоставляет возможности без программирования для бизнес-пользователей, с использованием ИИ/BI. create-message, , execute-message-attachment-queryget-messageget-message-attachment-query-resultget-spaced,start-conversation
lakeview	Команды, предоставляющие определенные операции управления для панелей мониторинга AI/BI: create, create-schedulecreate-subscriptiondelete-scheduledelete-subscriptiongetget-publishedget-scheduleget-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublishupdateupdate-schedule

Команды Marketplace

Group	Описание и команды
выполнение потребительских заказов	Команды для управления исполнениями, которые являются сущностями, позволяющими потребителям предварительно просматривать установки. get, list
потребительские установки	Команды для управления инсталляциями, являющимися сущностями, позволяющими потребителям взаимодействовать с предложениями Databricks Marketplace. create, , deletelist, list-listing-installationsupdate
перечисления потребителей	Команды для управления списками потребителей Databricks Marketplace: batch-get get list search
запросы на персонализацию потребителей	Команды для управления запросами персонализации, которые позволяют клиентам взаимодействовать с индивидуализированным процессом размещения в Marketplace. create, , getlist
поставщики-потребители	Команды для управления провайдерами, которые являются субъектами, публикующими объявления на торговой площадке. batch-get, , getlist
фильтры provider-exchange	Команды для управления фильтрами обменов на Marketplace, которые определяют, какие группы могут получить доступ к обмену. create delete list update
Provider-exchanges	Команды для управления обменами Marketplace, которые позволяют поставщикам обмениваться своими списками с проверенным набором клиентов. add-listing-to-exchange, createdeletedelete-listing-from-exchangegetlistlist-exchanges-for-listinglist-listings-for-exchangeupdate
Provider-files	Команды для управления файлами Marketplace, такими как предпросмотр записных книжек и значки поставщика. create delete get list
список поставщиков	Команды для управления списками поставщиков: create, , deleteget, listupdate
запросы на персонализацию поставщика	Команды для управления запросами персонализации, которые являются альтернативными для мгновенно доступных списков. list, update
провайдер-провайдер-аналитические-панели	Команды для управления шаблонной аналитикой для поставщиков: create get get-latest-version update
поставщик-поставщики	Команды для управления поставщиками, которые управляют ресурсами в Marketplace. create, , deleteget, listupdate

Команды приложений

Group	Описание и команды
apps	Команды для управления приложениями Databricks, которые выполняются непосредственно на экземпляре Databricks, интегрируются с данными, используют и расширяют службы Databricks и позволяют пользователям взаимодействовать через единый вход. create, delete, deploygetget-deploymentlistlist-deploymentslogsrun-localstartstopupdate

Команды очистки комнат

Group	Описание и команды
активы чистых помещений	Команды для управления ресурсами чистых помещений, к которым относятся такие объекты данных и кода, как таблицы, тома и записные книжки, которые предоставляются чистой комнате. create, , deleteget, listupdate
запуски задач в чистой комнате	Команды для управления выполнением задачи "Чистая комната", которые являются выполнением записных книжек в чистом помещении. list
чистые комнаты	Команды для управления чистыми комнатами. Чистые комнаты используют Delta Sharing и бессерверные вычисления для создания безопасной среды с защитой конфиденциальности, в которой несколько сторон могут совместно работать с чувствительными корпоративными данными без получения прямого доступа к данным друг друга. create, , create-output-catalogdeletegetlist,update

Команды базы данных

Group

Описание и команды

база данных

Команды для управления экземплярами базы данных Lakebase. create-database-catalog, create-database-instancecreate-database-tablecreate-synced-database-tabledelete-database-catalogdelete-database-instancedelete-database-tabledelete-synced-database-tablefind-database-instance-by-uidgenerate-database-credentialget-database-catalogget-database-instanceget-database-tableget-synced-database-tablelist-database-instancesupdate-database-instance

Дополнительные команды

Group	Описание и команды
api	Команды для выполнения запросов к REST API Databricks: delete, , getheadpatchpost,put
completion	Команды для создания скрипта автозаполнения для указанной оболочки: bash fish powershell zsh
configure	Настройте интерфейс командной строки Databricks.
help	Выходные сводки для всех команд CLI Databricks.
labs	Команды для управления установками Databricks Labs: clear-cache, install, installedlistshowuninstallupgrade
version	Получите версию используемого интерфейса командной строки.

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

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

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

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