Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Note
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 provisionamentos 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> -hdatabricks <command-group> <command-name> -hdatabricks <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 do workspace
| Group | 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, , listupdateget-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-acl, , get-secret, , list-acls, list-scopes, list-secrets, , put-acl, put-secret |
| workspace | Comandos para listar, importar, exportar e excluir notebooks e pastas no espaço de trabalho:delete, export, export-dir, get-status, , import, import-dir, , listmkdirsget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos de computação
| Group | 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, , getlistget-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, , get, list, list-node-types, list-zones, , permanent-delete,pin, , resizerestart, spark-versions, , startunpinget-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 |
| pools de instâncias | 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, , getlistget-permission-levels, get-permissions, , set-permissionsupdate-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 com:add, edit, , listremove |
| Bibliotecas | 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
| Group | Descrição e comandos |
|---|---|
| jobs | Comandos para gerenciar trabalhos:cancel-all-runs, cancel-run, create, delete, delete-run, , export-run, , get, get-run, get-run-output, list, , list-runs, repair-run, reset, run-now, , submitupdateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos dos Pipelines Declarativos do Lakeflow
| Group | Descrição e comandos |
|---|---|
| pipelines | Comandos para criar, editar, excluir, iniciar e exibir detalhes sobre pipelines:create, delete, get, get-update, list-pipeline-events, , list-pipelines, list-updates, , start-update, stop, updateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos do Machine Learning
| Group | 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-runs, , delete-tag, get-by-name, get-experiment, , get-history, get-runGet, list-artifacts, , list-experiments, log-batch, log-inputs, log-metric, log-model, log-param, restore-experiment, restore-run, restore-runs, search-experiments, search-runsset-experiment-tag, set-tag, , , update-experimentupdate-runget-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-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, list-modelslist-transition-requestsget-model-version-download-uriget-model-version, list-webhooks, rename-modelreject-transition-request, , search-model-versions, search-modelsset-model-tag, set-model-version-tag, test-registry-webhook, , transition-stage, update-comment, , update-model, , update-model-versionupdate-webhookget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos de serviço em tempo real
| Group | Descrição e comandos |
|---|---|
| pontos de extremidade de serviço | Comandos para criar, atualizar e excluir pontos de extremidade de serviço de modelo:build-logs, create, delete, export-metrics, get, , list, , logs, patch, put, , query, update-configget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos de gerenciamento de identidade e acesso
| Group | Descrição e comandos |
|---|---|
| account | Comandos para gerenciar contas do Databricks:
|
| auth | Comandos para autenticação:describe, env, login, , profilestoken |
| usuário atual | 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, , setupdateget-permission-levels |
| entidades de serviço | 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, , updateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos relacionados ao SQL
| Group | 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 herdadoscreate, delete, get, , listupdate |
| fontes de dados | 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 |
| histórico de consultas | Comandos para acessar o histórico de consultas por meio de warehouses SQL:list |
| Armazéns | 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, list, set-workspace-warehouse-config, , startstopget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Comandos do Unity Catalog
| Group | 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 |
| 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 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-effectiveupdate |
| metastores | Comandos para gerenciar metastores, que são o contêiner de mais alto nível para objetos no Unity Catalog:assign, create, current, delete, get, , list, summary, , unassign, update, 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 |
| tabelas online | 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, , deleteget |
| monitores de qualidade | 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 |
| modelos registrados | 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 |
| cotas de recursos | 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 |
| 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 |
| system-schemas | Comandos para gerenciar esquemas do sistema, que são esquemas que existem dentro do catálogo do sistema:disable, , enablelist |
| restrições de tabela | 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 protegíveis do espaço de trabalho. Os protegíveis no Databricks podem ser configurados como OPEN ou ISOLATED.get, get-bindings, , updateupdate-bindings |
Comandos de compartilhamento 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 de destinatário | 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, , updateshare-permissions |
| Ações | Comandos para gerenciar compartilhamentos, que são contêineres instanciados com :method:shares/create:create, delete, get, , listupdateshare-permissions, update-permissions |
Comandos de configurações
| Group | Descrição e comandos |
|---|---|
| listas de acesso ip | 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 |
| gerenciamento de token | Comandos que permitem aos administradores a obter e excluir tokens de outros usuários:create-obo-token, delete, , getlistget-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, , deletelist |
| workspace-conf | Comandos para atualizar as configurações do workspace:get-status, set-status |
Comandos de ferramentas para desenvolvedores
| Group | 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, init, , open, , run, schema, summary, , sync, validate |
| sync | Sincronizar um diretório local com um diretório de workspace. |
Comandos de busca em vetores
| Group | 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-indexupsert-data-vector-index |
Comandos do painel
| 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 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
| Group | Descrição e comandos |
|---|---|
| atendimentos ao consumidor | Comandos para gerenciar execuções, que são entidades que permitem aos consumidores pré-visualizar instalações.get, list |
| instalações do consumidor | 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 |
| listas de consumidores | 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, , getlist |
| provedores de consumidor | Comandos para gerenciar provedores, que são as entidades que publicam listagens no Marketplace.batch-get, , getlist |
| 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, list, list-exchanges-for-listing, , list-listings-for-exchangeupdate |
| provider-files | Comandos para gerenciar arquivos do Marketplace, como notebooks de visualização e ícones de provedor.create, delete, , getlist |
| listagens de provedor | 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 |
| provedores-provedores | Comandos para gerenciar provedores, que gerenciam ativos no Marketplace.create, delete, get, , listupdate |
Comandos de aplicativos
| Group | 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-deployment, , list, , list-deployments, run-local, start, , stop, update |
Comandos de salas limpas
| Group | 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 de sala limpa, que são as execuções de notebooks em um ambiente controlado.list |
| salas limpas | 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 de banco 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-table, delete-database-catalog, , delete-database-instance, , delete-database-table, delete-synced-database-table, find-database-instance-by-uid, generate-database-credential, , get-database-catalog, get-database-instance, get-database-table, get-synced-database-table, , list-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, , powershellzsh |
| configure | Configura a CLI do Databricks. |
help |
Exibir 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 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.
--debug
Indica se deve habilitar o registro em log de depuração.
-h ou --help
Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.
--log-file corda
Uma cadeia de caracteres que representa o arquivo para o qual 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 formato
O tipo de formato de log, text ou json. O valor padrão é text.
--log-level corda
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, --output tipo
O tipo de saída de comando, text ou json. O valor padrão é text.
-p, --profile corda
O nome do perfil no arquivo ~/.databrickscfg para usar ao executar o comando. Se esse sinalizador não for especificado, se existir, o perfil nomeado DEFAULT será usado.
--progress-format formato
O formato para exibir logs de progresso: default, append, inplace ou json
-t, --target corda
Se aplicável, o destino do pacote a ser usado