Comandos da CLI do Databricks

Observação

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer disposições de Dados de Uso.

Este artigo apresenta informações sobre os comandos disponíveis na CLI do Databricks. Essas informações complementam a ajuda da linha de comando. Para mais informações sobre como instalar e usar a CLI do Databricks, confira Instalar ou atualizar a CLI do Databricks e O que é a CLI do Databricks?.

A CLI do Databricks inclui os grupos de comandos listados nas tabelas a seguir. Os grupos de comandos contêm os conjuntos de comandos relacionados, que pode também poder conter subcomandos. Para gerar informações sobre uso e sintaxe de um grupo de comandos, um comando individual ou subcomando:

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

Muitos dos comandos da CLI correspondem a operações documentadas na Referência da API REST do Azure Databricks.

Comandos de workspace

Grupo	Descrição e comandos
Fs	Comandos para gerenciar arquivos e o sistema de arquivos: cat, cp, ls, , mkdirrm
git-credentials	Comandos para registrar tokens de acesso pessoais para que o Databricks possa realizar operações em nome do usuário: create, delete, get, , listupdate
repos	Comandos para permitir que os usuários gerenciem seus repositórios git: create, delete, get, , listupdate get-permission-levels, get-permissions, , set-permissionsupdate-permissions
secrets	Comandos para gerenciar segredos, escopos de segredos e permissões de acesso: create-scope, delete-acl, delete-scope, delete-secret, get-aclget-secretlist-aclslist-scopeslist-secretsput-acl,put-secret
workspace	Comandos para listar, importar, exportar e excluir notebooks e pastas no workspace: delete, export, export-dir, get-status, import, import-dir, , list, , mkdirs get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos de computação

Grupo	Descrição e comandos
cluster-policies	Comandos para controlar a capacidade dos usuários de configurar clusters com base em um conjunto de regras: create, delete, edit, , getlist get-permission-levels, get-permissions, , set-permissionsupdate-permissions
clusters	Comandos que permitem criar, iniciar, editar, listar, terminar e excluir clusters: change-owner, create, delete, edit, events, getlistlist-node-typeslist-zonespermanent-deletepinresizerestartspark-versionsstart,unpin get-permission-levels, get-permissions, , set-permissionsupdate-permissions
global-init-scripts	Comandos que possibilitam aos administradores do workspace configurar scripts de inicialização globais para seus workspaces: create, delete, get, , listupdate
instance-pools	Comandos para criar, editar, excluir e listar pools de instâncias por meio de instâncias de nuvem prontas para uso, o que diminui o tempo de início e de dimensionamento automático dos clusters: create, delete, edit, , getlist get-permission-levels, get-permissions, , set-permissionsupdate-permissions
instance-profiles	Comandos para permitir que os administradores adicionem, listem e removam perfis de instância com os quais os usuários podem iniciar clusters com: add, edit, , listremove
libraries	Comandos para instalar, desinstalar e verificar o status das bibliotecas em um cluster: all-cluster-statuses, cluster-status, , installuninstall
policy-families	Comandos para exibir as famílias de políticas disponíveis: get, list

Comandos de trabalhos

Grupo	Descrição e comandos
jobs	Comandos para gerenciar trabalhos: cancel-all-runs, cancel-run, create, delete, delete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmit,update get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos do Lakeflow Declarative Pipelines

Grupo	Descrição e comandos
pipelines	Comandos para criar, editar, excluir, iniciar e exibir detalhes sobre pipelines: create, delete, get, get-update, list-pipeline-eventslist-pipelineslist-updatesstart-updatestop,update get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos do Machine Learning

Grupo	Descrição e comandos
experiments	Comandos para interagir com experimentos, que são a unidade principal da organização no MLflow; todas as execuções do MLflow pertencem a um experimento: create-experiment, create-run, delete-experiment, delete-run, delete-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-permissionsupdate-permissions
model-registry	Comandos para o Registro de Modelo do Workspace (Workspace Model Registry): approve-transition-request, create-comment, create-model, create-model-version, create-transition-requestcreate-webhookdelete-commentdelete-modeldelete-model-tagdelete-model-versiondelete-model-version-tagdelete-transition-requestdelete-webhookget-latest-versionsget-modelget-model-versionget-model-version-download-urilist-modelslist-transition-requestslist-webhooksreject-transition-requestrename-modelsearch-model-versionssearch-modelsset-model-tagset-model-version-tagtest-registry-webhooktransition-stageupdate-commentupdate-modelupdate-model-versionupdate-webhook get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos de serviço em tempo real

Grupo	Descrição e comandos
serving-endpoints	Comandos para criar, atualizar e excluir pontos de extremidade de serviço de modelo: build-logs, create, delete, export-metrics, getlistlogspatchputquery,update-config get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos de gerenciamento de identidade e acesso

Grupo	Descrição e comandos
account	Comandos para gerenciar contas do Databricks: Identidade e acesso: access-control, , groups, service-principals, , usersworkspace-assignment Catálogo do Unity: metastore-assignments, , metastoresstorage-credentials Configurações: ip-access-lists, , network-connectivitysettings Provisionamento: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces Cobrança: billable-usage, log-delivery OAuth: custom-app-integration, o-auth-published-apps, , published-app-integrationservice-principal-secrets
autenticação	Comandos para autenticação: describe, env, login, , profilestoken
current-user	Comandos para recuperar informações sobre o usuário ou a entidade de serviço autenticada no momento: me
groups	Comandos para grupos que simplificam o gerenciamento de identidades, facilitando a atribuição de acesso ao workspace do Databricks, dados e outros objetos protegíveis: create, delete, get, list, patch, , update
permissions	Comandos para criar leitura, gravação, edição, atualização e gerenciamento de acesso de vários usuários em diferentes objetos e pontos de extremidade: get, set, update get-permission-levels
service-principals	Comandos para identidades usadas em trabalhos, ferramentas automatizadas e sistemas, como scripts, aplicativos e plataformas de CI/CD: create, delete, get, list, patch, , update
users	Comandos para identidades de usuário reconhecidas pelo Databricks e representadas por endereços de email: create, delete, get, list, patch, , update get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos relacionados a SQL

Grupo	Descrição e comandos
alerts	Comandos para realizar operações em alertas: create, delete, get, , listupdate
alerts-legacy	Comandos para realizar operações em alertas antigos create, delete, get, , listupdate
data-sources	Comandos para criar novos objetos de consulta: list
queries	Comandos para realizar operações em definições de consulta: create, delete, get, list, restore, , update
queries-legacy	Comandos para executar operações em definições de consulta herdadas: create, delete, get, list, restore, , update
query-history	Comandos para acessar o histórico de consultas por meio de warehouses SQL: list
warehouses	Comandos para gerenciar warehouses SQL, que são um recurso computacional que permite executar comandos SQL em objetos de dados no SQL do Databricks: create, delete, edit, get, get-workspace-warehouse-config, listset-workspace-warehouse-configstart,stop get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Comandos do Unity Catalog

Grupo	Descrição e comandos
artifact-allowlists	Comandos para gerenciar listas de permissões de artefatos. No Databricks Runtime 13.3 e posteriores, você pode adicionar bibliotecas e scripts de inicialização à lista de permissões na UC para que os usuários possam aproveitar esses artefatos na computação configurada com o modo de acesso padrão: get, update
catalogs	Comandos para gerenciar catálogos, a primeira camada do namespace de três níveis do Catálogo do Unity: create, delete, get, , listupdate
credentials	Comandos para gerenciar credenciais, que são o mecanismo de autenticação e autorização para acessar serviços em seu locatário de nuvem. Cada credencial está sujeita a políticas de controle de acesso do Catálogo do Unity que controlam quais usuários e grupos podem acessar a credencial. create-credential, delete-credential, generate-temporary-service-credential, get-credential, list-credentials, update-credential, , validate-credential
connections	Comandos parar criar uma conexão com uma fonte de dados externa: create, delete, get, , listupdate
external-locations	Comandos para administrar locais externos, que combinam um caminho de armazenamento em nuvem com uma credencial de armazenamento que autoriza o acesso a esse caminho: create, delete, get, , listupdate
functions	Comandos para gerenciar UDFs (funções definidas pelo usuário) no Catálogo do Unity: create, delete, get, , listupdate
grants	Comandos para conceder acesso aos dados no Unity Catalog: get, get-effective, update
metastores	Comandos para gerenciar metadados, que são o contêiner de mais alto nível para objetos no Unity Catalog: assign, create, current, delete, getlistsummaryunassignupdate,update-assignment
model-versions	Comandos para gerenciar versões de modelo. O Databricks fornece uma versão hospedada do Registro de Modelo do MLflow no Catálogo do Unity. delete, get, get-by-alias, , listupdate
online-tables	Comandos para gerenciar tabelas online, que oferecem acesso aos dados de tabelas Delta com menor latência e maior taxa de consultas por segundo (QPS): create, delete, get
quality-monitors	Comandos para gerenciar monitores, que calculam e monitoram métricas de qualidade de dados ou modelos para uma tabela ao longo do tempo: create, delete, get, get-refresh, list-refreshes, run-refresh, , update
registered-models	Comandos para gerenciar modelos registrados. O Databricks fornece uma versão hospedada do Registro de Modelo do MLflow no Catálogo do Unity. create, delete, delete-alias, get, list, set-alias, , update
resource-quotas	Comandos para gerenciar cotas de recursos impostas pelo Catálogo do Unity em todos os objetos protegíveis, que limitam o número de recursos que podem ser criados. get-quota, list-quotas
schemas	Comandos para gerenciar esquemas, que são a segunda camada do namespace de três níveis do Catálogo do Unity: create, delete, get, , listupdate
storage-credentials	Comandos para gerenciar credenciais de armazenamento, que são um mecanismo de autenticação e autorização para acessar dados armazenados em seu locatário de nuvem: create, delete, get, list, update, , validate
system-schemas	Comandos para gerenciar esquemas do sistema, que são esquemas que existem dentro do catálogo do sistema: disable, enable, list
table-constraints	Comandos para gerenciar restrições de chave primária e chave estrangeira que definem relações entre os campos em tabelas: create, delete
tables	Comandos para gerenciar tabelas, que residem na terceira camada do namespace de três níveis do Catálogo do Unity: delete, exists, get, , listlist-summaries
temporary-table-credentials	Comandos para gerenciar credenciais de tabela temporárias, que são credenciais com escopo reduzido de curta duração usadas para acessar locais de armazenamento em nuvem onde os dados da tabela estão armazenados no Databricks. generate-temporary-table-credentials
volumes	Comandos para gerenciar volumes, que são uma funcionalidade do Unity Catag (UC) para acessar, armazenar, governar, organizar e processar arquivos: create, delete, list, , readupdate
workspace-bindings	Comandos para gerenciar associações de workspace protegíveis. No Databricks, os protegíveis podem ser configurados como OPEN ou ISOLATED. get, get-bindings, , updateupdate-bindings

Comandos de compartilhamento Delta

Grupo	Descrição e comandos
providers	Comandos para gerenciar provedores de dados, que representam as organizações que compartilham dados: create, delete, get, list, list-shares, , update
recipient-activation	Comandos para gerenciar a ativação do destinatário, que só são aplicáveis no modelo de compartilhamento aberto onde o objeto destinatário possui o tipo de autenticação TOKEN: get-activation-url-info, retrieve-token
recipients	Comandos para gerenciar destinatários, que são criados usando :method:recipients/create para representar uma organização para a qual você deseja permitir acesso aos compartilhamentos: create, delete, get, list, rotate-token, , update share-permissions
shares	Comandos para gerenciar compartilhamentos, que são contêineres instanciados com :method:shares/create: create, delete, get, , listupdate share-permissions, update-permissions

Comandos de configurações

Grupo	Descrição e comandos
ip-access-lists	Comandos que permitem aos administradores configurar listas de acesso IP: create, delete, get, list, replace, , update
notification-destinations	Comandos para gerenciar os destinos de notificação de um workspace: create, delete, get, , listupdate
settings	Comandos que possibilitam aos usuários gerenciar configurações no nível do workspace: automatic-cluster-update, csp-enablement, default-namespace, , esm-enablementrestrict-workspace-admins
token-management	Comandos que permitem aos administradores a obter e excluir tokens de outros usuários: create-obo-token, delete, , getlist get-permission-levels, get-permissions, , set-permissionsupdate-permissions
tokens	Comandos para criar, listar e revogar tokens que podem ser utilizados para autenticação e acesso às APIs REST do Databricks: create, delete, list
workspace-conf	Comandos para atualizar as configurações do workspace: get-status, set-status

Comandos de ferramentas para desenvolvedores

Grupo	Descrição e comandos
Agrupar	Comandos para gerenciar pacotes de ativos do Databricks, que permitem representar seus projetos do Databricks como código: deploy, deployment, destroy, generate, initopenrunschemasummarysync,validate
sincronizar	Sincronizar um diretório local com um diretório de workspace.

Comandos de busca em vetores

Grupo	Descrição e comandos
vector-search-endpoints	Comandos para gerenciar pontos de extremidade de busca em vetores, que representam os recursos computacionais para hospedar índices de busca em vetores: create-endpoint, delete-endpoint, , get-endpointlist-endpoints
vector-search-indexes	Comandos para gerenciar índices de busca em vetores, uma representação eficaz de seus vetores de incorporação que dão suporte a consultas em tempo real e eficientes de busca aproximada de vizinho mais próximo (ANN): create-index, delete-data-vector-index, delete-index, get-index, list-indexes, query-index, , sync-index, , upsert-data-vector-index

Comandos do painel de controle

Grupo	Descrição e comandos
dashboards	Comandos para modificar painéis herdados: create, delete, get, list, restore, , update
genie	Comandos para modificar o Genie, que fornece uma experiência sem código para usuários empresariais, alimentado pela IA/BI: create-message, execute-message-attachment-query, get-message, get-message-attachment-query-result, get-spaced, , start-conversation
lakeview	Comandos que fornecem operações de gerenciamento específicas para painéis de controle IA/BI: create, create-schedule, create-subscription, delete-schedule, delete-subscription, , get, get-published, , get-schedule, get-subscription, list, list-schedules, , list-subscriptions, migrate, , publish, trash, unpublish, update, update-schedule

Comandos do Marketplace

Grupo	Descrição e comandos
consumer-fulfillments	Comandos para gerenciar execuções, que são entidades que permitem aos consumidores pré-visualizar instalações. get, list
consumer-installations	Comandos para gerenciar instalações, que são entidades que permitem que os consumidores interajam com as listagens do Databricks Marketplace. create, delete, list, , list-listing-installationsupdate
consumer-listings	Comandos para gerenciar listagens de consumidores do Databricks Marketplace: batch-get, get, , listsearch
consumer-personalization-requests	Comandos para gerenciar solicitações de personalização, que permitem que os clientes interajam com o fluxo de listagem individualizado do Marketplace. create, get, list
consumer-providers	Comandos para gerenciar provedores, que são as entidades que publicam listagens no Marketplace. batch-get, get, list
provider-exchange-filters	Comandos para gerenciar filtros de plataformas de negociação do Marketplace, que determinam quais grupos podem ter acesso à plataforma de negociação. create, delete, , listupdate
provider-exchanges	Comandos para gerenciar exchanges do Marketplace, que permitem que os provedores compartilhem suas listagens com um conjunto de clientes coletado. add-listing-to-exchange, create, delete, delete-listing-from-exchange, get, listlist-exchanges-for-listinglist-listings-for-exchange,update
provider-files	Comandos para gerenciar arquivos do Marketplace, como notebooks de visualização e ícones de provedor. create, delete, , getlist
provider-listings	Comandos para gerenciar listagens de provedores: create, delete, get, , listupdate
provider-personalization-requests	Comandos para gerenciar solicitações de personalização, que são uma alternativa às listagens disponíveis instantaneamente. list, update
provider-provider-analytics-dashboards	Comandos para gerenciar as análises modeladas para provedores: create, get, , get-latest-versionupdate
provider-providers	Comandos para gerenciar provedores, que gerenciam ativos no Marketplace. create, delete, get, , listupdate

Comandos de aplicativos

Grupo	Descrição e comandos
apps	Comandos para gerenciar aplicativos do Databricks, que são executados diretamente na instância do Databricks, integram-se aos seus dados, usam e estendem os serviços do Databricks e permitem que os usuários interajam por meio do logon único. create, delete, deploy, get, get-deploymentlistlist-deploymentsrun-localstartstop,update

Comandos de salas limpas

Grupo	Descrição e comandos
clean-room-assets	Comandos para gerenciar ativos de sala limpa, que são objetos de dados e código, como tabelas, volumes e notebooks compartilhados com a sala limpa. create, delete, get, , listupdate
clean-room-task-runs	Comandos para gerenciar tarefas na sala limpa, que são as execuções de cadernos de notas em um ambiente controlado. list
clean-rooms	Comandos para administrar salas limpas. As salas limpas usam o compartilhamento Delta e a computação sem servidor para fornecer um ambiente seguro e de proteção de privacidade, em que várias partes podem trabalhar juntas em dados corporativos confidenciais sem acesso direto aos dados uns dos outros. create, create-output-catalog, delete, get, list, , update

Comandos adicionais

Grupo	Descrição e comandos
API	Comandos para fazer solicitações à API REST do Databricks: delete, get, head, patch, post, , put
conclusão	Comandos para gerar o script de preenchimento automático para o shell especificado: bash, fish, , powershellzsh
configurar	Configura a CLI do Databricks.
help	Mostra informações de uso para qualquer comando.
laboratórios	Comandos para gerenciar instalações do Databricks Labs: clear-cache, install, installed, list, show, uninstall, , upgrade
version	Recupere a versão da CLI que está sendo usada atualmente.

Sinalizadores globais

Os sinalizadores a seguir estão disponíveis para todos os comandos da CLI do Databricks. Observe que alguns sinalizadores não se aplicam a alguns comandos. Para informações detalhadas sobre comandos específicos e suas opções, confira a ajuda da linha de comando.

Sinalizador	Descrição
-h ou --help	Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.
-e ou --environment string	Uma cadeia de caracteres que representa o ambiente de pacote a ser usado, se aplicável ao comando relacionado.
--log-file	Uma cadeia de caracteres que representa o para gravar logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.
--log-format	text para gravar logs de saída em texto ou json para gravar logs de saída em JSON. Se esse sinalizador não for especificado, os logs de saída serão gravados como texto.
--log-level	Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desabilitado.
-o ou --output	text para gravar a saída como texto ou json gravar a saída como JSON. Se esse sinalizador não for especificado, a saída será gravada como texto.
-p ou --profile	Uma cadeia de caracteres que representa o perfil de configuração nomeado a ser usado no arquivo .databrickscfg. Se esse sinalizador não for especificado, o perfil nomeado DEFAULT será usado se houver um. Pressione Tab depois de --profile ou -p para visualizar uma lista de perfis de configuração disponíveis existentes para sua escolha, em vez de inserir o nome do perfil de configuração manualmente.
--progress-format	O formato dos logs de progresso a serem exibidos (default (o padrão) ou append ou inplace ou json).