Partilhar via

Comandos da CLI do Databricks

  • Artigo

Nota

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks, que estão em Visualização Pública. Para encontrar sua versão da CLI do Databricks, execute databricks -v.

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> -h
  • databricks <command-group> <command-name> -h
  • databricks <command-group> <command-name> <subcommand-name> -h

Muitos comandos da CLI são mapeados para operações documentadas na referência da API REST do Azure Databricks.

Comandos do espaço de trabalho

Agrupar 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 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, update

get-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-secretdelete-scope, 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, importget-status, import-dir, list,mkdirs

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos de computação

Agrupar 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, get, list

get-permission-levels, get-permissions, set-permissions, update-permissions
clusters Comandos que permitem criar, iniciar, editar, listar, encerrar e excluir clusters:

change-owner, create, , delete, eventsedit, get, restartspark-versionspinresizestartlistlist-node-typeslist-zonespermanent-deleteunpin

get-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
instance-pools 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, 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:

add, edit, list, remove
libraries Comandos para instalar, desinstalar e obter o status das bibliotecas em um cluster:

all-cluster-statuses, cluster-status, install, uninstall
policy-families Comandos para visualizar as famílias de políticas disponíveis:

get, list

Comandos de trabalhos

Agrupar Descrição e comandos
jobs Comandos para gerenciar trabalhos:

cancel-all-runs, cancel-run, , create, , export-runget-runrepair-runlist-runssubmitgetrun-nowget-run-outputresetlistdeletedelete-runupdate

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos Delta Live Tables

Agrupar Descrição e comandos
pipelines Comandos para criar, editar, excluir, iniciar e exibir detalhes sobre pipelines:

create, delete, , get, get-update, list-pipelineslist-pipeline-events, list-updates, start-updatestop,update

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos de Aprendizagem Automática

Agrupar 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, , , , , delete-tagsearch-runslog-batchlist-experimentslist-artifactsget-runGetlog-inputsget-historyget-by-nameset-tagrestore-runset-experiment-taglog-modellog-paramrestore-experimentsearch-experimentsupdate-experimentget-experimentrestore-runsdelete-runslog-metricdelete-rundelete-experimentcreate-runupdate-run

get-permission-levels, get-permissions, set-permissions, update-permissions
model-registry Comandos para o Registro do Modelo de Espaço de Trabalho:

approve-transition-request, , , , , create-webhooktransition-stageget-model-version-download-uriget-model-versionlist-modelsget-modelget-latest-versionsdelete-webhooklist-transition-requestsdelete-transition-requestdelete-model-version-tagdelete-model-versionlist-webhooksdelete-model-tagdelete-commentupdate-modelset-model-tagupdate-commentrename-modelsearch-model-versionssearch-modelstest-registry-webhookupdate-model-versiondelete-modelset-model-version-tagcreate-transition-requestreject-transition-requestcreate-model-versioncreate-modelcreate-commentupdate-webhook

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos de serviço em tempo real

Agrupar Descrição e comandos
serving-endpoints Comandos para criar, atualizar e excluir pontos de extremidade de serviço de modelo:

build-logs, create, , export-metricsdelete, get, list, logs, patchputqueryupdate-config

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos de gerenciamento de identidade e acesso

Agrupar Descrição e comandos
account Comandos para gerenciar contas Databricks:

- Identidade e acesso: access-control, groups, service-principals, users, workspace-assignment
- Catálogo Unity: metastore-assignments, metastores, storage-credentials
- Definições: ip-access-lists, network-connectivity, settings
- Aprovisionamento: credentials, encryption-keys, networks, , private-access, storage, vpc-endpoints, workspaces
- Faturação: 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 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 gerenciar o acesso de vários usuários em diferentes objetos e pontos de extremidade:

get, set, update

get-permission-levels
service-principals 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, update

get-permission-levels, get-permissions, set-permissions, update-permissions
Agrupar Descrição e comandos
alerts Comandos para executar operações em alertas:

create, delete, get, list, update
data-sources 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
query-history Comandos para acessar o histórico de consultas por meio de armazéns SQL:

list
warehouses 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, listget-workspace-warehouse-config, set-workspace-warehouse-config, start,stop

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandos do Catálogo Unity

Agrupar Descrição e comandos
artifact-allowlists Comandos para gerenciar listas de permissões 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 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 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 UDFs (User-Defined Functions) 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 metastores, que são o contêiner de nível superior de objetos no Unity Catalog:

assign, create, , current, delete, listget, summary, unassignupdate,update-assignment
model-versions 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
online-tables Comandos para gerenciar tabelas online, que fornecem menor latência e maior acesso QPS aos dados de tabelas Delta:

create, delete, get
quality-monitors Comandos para gerenciar monitores, que computam e monitoram dados ou métricas de qualidade de modelo 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 MLflow Model Registry no Unity Catalog.

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 vivem dentro do catálogo do sistema:

disable, enable, list
table-constraints 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
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
workspace-bindings Comandos para gerenciar associações de espaço de trabalho protegíveis. Os protegíveis no Databricks podem ser configurados como OPEN ou ISOLATED.

get, get-bindings, update, update-bindings

Comandos de compartilhamento delta

Agrupar 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ó é 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
recipients 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, 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

Agrupar Descrição e comandos
ip-access-lists Comandos para permitir que os administradores configurem listas de acesso IP:

create, delete, get, list, replace, 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
token-management Comandos que permitem aos administradores obter todos os tokens e excluir tokens para 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 usados para autenticar e acessar APIs REST do Databricks:

create, delete, list
workspace-conf Comandos para atualizar as configurações do espaço de trabalho:

get-status, set-status

Comandos das ferramentas de desenvolvedor

Agrupar Descrição e comandos
pacote Comandos para gerenciar Databricks Asset Bundles, que permitem expressar seus projetos Databricks como código:

deploy, deployment, destroy, , generate, runinit, schema, sync,validate
sincronização Sincronize um diretório local com um diretório de espaço de trabalho.

Comandos de pesquisa vetorial

Agrupar Descrição e comandos
vector-search-endpoints Comandos para gerenciar pontos de extremidade de pesquisa vetorial, que representam os recursos de computação para hospedar índices de pesquisa vetorial:

create-endpoint, delete-endpoint, get-endpoint, list-endpoints
vector-search-indexes Comandos para gerenciar índices de pesquisa vetorial, uma representação eficiente de seus vetores de incorporação que suporta consultas de pesquisa de vizinho mais próximo (ANN) em tempo real e eficientes:

create-index, delete-data-vector-index, , delete-index, list-indexesget-index, query-index, sync-index,upsert-data-vector-index

Comandos do painel

Agrupar Descrição e comandos
dashboards Comandos para modificar painéis:

create, delete, get, list, restore, update
lakeview Comandos que fornecem operações de gerenciamento específicas para painéis de IA/BI:

create, get, , get-published, publishmigrate, trash, unpublish,update

Comandos adicionais

Agrupar 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, powershell, zsh
configurar Configure a CLI do Databricks.
help Informações de uso de saída 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 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.

Sinalizador Description
-h ou --help Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.
-e ou --environment string Uma cadeia de caracteres que representa o ambiente de pacote a ser usado, se aplicável, para o 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 é 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á desativado.
-o ou --output text para escrever saída como texto ou json para escrever saída como JSON. Se esse sinalizador não for especificado, a saída será escrita como texto.
-p ou --profile Uma cadeia de caracteres que representa o perfil de configuração nomeado a ser usado em seu .databrickscfg arquivo. Se esse sinalizador não for especificado, o DEFAULT perfil nomeado será usado, se existir. Você pode pressionar Tab depois --profile ou -p para exibir uma lista de perfis de configuração disponíveis existentes para escolher, em vez de inserir o nome do perfil de configuração manualmente.
--progress-format O formato para exibição de logs de progresso (default (o padrão) ou append ou inplace json).