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, mkdir, rm
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, list, update
repos	Comandos para permitir que os usuários gerenciem seus repositórios git: create, delete, get, list, update get-permission-levels, get-permissions, set-permissions, update-permissions
secrets	Comandos para gerenciar segredos, escopos de segredos e permissões de acesso: create-scope, delete-acl, delete-scope, delete-secret, get-acllist-secretsget-secretlist-scopeslist-aclsput-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-permissions, update-permissions

Comandos de computação

Grupo	Descrição e comandos
cluster-policies	Comandos para controlar a capacidade dos usuários de configurar clusters baseados em um conjunto de regras: create, delete, edit, get, list get-permission-levels, get-permissions, set-permissions, update-permissions
clusters	Comandos que permitem criar, iniciar, editar, listar, terminar e excluir clusters: change-owner, create, delete, edit, events, getpermanent-deletelistresizelist-node-typesspark-versionslist-zonesrestartpinstart,unpin get-permission-levels, get-permissions, set-permissions, update-permissions
global-init-scripts	Comandos que possibilitam aos administradores do workspace configurar scripts de inicialização globais para seus workspaces: create, delete, get, list, update
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, get, list get-permission-levels, get-permissions, set-permissions, update-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, list, remove
libraries	Comandos para instalar, desinstalar e verificar o status das bibliotecas em um cluster: all-cluster-statuses, cluster-status, install, uninstall
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-runget-run-outputlistlist-runsexport-runresetgetsubmitget-runrepair-runrun-now,update get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos do Delta Live Tables

Grupo	Descrição e comandos
pipelines	Comandos para criar, editar, excluir, iniciar e exibir detalhes sobre pipelines: create, delete, get, get-update, list-pipeline-eventsstoplist-pipelineslist-updatesstart-update,update get-permission-levels, get-permissions, set-permissions, update-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-permissions, update-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-permissions, update-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, getputlistpatchlogsquery,update-config get-permission-levels, get-permissions, set-permissions, update-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, users, workspace-assignment - Catálogo do Unity: metastore-assignments, metastores, storage-credentials - Configurações: ip-access-lists, network-connectivity, settings - 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-integration, service-principal-secrets
auth	Comandos para autenticação: describe, env, login, profiles, token
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-permissions, update-permissions

Comandos relacionados a SQL

Grupo	Descrição e comandos
alerts	Comandos para realizar operações em alertas: create, delete, get, list, update
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
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-permissions, update-permissions

Comandos do Unity Catalog

Grupo	Descrição e comandos
artifact-allowlists	Comandos para gerenciar listas de permissões de artefatos. A partir do Databricks Runtime 13.3 em diante, é possível adicionar bibliotecas e scripts de inicialização à lista de permissões no UC, permitindo que os usuários usem esses artefatos em ambientes de computação configurados com modo de acesso compartilhado: get, update
catalogs	Comandos para gerenciar catálogos, a primeira camada do namespace de três níveis do Unity Catalog: create, delete, get, list, update
connections	Comandos parar criar uma conexão com uma fonte de dados externa: create, delete, get, list, update
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, list, update
functions	Comandos para gerenciar Funções Definidas pelo Usuário (UDFs) no Unity Catalog: create, delete, get, list, update
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, getupdatelistsummaryunassign,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, list, update
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
schemas	Comandos para gerenciar esquemas, que são a segunda camada do namespace de três níveis do Unity Catalog: create, delete, get, list, update
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 se encontram na terceira camada do namespace de três níveis do Unity Catalog. delete, exists, get, list, list-summaries
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, read, update
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, update, update-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, list, update 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
settings	Comandos que possibilitam aos usuários gerenciar configurações no nível do workspace: automatic-cluster-update, csp-enablement, default-namespace, esm-enablement, restrict-workspace-admins
token-management	Comandos que permitem aos administradores a obter e excluir tokens de outros usuários: create-obo-token, delete, get, list get-permission-levels, get-permissions, set-permissions, update-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
bundle	Comandos para gerenciar pacotes de ativos do Databricks, que permitem representar seus projetos do Databricks como código: deploy, deployment, destroy, generate, initsummaryopenschemarunsync,validate
sync	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-endpoint, list-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 painéis de controle : create, delete, get, list, restore, , update
lakeview	Comandos que fornecem operações de gerenciamento específicas para painéis de controle IA/BI: create, get, get-published, migrate, publish, trash, , unpublish, , update

Comandos adicionais

Grupo	Descrição e comandos
api	Comandos para fazer solicitações à API REST do Databricks: delete, get, head, patch, post, , put
completion	Comandos para gerar o script de preenchimento automático para o shell especificado: bash, fish, powershell, zsh
configure	Configura a CLI do Databricks.
help	Mostra informações de uso para qualquer comando.
labs	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).