Polecenia CLI Databricks
Uwaga
Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs CLI usługi Databricks jest w publicznej wersji zapoznawczej.
Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.
Ten artykuł zawiera informacje na temat dostępnych poleceń CLI dla Databricks. Ta informacja uzupełnia pomoc dotyczącą wiersza polecenia. Aby uzyskać więcej informacji na temat instalowania i używania interfejsu wiersza polecenia usługi Databricks, zobacz Instalowanie lub aktualizowanie interfejsu wiersza polecenia usługi Databricks i Co to jest interfejs wiersza polecenia usługi Databricks?.
Interfejs wiersza polecenia usługi Databricks zawiera grupy poleceń wymienione w poniższych tabelach. Grupy poleceń zawierają zestawy powiązanych poleceń, które mogą również zawierać polecenia podrzędne. Aby uzyskać informacje o użyciu i składni dla grupy poleceń, pojedyncze polecenie lub podpolecenia:
databricks <command-group> -hdatabricks <command-group> <command-name> -hdatabricks <command-group> <command-name> <subcommand-name> -h
Wiele poleceń CLI odpowiada operacjom udokumentowanym w dokumentacji Azure Databricks REST API.
Polecenia obszaru roboczego
| Grupa | Opis i polecenia |
|---|---|
| Fs | Polecenia do zarządzania plikami i systemem plików:cat, , cp, ls, , mkdirrm |
git-credentials |
Polecenia służące do rejestrowania osobistych tokenów dostępu dla usługi Databricks w celu wykonywania operacji w imieniu użytkownika:create, , delete, get, , listupdate |
repos |
Polecenia umożliwiające użytkownikom zarządzanie repozytoriami git:create, , delete, get, , listupdateget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
secrets |
Polecenia do zarządzania wpisami tajnymi, zakresami wpisów tajnych i uprawnieniami dostępu:create-scope, delete-acl, delete-scopedelete-secretget-aclget-secretlist-aclslist-scopeslist-secretsput-aclput-secret |
workspace |
Polecenia umożliwiające wyświetlanie listy, importowanie, eksportowanie i usuwanie notesów i folderów w obszarze roboczym:delete, export, , export-dir, get-statusimport, , import-dir, , listmkdirsget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
Polecenia obliczeniowe
| Grupa | Opis i polecenia |
|---|---|
cluster-policies |
Polecenia umożliwiające kontrolowanie możliwości konfigurowania klastrów na podstawie zestawu reguł:create, , delete, edit, , getlistget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
clusters |
Polecenia, które umożliwiają tworzenie, uruchamianie, edytowanie, wyświetlanie listy, kończenie i usuwanie klastrów: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-permissionsupdate-permissions |
global-init-scripts |
Polecenia umożliwiające administratorom obszarów roboczych konfigurowanie globalnych skryptów inicjowania dla ich obszaru roboczego:create, , delete, get, , listupdate |
instance-pools |
Polecenia tworzenia, edytowania, usuwania i wyświetlania listy pul instancji przy użyciu gotowych do użycia instancji chmurowych. Dzięki temu zmniejsza się czas uruchamiania i automatycznego skalowania klastra.create, , delete, edit, , getlistget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
instance-profiles |
Polecenia umożliwiające administratorom dodawanie, wyświetlanie listy i usuwanie profilów wystąpień, za pomocą których użytkownicy mogą uruchamiać klastry:add, , edit, , listremove |
libraries |
Polecenia instalowania, odinstalowywania i pobierania stanu bibliotek w klastrze:all-cluster-statuses, , cluster-status, , installuninstall |
policy-families |
Polecenia do wyświetlenia dostępnych typów polityk.get, list |
Polecenia zadań
| Grupa | Opis i polecenia |
|---|---|
jobs |
Polecenia do zarządzania zadaniami: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, updateget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
Polecenia DLT
| Grupa | Opis i polecenia |
|---|---|
pipelines |
Polecenia służące do tworzenia, edytowania, usuwania, uruchamiania i wyświetlania szczegółów dotyczących potoków:create, delete, get, get-update, list-pipeline-events, list-pipelines, list-updates, start-update, stop, updateget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
Polecenia związane z uczeniem maszynowym
| Grupa | Opis i polecenia |
|---|---|
experiments |
Polecenia umożliwiające interakcję z eksperymentami, które są podstawową jednostką organizacji w usłudze MLflow; wszystkie przebiegi MLflow należą do eksperymentu: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-runget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
model-registry |
Polecenia dla rejestru modeli środowiska roboczego: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-permissionsupdate-permissions |
Polecenia przetwarzania w czasie rzeczywistym
| Grupa | Opis i polecenia |
|---|---|
serving-endpoints |
Polecenia umożliwiające tworzenie, aktualizowanie i usuwanie modelu obsługującego punkty końcowe:build-logs, create, delete, export-metrics, get, list, logs, patch, put, query, update-configget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
Polecenia zarządzania tożsamością i dostępem
| Grupa | Opis i polecenia |
|---|---|
account |
Polecenia do zarządzania kontami usługi Databricks:
|
| Auth | Polecenia uwierzytelniania:describe, , env, login, , profilestoken |
current-user |
Polecenia umożliwiające pobranie informacji o aktualnie uwierzytelnianych użytkownikach lub jednostce usługi:me |
groups |
Polecenia dla grup, które upraszczają zarządzanie tożsamościami, ułatwiając przypisywanie dostępu do obszaru roboczego, danych i innych zabezpieczanych obiektów usługi Databricks:create, , delete, get, list, , patchupdate |
permissions |
Polecenia służące do tworzenia dostępu do odczytu, zapisu, edytowania, aktualizowania i zarządzania dla różnych użytkowników w różnych obiektach i punktach końcowych:get, set, updateget-permission-levels |
service-principals |
Polecenia dotyczące tożsamości do wykorzystania w zadaniach, w zautomatyzowanych narzędziach oraz w systemach informatycznych, takich jak skrypty, aplikacje i platformy CI/CD.create, , delete, get, list, , patchupdate |
users |
Polecenia dotyczące tożsamości użytkowników rozpoznawanych przez usługę Databricks, które są reprezentowane przez adresy e-mail.create, , delete, get, list, , patchupdateget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
Polecenia związane z językiem SQL
| Grupa | Opis i polecenia |
|---|---|
alerts |
Polecenia do wykonywania operacji na alertach:create, , delete, get, , listupdate |
data-sources |
Polecenia służące do tworzenia nowych obiektów zapytań:list |
queries |
Polecenia do wykonywania operacji na definicjach zapytań:create, , delete, get, list, , restoreupdate |
query-history |
Polecenia umożliwiające dostęp do historii zapytań za pośrednictwem usługi SQL Warehouse:list |
warehouses |
Polecenia do zarządzania magazynami SQL, które są zasobem obliczeniowym, który umożliwia uruchamianie poleceń SQL na obiektach danych w usłudze Databricks SQL:create, delete, , edit, getget-workspace-warehouse-config, list, , set-workspace-warehouse-configstartstopget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
Polecenia katalogu Unity
| Grupa | Opis i polecenia |
|---|---|
artifact-allowlists |
Polecenia do zarządzania listami dozwolonych artefaktów. W środowisku Databricks Runtime 13.3 lub nowszym można dodawać biblioteki i skrypty inicjowania do listy dozwolonych w UC, aby użytkownicy mogli korzystać z tych artefaktów na obliczeniach skonfigurowanych w trybie dostępu standardowego.get, update |
catalogs |
Polecenia do zarządzania katalogami — pierwsza warstwa trójpoziomowej przestrzeni nazw Unity Catalog:create, , delete, get, , listupdate |
connections |
Polecenia umożliwiające utworzenie połączenia z zewnętrznym źródłem danych:create, , delete, get, , listupdate |
external-locations |
Polecenia do zarządzania lokalizacjami zewnętrznymi, które łączą ścieżkę do przechowywania w chmurze z poświadczeniem dostępu autoryzującym dostęp do chmury:create, , delete, get, , listupdate |
functions |
Polecenia do zarządzania Funkcjami Zdefiniowanymi przez Użytkownika (UDF) w katalogu Unity Catalog:create, , delete, get, , listupdate |
grants |
Polecenia udzielania dostępu do danych w katalogu Unity:get, get-effective, update |
metastores |
Polecenia do zarządzania repozytoriami metadanych, które są głównym kontenerem obiektów w Unity Catalog:assign, create, current, delete, get, list, summary, unassign, update, update-assignment |
model-versions |
Polecenia do zarządzania wersjami modelu. Usługa Databricks oferuje hostowaną wersję rejestru modeli MLflow w Unity Catalog.delete, , get, get-by-alias, , listupdate |
online-tables |
Polecenia do zarządzania tabelami online, które oferują niższe opóźnienia i wyższą liczbę zapytań na sekundę (QPS) do danych z tabeli Delta.create, delete, get |
quality-monitors |
Polecenia do zarządzania monitorami, które obliczają i monitorują metryki jakości danych lub modelu dla tabeli w czasie:create, delete, , get, get-refresh, list-refreshes, , run-refreshupdate |
registered-models |
Polecenia do zarządzania zarejestrowanymi modelami. Usługa Databricks oferuje hostowaną wersję rejestru modeli MLflow w Unity Catalog.create, delete, , delete-alias, get, list, , set-aliasupdate |
schemas |
Polecenia do zarządzania schematami, które są drugą warstwą trójpoziomowej przestrzeni nazw katalogu Unity.create, , delete, get, , listupdate |
storage-credentials |
Polecenia do zarządzania poświadczeniami dostępu do magazynu, które są mechanizmem uwierzytelniania i autoryzacji umożliwiającym dostęp do danych przechowywanych w Twoim środowisku chmurowym:create, , delete, get, list, , updatevalidate |
system-schemas |
Polecenia do zarządzania schematami systemowymi, które są schematami, które znajdują się w katalogu systemowym:disable, enable, list |
table-constraints |
Polecenia do zarządzania ograniczeniami klucza podstawowego i klucza obcego, które kodują relacje między polami w tabelach:create, delete |
tables |
Polecenia do zarządzania tabelami, które znajdują się w trzeciej warstwie trzypoziomowej przestrzeni nazw Katalogu Unity.delete, , exists, get, , listlist-summaries |
volumes |
Polecenia do zarządzania woluminami, które są możliwością Katalogu Unity (UC) na potrzeby dostępu, przechowywania, nadzorowania, organizowania i przetwarzania plików:create, , delete, list, , readupdate |
workspace-bindings |
Polecenia do zarządzania zabezpieczanymi powiązaniami obszaru roboczego. Elementy zabezpieczające w usłudze Databricks można skonfigurować jako OPEN lub ISOLATED.get, , get-bindings, , updateupdate-bindings |
Komendy Delta sharing
| Grupa | Opis i polecenia |
|---|---|
providers |
Polecenia do zarządzania dostawcami danych, które reprezentują organizacje, które udostępniają dane:create, , delete, get, list, , list-sharesupdate |
recipient-activation |
Polecenia do zarządzania aktywacją adresata, która ma zastosowanie tylko w modelu udostępniania otwartego, w którym obiekt adresata ma typ uwierzytelniania TOKEN:get-activation-url-info, retrieve-token |
recipients |
Polecenia do zarządzania adresatami, które tworzysz za pomocą :method:recipients/create, aby reprezentować organizację, której chcesz zezwolić na dostęp do zasobów współdzielonych.create, , delete, get, list, , rotate-tokenupdateshare-permissions |
shares |
Polecenia do zarządzania zasobami, które są kontenerami utworzonymi za pomocą :method:shares/create:create, , delete, get, , listupdateshare-permissions, update-permissions |
Polecenia ustawień
| Grupa | Opis i polecenia |
|---|---|
ip-access-lists |
Polecenia umożliwiające administratorom konfigurowanie list dostępu do adresów IP:create, , delete, get, list, , replaceupdate |
settings |
Polecenia umożliwiające użytkownikom zarządzanie ustawieniami na poziomie obszaru roboczego:automatic-cluster-update, , csp-enablement, default-namespace, , esm-enablementrestrict-workspace-admins |
token-management |
Polecenia, które umożliwiają administratorom pobieranie wszystkich tokenów i usuwanie tokenów dla innych użytkowników:create-obo-token, , delete, , getlistget-permission-levels, , get-permissions, , set-permissionsupdate-permissions |
tokens |
Polecenia umożliwiające tworzenie, wyświetlanie listy i odwoływanie tokenów, których można użyć do uwierzytelniania interfejsów API REST usługi Databricks i uzyskiwania do ich dostępu:create, delete, list |
workspace-conf |
Polecenia służące do aktualizowania ustawień obszaru roboczego:get-status, set-status |
Narzędzia programistyczne polecenia
| Grupa | Opis i polecenia |
|---|---|
| pakiet | Polecenia do zarządzania pakietami zasobów usługi Databricks, które umożliwiają wyrażanie projektów usługi Databricks jako kodu:deploy, deployment, destroy, generate, init, open, run, schema, summary, sync, validate |
| sync | Synchronizowanie katalogu lokalnego z katalogiem obszaru roboczego. |
Polecenia wyszukiwania wektorowego
| Grupa | Opis i polecenia |
|---|---|
vector-search-endpoints |
Polecenia do zarządzania punktami końcowymi wyszukiwania wektorowego, które reprezentują zasoby obliczeniowe do hostowania indeksów wyszukiwania wektorów:create-endpoint, , delete-endpoint, , get-endpointlist-endpoints |
vector-search-indexes |
Polecenia do zarządzania indeksami wyszukiwania wektorów, wydajną reprezentacją wektorów osadzeń, które obsługują zapytania wyszukiwania w czasie rzeczywistym i wydajne przybliżone wyszukiwanie najbliższych sąsiadów (ANN):create-index, delete-data-vector-index, , delete-index, get-indexlist-indexes, , query-index, , sync-indexupsert-data-vector-index |
Polecenia kokpitu
| Grupa | Opis i polecenia |
|---|---|
dashboards |
Polecenia do modyfikowania pulpitów nawigacyjnych:create, , delete, get, list, , restoreupdate |
lakeview |
Polecenia, które umożliwiają określone operacje zarządzania dla pulpitów nawigacyjnych AI/BI:create, get, , get-published, migratepublish, , trash, , unpublishupdate |
Dodatkowe polecenia
| Grupa | Opis i polecenia |
|---|---|
| api | Polecenia do tworzenia żądań do interfejsu API REST usługi Databricks:delete, , get, head, patch, , postput |
| ukończenie | Polecenia służące do generowania skryptu autouzupełniania dla określonej powłoki:bash, , fish, , powershellzsh |
| konfigurować | Skonfiguruj interfejs wiersza polecenia usługi Databricks. |
help |
Wyświetl informacje o użyciu dla dowolnego polecenia. |
| Labs | Polecenia do zarządzania instalacjami usługi Databricks Labs:clear-cache, install, , installed, list, show, , uninstallupgrade |
version |
Pobierz wersję CLI, która jest obecnie używana. |
Flagi globalne
Następujące flagi są dostępne dla wszystkich poleceń konsoli Databricks. Należy pamiętać, że niektóre flagi nie mają zastosowania do niektórych poleceń. Aby uzyskać szczegółowe informacje o konkretnych poleceniach i ich flagach, zobacz pomoc dotyczącą wiersza poleceń.
| Flaga | opis |
|---|---|
-h lub --help |
Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia. |
-e lub --environment string |
Ciąg reprezentujący środowisko bundla do użycia, o ile jest to stosowne w odniesieniu do wykonanego polecenia. |
--log-file |
Ciąg znaków reprezentujący miejsce do zapisu dzienników wyjściowych. Jeśli ta flaga nie zostanie określona, wartością domyślną jest zapisywanie dzienników wyjściowych w programie stderr. |
--log-format |
text aby zapisywać dzienniki wyjściowe w tekście lub json zapisywać dzienniki wyjściowe w formacie JSON. Jeśli ta flaga nie jest określona, dzienniki wyjściowe są zapisywane jako tekst. |
--log-level |
Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony. |
-o lub --output |
text w celu zapisania danych wyjściowych w postaci tekstu lub json w celu zapisu danych wyjściowych w formacie JSON. Jeśli ta flaga nie jest określona, dane wyjściowe są zapisywane jako tekst. |
-p lub --profile |
Ciąg reprezentujący nazwany profil konfiguracji do użycia w pliku .databrickscfg . Jeśli ta flaga nie zostanie określona, użyty zostanie nazwany profil DEFAULT, jeśli taki istnieje. Możesz nacisnąć Tab po --profile lub -p, aby wyświetlić listę istniejących dostępnych profilów konfiguracji do wyboru zamiast ręcznie wprowadzać nazwę profilu konfiguracji. |
--progress-format |
Format dzienników postępu do wyświetlenia (default (wartość domyślna) lub append lub inplace ).json |