Polecenia interfejsu wiersza polecenia usługi Databricks
Uwaga
Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs wiersza polecenia 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 o dostępnych poleceniach interfejsu wiersza polecenia usługi Databricks. Te informacje uzupełniają pomoc 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> -h
databricks <command-group> <command-name> -h
databricks <command-group> <command-name> <subcommand-name> -h
Wiele poleceń interfejsu wiersza polecenia mapuje się na operacje udokumentowane w dokumentacji interfejsu API REST usługi Azure Databricks.
Polecenia obszaru roboczego
Grupuj | Opis i polecenia |
---|---|
Fs | Polecenia do zarządzania plikami i systemem plików:cat , , cp , ls , , mkdir rm |
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 , , list update |
repos |
Polecenia umożliwiające użytkownikom zarządzanie repozytoriami git:create , , delete , get , , list update get-permission-levels , , get-permissions , , set-permissions update-permissions |
secrets |
Polecenia do zarządzania wpisami tajnymi, zakresami wpisów tajnych i uprawnieniami dostępu:create-scope , delete-acl , , , delete-scope delete-secret get-acl get-secret list-acls list-scopes list-secrets put-acl put-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-status import , , import-dir , , list mkdirs get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia obliczeniowe
Grupuj | Opis i polecenia |
---|---|
cluster-policies |
Polecenia umożliwiające kontrolowanie możliwości konfigurowania klastrów na podstawie zestawu reguł:create , , delete , edit , , get list get-permission-levels , , get-permissions , , set-permissions update-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 unpin get-permission-levels , , get-permissions , , set-permissions update-permissions |
global-init-scripts |
Polecenia umożliwiające administratorom obszarów roboczych konfigurowanie globalnych skryptów inicjowania dla ich obszaru roboczego:create , , delete , get , , list update |
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 , , get list get-permission-levels , , get-permissions , , set-permissions update-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 , , list remove |
libraries |
Polecenia instalowania, odinstalowywania i pobierania stanu bibliotek w klastrze:all-cluster-statuses , , cluster-status , , install uninstall |
policy-families |
Polecenia umożliwiające wyświetlenie dostępnych rodzin zasad:get , list |
Polecenia zadań
Grupuj | 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 update get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia Delta Live Tables
Grupuj | 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 update get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia usługi Machine Learning
Grupuj | 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-run get-permission-levels , , get-permissions , , set-permissions update-permissions |
model-registry |
Polecenia rejestru modeli obszaru 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-webhook get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia obsługujące w czasie rzeczywistym
Grupuj | 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-config get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia zarządzania tożsamościami i dostępem
Grupuj | Opis i polecenia |
---|---|
account |
Polecenia do zarządzania kontami usługi Databricks: - Tożsamość i dostęp: access-control , , groups service-principals , , users workspace-assignment — Katalog Unity: metastore-assignments , metastores , storage-credentials - Ustawienia: ip-access-lists , , network-connectivity settings - Aprowizowanie: credentials , , encryption-keys networks private-access , , storage , , vpc-endpoints workspaces - Rozliczenia: billable-usage , log-delivery - OAuth: custom-app-integration , o-auth-published-apps , , published-app-integration service-principal-secrets |
Auth | Polecenia uwierzytelniania:describe , , env , login , , profiles token |
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 , , patch update |
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 update get-permission-levels |
service-principals |
Polecenia tożsamości do użycia z zadaniami, zautomatyzowanymi narzędziami i systemami, takimi jak skrypty, aplikacje i platformy ciągłej integracji/ciągłego wdrażania:create , , delete , get , list , , patch update |
users |
Polecenia dla tożsamości użytkowników rozpoznawanych przez usługę Databricks i reprezentowane przez adresy e-mail:create , , delete , get , list , , patch update get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia związane z językiem SQL
Grupuj | Opis i polecenia |
---|---|
alerts |
Polecenia do wykonywania operacji na alertach:create , , delete , get , , list update |
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 , , restore update |
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 , get get-workspace-warehouse-config , list , , set-workspace-warehouse-config start stop get-permission-levels , , get-permissions , , set-permissions update-permissions |
Polecenia katalogu Unity
Grupuj | 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 interfejsie użytkownika, aby użytkownicy mogli korzystać z tych artefaktów na obliczeniach skonfigurowanych w trybie dostępu współdzielonego:get , update |
catalogs |
Polecenia do zarządzania katalogami — pierwsza warstwa trójpoziomowej przestrzeni nazw Unity Catalog:create , , delete , get , , list update |
connections |
Polecenia umożliwiające utworzenie połączenia z zewnętrznym źródłem danych:create , , delete , get , , list update |
external-locations |
Polecenia do zarządzania lokalizacjami zewnętrznymi, które łączą ścieżkę magazynu w chmurze z poświadczeniami magazynu, które autoryzują dostęp do ścieżki magazynu w chmurze:create , , delete , get , , list update |
functions |
Polecenia do zarządzania User-Defined Functions (UDF) w katalogu aparatu Unity:create , , delete , get , , list update |
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 , , list update |
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-refresh update |
registered-models |
Polecenia do zarządzania zarejestrowanymi modelami. Databricks udostępnia hostowaną wersję rejestru modeli MLflow w katalogu Unity Catalog.create , delete , , delete-alias , get , list , , set-alias update |
schemas |
Polecenia do zarządzania schematami, które są drugą warstwą trójpoziomowej przestrzeni nazw katalogu Unity.create , , delete , get , , list update |
storage-credentials |
Komendy do zarządzania poświadczeniami magazynu, które są mechanizmem uwierzytelniania i autoryzacji w celu uzyskania dostępu do danych przechowywanych na Twoim koncie chmurowym:create , , delete , get , list , , update validate |
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ę na trzeciej warstwie namespace Katalogu Unity:delete , , exists , get , , list list-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 , , read update |
workspace-bindings |
Polecenia do zarządzania zabezpieczanymi powiązaniami obszaru roboczego. Zabezpieczanie w usłudze Databricks można skonfigurować jako OPEN lub ISOLATED .get , , get-bindings , , update update-bindings |
Polecenia udostępniania różnicowego
Grupuj | Opis i polecenia |
---|---|
providers |
Polecenia do zarządzania dostawcami danych, które reprezentują organizacje, które udostępniają dane:create , , delete , get , list , , list-shares update |
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 tworzy się przy użyciu :method:recipients/create , aby reprezentować organizację, której chcesz zezwolić na dostęp do udziałów.create , , delete , get , list , , rotate-token update share-permissions |
shares |
Polecenia do zarządzania zasobami, które są kontenerami utworzonymi za pomocą :method:shares/create :create , , delete , get , , list update share-permissions , update-permissions |
Polecenia ustawień
Grupuj | Opis i polecenia |
---|---|
ip-access-lists |
Polecenia umożliwiające administratorom konfigurowanie list dostępu do adresów IP:create , , delete , get , list , , replace update |
settings |
Polecenia umożliwiające użytkownikom zarządzanie ustawieniami na poziomie obszaru roboczego:automatic-cluster-update , , csp-enablement , default-namespace , , esm-enablement restrict-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 , , get list get-permission-levels , , get-permissions , , set-permissions update-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
Grupuj | 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 |
synchronizacji | Synchronizowanie katalogu lokalnego z katalogiem obszaru roboczego. |
Polecenia wyszukiwania wektorowego
Grupuj | 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-endpoint list-endpoints |
vector-search-indexes |
Polecenia do zarządzania indeksami wyszukiwania wektorów, wydajną reprezentacją wektorów osadzania, które obsługują zapytania wyszukiwania w czasie rzeczywistym i wydajne przybliżone najbliższego sąsiada (ANN):create-index , delete-data-vector-index , , delete-index , get-index list-indexes , , query-index , , sync-index upsert-data-vector-index |
Polecenia pulpitu nawigacyjnego
Grupuj | Opis i polecenia |
---|---|
dashboards |
Polecenia do modyfikowania pulpitów nawigacyjnych:create , , delete , get , list , , restore update |
lakeview |
Polecenia, które zapewniają określone operacje zarządzania dla pulpitów nawigacyjnych sztucznej inteligencji/analizy biznesowej:create , get , , get-published , migrate publish , , trash , , unpublish update |
Dodatkowe polecenia
Grupuj | Opis i polecenia |
---|---|
api | Polecenia do tworzenia żądań do interfejsu API REST usługi Databricks:delete , , get , head , patch , , post put |
ukończenie | Polecenia służące do generowania skryptu autouzupełniania dla określonej powłoki:bash , , fish , , powershell zsh |
konfigurować | Skonfiguruj interfejs wiersza polecenia usługi Databricks. |
help |
Dane wyjściowe informacji o użyciu dla dowolnego polecenia. |
Labs | Polecenia do zarządzania instalacjami usługi Databricks Labs:clear-cache , install , , installed , list , show , , uninstall upgrade |
version |
Pobierz obecnie używaną wersję interfejsu wiersza polecenia. |
Flagi globalne
Następujące flagi są dostępne dla wszystkich poleceń interfejsu wiersza polecenia usługi 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 wiersza polecenia.
Flaga | opis |
---|---|
-h lub --help |
Wyświetl pomoc dotyczącą interfejsu wiersza polecenia usługi Databricks lub powiązanej grupy poleceń lub powiązanego polecenia. |
-e lub --environment string |
Ciąg reprezentujący środowisko pakietu do użycia, jeśli dotyczy powiązanego polecenia. |
--log-file |
Ciąg reprezentujący ciąg do zapisywania 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 dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony. |
-o lub --output |
text w celu zapisania danych wyjściowych jako tekstu lub json 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 DEFAULT , zostanie użyty nazwany profil, jeśli 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 |