Comando CLI do Databricks

Observação

Essas informações se aplicam ao site Databricks CLI versões 0.205 e superiores. A CLI da Databricks está em visualização pública.

Databricks CLI O uso está sujeito à LicençaDatabricks e ao Aviso de PrivacidadeDatabricks , incluindo qualquer provisionamento de Dados de Uso.

Este artigo fornece informações sobre o site Databricks CLI comando. Essas informações complementam a ajuda da linha de comando. Para obter mais informações sobre a instalação e o uso do Databricks CLI, consulte Instalar ou atualizar o Databricks CLIe O que é o Databricks CLI?

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

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

Muitos CLI comandos mapeiam operações que estão documentadas na referênciaDatabricks REST API .

workspace comando

Grupo	Descrição e comando
fs	comando para gerenciar arquivos e o sistema de arquivos: `cat`, `cp`, `ls`, `mkdir`, `rm`
`git-credentials`	comando para registro pessoal access tokens para Databricks para fazer operações em nome do usuário: `create`, `delete`, `get`, `list`, `update`
`repos`	comando 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`	comando para gerenciar segredos, escopo de segredo 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`	comando para listar, importar, exportar e excluir o Notebook e as pastas no site workspace: `delete`, `export`, `export-dir`, `get-status`, `import`, `import-dir`, `list`, `mkdirs` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`

compute comando

Grupo	Descrição e comando
`cluster-policies`	comando para controlar a capacidade dos usuários de configurar o site clusters com base em um conjunto de regras: `create`, `delete`, `edit`, `get`, `list` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`
`clusters`	comando que permite ao senhor criar, começar, 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`, `unpin` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`
`global-init-scripts`	comando que permite que os administradores do site workspace configurem scripts de inicialização global para seu site workspace: `create`, `delete`, `get`, `list`, `update`
`instance-pools`	O comando para criar, editar, excluir e listar o pool de instâncias usando instâncias cloud prontas para uso, o que reduz o tempo de início e dimensionamento automático do cluster: `create`, `delete`, `edit`, `get`, `list` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`
`instance-profiles`	comando para permitir que os administradores adicionem, listem e removam o perfil de instância com o qual os usuários podem iniciar o clusters: `add`, `edit`, `list`, `remove`
`libraries`	comando para instalar, desinstalar e obter o status da biblioteca em um cluster: `all-cluster-statuses`, `cluster-status`, `install`, `uninstall`
`policy-families`	comando para view famílias de apólices disponíveis: `get`, `list`

Empregos comando

Grupo

Descrição e comando

jobs

comando para gerenciar o trabalho:

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

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

Delta Live Tables comando

Grupo

Descrição e comando

pipelines

comando para criar, editar, excluir, começar e view detalhes sobre o pipeline:

create, delete, get, get-update, list-pipeline-events, list-pipelines, list-updates, start-update, stop, update

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

Comando de aprendizado de máquina

Grupo

Descrição e comando

experiments

comando para interagir com experimentos, que são a principal unidade de organização em MLflow; todos os MLflow execução 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-runs, set-experiment-tag, set-tag, update-experiment, update-run

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

model-registry

comando para o 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, 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-webhook

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

tempo real servindo comando

Grupo

Descrição e comando

serving-endpoints

comando para criar, atualizar e excluir o endpoint do modelo de serviço:

build-logs, create, delete, export-metrics, get, list, logs, patch, put, query, update-config

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

Comando de gerenciamento de identidade e acesso

Grupo	Descrição e comando
`account`	comando para gerenciar a conta Databricks: Identidade e acesso: `access-control`, `groups`, `service-principals`, `users`, `workspace-assignment` Unity Catalog: `metastore-assignments`, `metastores`, `storage-credentials` Configurações: `ip-access-lists`, `network-connectivity`, `settings` provisionamento: `credentials`, `encryption-keys`, `networks`, `private-access`, `storage`, `vpc-endpoints`, `workspaces` Faturamento: `billable-usage`, `log-delivery` OAuth: `custom-app-integration`, `o-auth-published-apps`, `published-app-integration`, `service-principal-secrets`
autenticação	comando para autenticação: `describe`, `env`, `login`, `profiles`, `token`
`current-user`	comando para recuperar informações sobre o usuário ou entidade de serviço autenticado no momento: `me`
`groups`	comando para grupos que simplificam o gerenciamento de identidade, facilitando a atribuição de acesso a Databricks workspace, dados e outros objetos seguros: `create`, `delete`, `get`, `list`, `patch`, `update`
`permissions`	comando para criar acesso de leitura, gravação, edição, atualização e gerenciamento para vários usuários em diferentes objetos e pontos de extremidade: `get`, `set`, `update` `get-permission-levels`
`service-principals`	comando para identidades para uso com o Job, ferramentas e sistemas automatizados, como scripts, aplicativos e plataformas CI/CD: `create`, `delete`, `get`, `list`, `patch`, `update`
`users`	comando para identidades de usuário reconhecidas por Databricks e representadas por endereços email: `create`, `delete`, `get`, `list`, `patch`, `update` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`

Comando relacionado ao SQL

Grupo	Descrição e comando
`alerts`	comando para realizar operações em alerta: `create`, `delete`, `get`, `list`, `update`
`data-sources`	comando para criar novos objetos de consulta: `list`
`queries`	comando para realizar operações nas definições de consulta: `create`, `delete`, `get`, `list`, `restore`, `update`
`query-history`	comando para acessar o histórico de consultas por meio do SQL warehouse: `list`
`warehouses`	comando to gerenciar SQL warehouse, que é um compute recurso que permite ao senhor executar SQL comando em objetos de dados dentro de Databricks SQL: `create`, `delete`, `edit`, `get`, `get-workspace-warehouse-config`, `list`, `set-workspace-warehouse-config`, `start`, `stop` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`

Unity Catalog comando

Grupo	Descrição e comando
`artifact-allowlists`	comando para gerenciar listas de permissões de artefatos. Em Databricks Runtime 13.3 e acima, o senhor pode adicionar biblioteca e script de inicialização à lista de permissões no UC para que os usuários possam aproveitar esses artefatos em compute configurado com o modo de acesso compartilhado: `get`, `update`
`catalogs`	comando para gerenciar catálogos, a primeira camada do namespace de três níveis do Unity Catalog: `create`, `delete`, `get`, `list`, `update`
`connections`	comando para criar uma conexão com uma fonte de dados externa: `create`, `delete`, `get`, `list`, `update`
`external-locations`	comando para gerenciar locais externos, que combinam um caminho de armazenamento cloud com uma credencial de armazenamento que autoriza o acesso ao caminho de armazenamento cloud: `create`, `delete`, `get`, `list`, `update`
`functions`	comando para gerenciar User-Defined Functions (UDFs) em Unity Catalog: `create`, `delete`, `get`, `list`, `update`
`grants`	comando para conceder acesso aos dados em Unity Catalog: `get`, `get-effective`, `update`
`metastores`	comando para gerenciar metastores, que são o contêiner de nível superior de objetos em Unity Catalog: `assign`, `create`, `current`, `delete`, `get`, `list`, `summary`, `unassign`, `update`, `update-assignment`
`model-versions`	comando para gerenciar versões de modelos. A Databricks fornece uma versão hospedada do MLflow Model Registry no Unity Catalog. `delete`, `get`, `get-by-alias`, `list`, `update`
`online-tables`	comando para gerenciar tabelas on-line, que fornecem menor latência e maior acesso QPS aos dados das tabelas Delta: `create`, `delete`, `get`
`quality-monitors`	comando para gerenciar monitores, que compute e monitoram os dados ou modelam as métricas de qualidade de uma tabela ao longo do tempo: `create`, `delete`, `get`, `get-refresh`, `list-refreshes`, `run-refresh`, `update`
`registered-models`	comando para gerenciar modelos registrados. A Databricks fornece uma versão hospedada do MLflow Model Registry no Unity Catalog. `create`, `delete`, `delete-alias`, `get`, `list`, `set-alias`, `update`
`schemas`	comando para gerenciar esquemas, que são a segunda camada do namespace de três níveis do site Unity Catalog: `create`, `delete`, `get`, `list`, `update`
`storage-credentials`	comando para gerenciar as credenciais de armazenamento, que são um mecanismo de autenticação e autorização para acessar os dados armazenados em seu site cloud tenant: `create`, `delete`, `get`, `list`, `update`, `validate`
`system-schemas`	comando para gerenciar esquemas do sistema, que são esquemas que residem no catálogo do sistema: `disable`, `enable`, `list`
`table-constraints`	comando para gerenciar restrições primárias key e estrangeiras key que codificam relacionamentos entre campos em tabelas: `create`, `delete`
`tables`	comando to gerenciar tables, que reside na terceira camada do namespace de três níveis do Unity Catalog: `delete`, `exists`, `get`, `list`, `list-summaries`
`volumes`	comando para gerenciar volumes, que são um recurso do Unity Catalog (UC) para acessar, armazenar, controlar, organizar e processar arquivos: `create`, `delete`, `list`, `read`, `update`
`workspace-bindings`	comando para gerenciar as ligações seguras do workspace. Os Securables em Databricks podem ser configurados como `OPEN` ou `ISOLATED`. `get`, `get-bindings`, `update`, `update-bindings`

Delta compartilhamento comando

Grupo	Descrição e comando
`providers`	comando para gerenciar provedores de dados, que representam as organizações que compartilham dados: `create`, `delete`, `get`, `list`, `list-shares`, `update`
`recipient-activation`	comando para gerenciar a ativação do destinatário, que só é aplicável no modelo de compartilhamento aberto em que o objeto destinatário tem o tipo de autenticação de tokens: `get-activation-url-info`, `retrieve-token`
`recipients`	comando para gerenciar destinatários, que o senhor cria usando `:method:recipients/create` para representar uma organização à qual deseja permitir acesso aos compartilhamentos: `create`, `delete`, `get`, `list`, `rotate-token`, `update` `share-permissions`
`shares`	comando para gerenciar compartilhamentos, que são contêineres instanciados com `:method:shares/create`: `create`, `delete`, `get`, `list`, `update` `share-permissions`, `update-permissions`

Configurações de comando

Grupo	Descrição e comando
`ip-access-lists`	comando para permitir que os administradores configurem listas de acesso IP: `create`, `delete`, `get`, `list`, `replace`, `update`
`settings`	comando para permitir que os usuários gerenciem configurações no nível workspace: `automatic-cluster-update`, `csp-enablement`, `default-namespace`, `esm-enablement`, `restrict-workspace-admins`
`token-management`	comando que permite que os administradores obtenham todos os tokens e excluam tokens para outros usuários: `create-obo-token`, `delete`, `get`, `list` `get-permission-levels`, `get-permissions`, `set-permissions`, `update-permissions`
`tokens`	comando para criar, listar e revogar tokens que pode ser usado para autenticar e acessar Databricks REST APIs: `create`, `delete`, `list`
`workspace-conf`	comando para atualizar as configurações do workspace: `get-status`, `set-status`

Comando de ferramentas para desenvolvedores

Grupo

Descrição e comando

pacote

comando para gerenciar Databricks ativo Bundles, que permitem que o senhor expresse seus projetos Databricks como código:

deploy, deployment, destroy, generate, init, open, run, schema, summary, sync, validate

sincronizar

Sincronizar um diretório local com um diretório workspace.

Comando de busca vetorial

Grupo

Descrição e comando

vector-search-endpoints

comando para gerenciar o endpoint de pesquisa vetorial, que representa o compute recurso para hospedar índices de pesquisa vetorial:

create-endpoint, delete-endpoint, get-endpoint, list-endpoints

vector-search-indexes

comando para gerenciar índices de pesquisa vetorial, uma representação eficiente de seus vetores de incorporação que suporta consultas de pesquisa de tempo real e eficiente de vizinho mais próximo aproximado (redes neurais artificiais (ANN)):

create-index, delete-data-vector-index, delete-index, get-index, list-indexes, query-index, sync-index, upsert-data-vector-index

Comando do painel

Grupo

Descrição e comando

dashboards

comando para modificar dashboards:

create, delete, get, list, restore, update

lakeview

comando que fornece operações de gerenciamento específicas para AI/BI dashboards:

create, get, get-published, migrate, publish, trash, unpublish, update

Comando adicional

Grupo	Descrição e comando
API	comando para fazer solicitações ao Databricks REST API: `delete`, `get`, `head`, `patch`, `post`, `put`
conclusão	comando para gerar o script de autocompletar para o site especificado shell: `bash`, `fish`, `powershell`, `zsh`
configurar	Configurar a CLI do Databricks.
`help`	Informações de uso de saída para qualquer comando.
laboratórios	comando para gerenciar as instalações do Databricks Labs: `clear-cache`, `install`, `installed`, `list`, `show`, `uninstall`, `upgrade`
`version`	Recupera a versão da CLI que está sendo usada no momento.

Bandeiras globais

Os seguintes sinalizadores estão disponíveis para todos os Databricks CLI comando. 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 do comando-line.

Bandeira	Descrição
`-h` ou `--help`	Exibir 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 do pacote a ser usado, se aplicável, para o comando relacionado.
`--log-file`	Uma cadeia de caracteres que representa a saída para gravação logs. Se esse sinalizador não for especificado, o default deverá gravar a saída logs no stderr.
`--log-format`	`text` para gravar a saída logs em texto ou `json` para gravar a saída logs em JSON. Se esse sinalizador não for especificado, a saída logs será gravada como texto.
`--log-level`	Uma cadeia de caracteres que representa o nível de formato log. Se não for especificado, o nível de formato log será desativado.
`-o` ou `--output`	`text` para gravar a saída como texto ou `json` para 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 em seu arquivo `.databrickscfg`. Se esse sinalizador não for especificado, o perfil nomeado `DEFAULT` será usado, se existir. O senhor pode pressionar `Tab` depois de `--profile` ou `-p` para exibir uma lista de perfis de configuração disponíveis existentes para escolha, em vez de digitar o nome do perfil de configuração manualmente.
`--progress-format`	O formato do progresso logs a ser exibido (`default` (o default) ou `append` ou `inplace` ou `json`).