Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Note
Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Pré-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 fornece informações sobre os comandos disponíveis da CLI do Databricks. Essas informações complementam a ajuda da linha de comando. Para obter mais informações sobre como instalar e usar a CLI do Databricks, consulte 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 conjuntos de comandos relacionados, que também podem conter subcomandos. Para obter informações de uso e sintaxe de saída para um grupo de comandos, um comando individual ou subcomando:
databricks <command-group> -hdatabricks <command-group> <command-name> -hdatabricks <command-group> <command-name> <subcommand-name> -h
Muitos comandos da CLI correspondem a operações documentadas na referência da API REST do Azure Databricks.
Comandos de espaço de trabalho
| Group | Descrição e comandos |
|---|---|
| fs | Comandos para gerenciar arquivos e o sistema de arquivos:cat, cp, ls, mkdir, rm |
| git-credenciais | Comandos para registrar tokens de acesso pessoais para que o Databricks faça 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, updateget-permission-levels, get-permissions, set-permissions, update-permissions |
| secrets | Comandos para gerenciar segredos, escopos secretos e permissões de acesso:create-scope, delete-acl, , delete-scopedelete-secret, get-acl, get-secret, list-acls, list-scopeslist-secretsput-aclput-secret |
| workspace | Comandos para listar, importar, exportar e excluir blocos de anotações e pastas no espaço de trabalho:delete, export, export-dir, get-statusimport, import-dir, list, mkdirsget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos de computação
| Group | Descrição e comandos |
|---|---|
| políticas de cluster | Comandos para controlar a capacidade dos usuários de configurar clusters com base em um conjunto de regras:create, delete, edit, get, listget-permission-levels, get-permissions, set-permissions, update-permissions |
| clusters | Comandos que permitem criar, iniciar, editar, listar, encerrar e excluir clusters:change-owner, create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete, pin, resize, restart, spark-versions, start, unpinget-permission-levels, get-permissions, set-permissions, update-permissions |
| global-init-scripts | Comandos que permitem que os administradores de espaço de trabalho configurem scripts de inicialização global para seu espaço de trabalho:create, delete, get, list, update |
| Pools-instâncias | Comandos para criar, editar, excluir e listar pools de instâncias usando instâncias de nuvem prontas para uso, o que reduz os tempos de início do cluster e de dimensionamento automático:create, delete, edit, get, listget-permission-levels, get-permissions, set-permissions, update-permissions |
| Perfis de instância | Comandos para permitir que os administradores adicionem, listem e removam perfis de instância com os quais os usuários podem iniciar clusters:add, edit, list, remove |
| Bibliotecas | Comandos para instalar, desinstalar e obter o status das bibliotecas em um cluster:all-cluster-statuses, cluster-status, install, uninstall |
| famílias políticas | Comandos para visualizar as famílias de políticas disponíveis:get, list |
Comandos de tarefas
| Group | Descrição e comandos |
|---|---|
| jobs | Comandos para gerenciar trabalhos:cancel-all-runs, cancel-run, , create, , deletedelete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdateget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos de Pipelines Declarativos do Lakeflow Spark
| Group | Descrição e comandos |
|---|---|
| pipelines | Comandos para criar, editar, excluir, iniciar e exibir detalhes sobre pipelines:create, delete, , get, get-update, list-pipeline-eventslist-pipelines, list-updates, start-updatestop,updateget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos de Aprendizagem Automática
| Group | Descrição e comandos |
|---|---|
| experiments | Comandos para interagir com experimentos, que são a unidade primária de organização no MLflow; todas as execuções MLflow pertencem a um experimento:create-experiment, , , , , create-rundelete-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-runget-permission-levels, get-permissions, set-permissions, update-permissions |
| engenharia de recursos | Comandos para interagir com recursos no Databricks Feature Store, que fornece um registro central para recursos usados em seus modelos de IA e ML.create-feature, delete-feature, get-feature, list-features, update-feature |
| modelo-registo | Comandos para o Registro do Modelo de Espaço de Trabalho: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-webhookget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos de serviço em tempo real
| Group | Descrição e comandos |
|---|---|
| pontos finais de serviço | Comandos para criar, atualizar e excluir pontos finais de serviço de modelos:build-logs, create, , deleteexport-metrics, get, list, logs, patchputqueryupdate-configget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos de gerenciamento de identidade e acesso
| Group | Descrição e comandos |
|---|---|
| account | Comandos para gerenciar contas Databricks:
|
| auth | Comandos para autenticação:describe, env, login, profiles, token |
| usuário-atual | Comandos para recuperar informações sobre o usuário ou 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 espaço de trabalho, dados e outros objetos protegíveis do Databricks:create, delete, get, list, patch, update |
| permissions | Comandos para criar, ler, escrever, editar, atualizar e gerir o acesso de vários utilizadores em diferentes objetos e endpoints.get, set, updateget-permission-levels |
| Entidades de serviço | Comandos para identidades para uso com 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 e-mail:create, delete, get, list, patch, updateget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos relacionados ao SQL
| Group | Descrição e comandos |
|---|---|
| alerts | Comandos para executar operações em alertas:create, delete, get, list, update |
| alertas-legado | Comandos para executar operações em alertas herdados:create, delete, get, list, update |
| fontes de dados | Comandos para criar novos objetos de consulta:list |
| queries | Comandos para executar operações em definições de consulta:create, delete, get, list, restore, update |
| consultas-legado | Comandos para executar operações em definições de consulta herdadas:create, delete, get, list, restore, update |
| histórico de consultas | Comandos para acessar o histórico de consultas por meio de armazéns SQL:list |
| Armazéns | Comandos para gerenciar armazéns SQL, que são um recurso de computação que permite executar comandos SQL em objetos de dados no Databricks SQL:create, delete, edit, get, get-workspace-warehouse-configlist, set-workspace-warehouse-config, start, stopget-permission-levels, get-permissions, set-permissions, update-permissions |
Comandos do Catálogo Unity
| Group | Descrição e comandos |
|---|---|
| listas de permissões de artefactos | Comandos para gerir listas permitidas de artefatos. No Databricks Runtime 13.3 e superior, 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 Unity Catalog:create, delete, get, list, update |
| Credenciais | 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 às políticas de controle de acesso do Catálogo 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 para criar uma conexão com uma fonte de dados externa:create, delete, get, list, update |
external-locations |
Comandos para gerenciar locais externos, que combinam um caminho de armazenamento em nuvem com uma credencial de armazenamento que autoriza o acesso ao caminho de armazenamento em nuvem: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 |
| metalojas | Comandos para gerenciar metastores, que são o contêiner de nível superior de objetos no Unity Catalog:assign, create, , current, delete, getlist, summary, unassignupdate,update-assignment |
| Versões-modelo | Comandos para gerenciar versões de modelos. O Databricks fornece uma versão hospedada do MLflow Model Registry no Unity Catalog.delete, get, get-by-alias, list, update |
| mesas-online | Comandos para gerenciar tabelas online, que fornecem menor latência e maior acesso QPS aos dados de tabelas Delta:create, delete, get |
| Monitores de Qualidade | Comandos para gerir monitores, que computam e monitorizam métricas de qualidade de dados ou de modelos para uma tabela ao longo do tempo.create, delete, get, get-refresh, list-refreshes, run-refresh, update |
| modelos registados | Comandos para gerenciar modelos registrados. O Databricks fornece uma versão hospedada do MLflow Model Registry no Unity Catalog.create, delete, delete-alias, get, list, set-alias, update |
| quotas de recursos | Comandos para gerenciar cotas de recursos impostas pelo Unity Catalog 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 Unity Catalog:create, delete, get, list, update |
| Credenciais de armazenamento | 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 |
| esquemas do sistema | Comandos para gerenciar esquemas do sistema, que são esquemas que vivem dentro do catálogo do sistema:disable, enable, list |
| restrições de tabela | Comandos para gerenciar restrições de chave primária e chave estrangeira que codificam relações entre campos em tabelas:create, delete |
| tables | Comandos para gerenciar tabelas, que reside na terceira camada do namespace de três níveis do Unity Catalog:delete, exists, get, list, list-summaries |
| credenciais temporárias da tabela | Comandos para gerenciar credenciais de tabela temporárias, que são credenciais de curta duração e com escopo reduzido usadas para acessar locais de armazenamento em nuvem onde os dados da tabela são armazenados no Databricks.generate-temporary-table-credentials |
| volumes | Comandos para gerenciar volumes, que são um recurso do Unity Catalog (UC) para acessar, armazenar, governar, organizar e processar arquivos:create, delete, list, read, update |
| vinculações de espaço de trabalho | Comandos para gerir associações de área de trabalho seguráveis. Os elementos protegidos no Databricks podem ser configurados como OPEN ou ISOLATED.get, get-bindings, update, update-bindings |
Comandos de partilha Delta
| Group | 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 |
| ativação-destinatário | Comandos para gerenciar a ativação do destinatário, que só é aplicável no modelo de compartilhamento aberto em que o objeto do destinatário tem o tipo de autenticação TOKEN:get-activation-url-info, retrieve-token |
| destinatários | Comandos para gerenciar destinatários, que você cria usando :method:recipients/create para representar uma organização à qual deseja permitir acesso a compartilhamentos:create, delete, get, list, rotate-token, updateshare-permissions |
| ações | Comandos para gerenciar compartilhamentos, que são contêineres instanciados com :method:shares/create:create, delete, get, list, list-shares, updateshare-permissions, update-permissions |
Comandos de configurações
| Group | Descrição e comandos |
|---|---|
| Listas de acesso IP | Comandos para permitir que os administradores configurem listas de acesso IP:create, delete, get, list, replace, update |
| notificação-destinos | Comandos para gerenciar os destinos de notificação de um espaço de trabalho:create, delete, get, list, update |
| settings | Comandos para permitir que os usuários gerenciem configurações no nível do espaço de trabalho:automatic-cluster-update, csp-enablement, default-namespace, esm-enablement, restrict-workspace-admins |
| gerenciamento de tokens | Comandos que permitem aos administradores obter todos os tokens e excluir tokens para outros usuários:create-obo-token, delete, get, listget-permission-levels, get-permissions, set-permissions, update-permissions |
| fichas | Comandos para criar, listar e revogar tokens que podem ser usados para autenticar e acessar APIs REST do Databricks:create, delete, list |
| espaço de trabalho-conf | Comandos para atualizar as configurações do espaço de trabalho:get-status, set-status |
Comandos das ferramentas de desenvolvedor
| Group | Descrição e comandos |
|---|---|
| bundle | Comandos para gerenciar Databricks Asset Bundles, que permitem expressar seus projetos Databricks como código:deploy, deployment, , destroygenerate, init, openplanrunschemasummarysyncvalidate |
| sync | Sincronize um diretório local com um diretório de espaço de trabalho. |
Comandos de pesquisa vetorial
| Group | Descrição e comandos |
|---|---|
| pontos de extremidade de pesquisa vetorial | Comandos para gerir endpoints de pesquisa vetorial, que representam os recursos de computação para alojar índices de pesquisa vetorial:create-endpoint, delete-endpoint, get-endpoint, list-endpoints |
| vetoriais-pesquisa-índices | Comandos para gerir índices de pesquisa vetorial, uma representação eficiente dos seus vetores de incorporação que suporta consultas de pesquisa aproximada do vizinho mais próximo (ANN) em tempo real e de forma eficiente.create-index, delete-data-vector-index, delete-index, get-indexlist-indexes, query-index, sync-index, upsert-data-vector-index |
Comandos do painel de controlo
| Group | 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 corporativos, alimentado por IA/BI:create-message, execute-message-attachment-query, get-message, get-message-attachment-query-result, get-spaced, start-conversation |
| vista para o lago | Comandos que fornecem operações de gerenciamento específicas para painéis de IA/BI:create, create-schedule, , create-subscription, , delete-scheduledelete-subscriptiongetget-publishedget-scheduleget-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublishupdateupdate-schedule |
Comandos do Marketplace
| Group | Descrição e comandos |
|---|---|
| satisfação do consumidor | Comandos para gerenciar atendimentos, que são entidades que permitem que os consumidores visualizem instalações.get, list |
| instalações de consumo | Comandos para gerenciar instalações, que são entidades que permitem que os consumidores interajam com listagens do Databricks Marketplace.create, delete, list, list-listing-installations, update |
| listas de consumidores | Comandos para gerenciar listagens de consumidores do Databricks Marketplace:batch-get, get, list, search |
| consumidor-personalização-pedidos | 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 |
| consumidores-fornecedores | Comandos para gerenciar provedores, que são as entidades que publicam listagens no Marketplace.batch-get, get, list |
| provedor-exchange-filtros | Comandos para gerenciar filtros de trocas do Marketplace, que selecionam quais grupos podem acessar uma troca.create, delete, list, update |
| trocas de fornecedores | Comandos para gerenciar trocas do Marketplace, que permitem que os provedores compartilhem suas listagens com um conjunto selecionado de clientes.add-listing-to-exchange, create, delete, delete-listing-from-exchange, getlist, list-exchanges-for-listing, list-listings-for-exchange, update |
| arquivos-provedor | Comandos para gerenciar arquivos do Marketplace, como blocos de anotações de visualização e ícones de provedor.create, delete, get, list |
| listagens de fornecedores | Comandos para gerenciar listagens de provedores:create, delete, get, list, update |
| provedor-personalização-solicitações | 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 gerir a analítica modelada para provedores:create, get, get-latest-version, update |
| provedores-provedores | Comandos para gerenciar provedores, que gerenciam ativos no Marketplace.create, delete, get, list, update |
Comandos de aplicativos
| Group | Descrição e comandos |
|---|---|
| apps | Comandos para gerenciar aplicativos Databricks, que são executados diretamente em sua instância Databricks, integram-se com seus dados, usam e estendem serviços Databricks e permitem que os usuários interajam por meio do logon único.create, delete, , deployget, get-deployment, listlist-deploymentslogsrun-localstartstopupdate |
Comandos de salas limpas
| Group | Descrição e comandos |
|---|---|
| ativos de sala limpa | Comandos para gerenciar ativos de sala limpa, que são objetos de dados e código, como tabelas, volumes e blocos de anotações compartilhados com a sala limpa.create, delete, get, list, update |
| sala limpa-tarefas-execuções | Comandos para gerenciar execuções de tarefas de sala limpa, que são as execuções de blocos de anotações em uma sala limpa.list |
| quartos limpos | Comandos para gerir salas limpas. As salas limpas usam o Delta Sharing e a computação sem servidor para fornecer um ambiente seguro e que protege a privacidade, onde 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 da base de dados
| Group | Descrição e comandos |
|---|---|
| base de dados | Comandos para gerenciar instâncias de banco de dados do Lakebase.create-database-catalog, create-database-instance, , create-database-table, , create-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 |
Comandos adicionais
| Group | 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 | Configure o CLI do Databricks. |
help |
Forneça informações resumidas para todos os comandos da CLI do Databricks. |
| 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 no momento. |
Bandeiras 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 obter informações detalhadas sobre comandos específicos e seus sinalizadores, consulte a ajuda da linha de comando.
--debug
Se o log de depuração deve ser habilitado.
-h ou --help
Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file string
Uma cadeia de caracteres que representa o ficheiro onde os registos de saída são gravados. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.
--log-format Formato
O tipo de formato de log, text ou json. O valor predefinido é text.
--log-level string
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á desativado.
-o, --output tipo
O tipo de saída do comando, text ou json. O valor predefinido é text.
-p, --profile string
O nome do perfil no arquivo ~/.databrickscfg a ser usado para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.
--progress-format Formato
O formato para exibir logs de progresso: default, append, inplace, ou json
-t, --target string
Se aplicável, o destino do pacote a ser usado