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, , 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, , listupdate get-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, , listmkdirs get-permission-levels, , get-permissions, , set-permissionsupdate-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, , getlist get-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, deleteediteventsgetlistlist-node-typeslist-zonespermanent-deletepinresizerestartspark-versionsstartunpin get-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, , getlist get-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 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, , createdeletedelete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdate get-permission-levels, , get-permissions, , set-permissionsupdate-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, , , getget-updatelist-pipeline-eventslist-pipelineslist-updatesstart-updatestopupdate get-permission-levels, , get-permissions, , set-permissionsupdate-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-rundelete-experimentdelete-rundelete-runsdelete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run get-permission-levels, , get-permissions, , set-permissionsupdate-permissions
model-registry	Polecenia rejestru modeli obszaru roboczego: approve-transition-request, create-comment, , create-modelcreate-model-versioncreate-transition-requestcreate-webhookdelete-commentdelete-modeldelete-model-tagdelete-model-versiondelete-model-version-tagdelete-transition-requestdelete-webhookget-latest-versionsget-modelget-model-versionget-model-version-download-urilist-modelslist-transition-requestslist-webhooksreject-transition-requestrename-modelsearch-model-versionssearch-modelsset-model-tagset-model-version-tagtest-registry-webhooktransition-stageupdate-commentupdate-modelupdate-model-versionupdate-webhook get-permission-levels, , get-permissions, , set-permissionsupdate-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, , , deleteexport-metricsgetlistlogspatchputqueryupdate-config get-permission-levels, , get-permissions, , set-permissionsupdate-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, , groupsservice-principals, , usersworkspace-assignment — Katalog Unity: metastore-assignments, metastores, storage-credentials - Ustawienia: ip-access-lists, , network-connectivitysettings - Aprowizowanie: credentials, , encryption-keysnetworksprivate-access, , storage, , vpc-endpointsworkspaces - Rozliczenia: billable-usage, log-delivery - OAuth: custom-app-integration, o-auth-published-apps, , published-app-integrationservice-principal-secrets
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, , setupdate 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, , patchupdate
users	Polecenia dla tożsamości użytkowników rozpoznawanych przez usługę Databricks i reprezentowane przez adresy e-mail: create, , delete, get, list, , patchupdate get-permission-levels, , get-permissions, , set-permissionsupdate-permissions

Polecenia związane z językiem SQL

Grupuj	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-configstartstop get-permission-levels, , get-permissions, , set-permissionsupdate-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, , 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ę magazynu w chmurze z poświadczeniami magazynu, które autoryzują dostęp do ścieżki magazynu w chmurze: create, , delete, get, , listupdate
functions	Polecenia do zarządzania User-Defined Functions (UDF) w katalogu aparatu Unity: create, , delete, get, , listupdate
grants	Polecenia udzielania dostępu do danych w katalogu Unity: get, , get-effectiveupdate
metastores	Polecenia do zarządzania repozytoriami metadanych, które są głównym kontenerem obiektów w Unity Catalog: assign, create, , , currentdeletegetlistsummaryunassignupdateupdate-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, , deleteget
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. Databricks udostępnia hostowaną wersję rejestru modeli MLflow w katalogu 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	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, , updatevalidate
system-schemas	Polecenia do zarządzania schematami systemowymi, które są schematami, które znajdują się w katalogu systemowym: disable, , enablelist
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, , 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. Zabezpieczanie w usłudze Databricks można skonfigurować jako OPEN lub ISOLATED. get, , get-bindings, , updateupdate-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-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 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-tokenupdate share-permissions
shares	Polecenia do zarządzania zasobami, które są kontenerami utworzonymi za pomocą :method:shares/create: create, , delete, get, , listupdate 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, , 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, , getlist get-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, , deletelist
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, , , destroygenerateinitopenrunschemasummarysyncvalidate
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-endpointlist-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-indexlist-indexes, , query-index, , sync-indexupsert-data-vector-index

Polecenia pulpitu nawigacyjnego

Grupuj	Opis i polecenia
dashboards	Polecenia do modyfikowania pulpitów nawigacyjnych: create, , delete, get, list, , restoreupdate
lakeview	Polecenia, które zapewniają określone operacje zarządzania dla pulpitów nawigacyjnych sztucznej inteligencji/analizy biznesowej: create, get, , get-published, migratepublish, , trash, , unpublishupdate

Dodatkowe polecenia

Grupuj	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	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, , uninstallupgrade
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