Polecenia CLI Databricks

Note

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs CLI Databricks jest w publicznej wersji testowej.

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

Wiele poleceń CLI odpowiada operacjom udokumentowanym w dokumentacji Azure Databricks REST API.

Polecenia obszaru roboczego

Group	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

Group	Opis i polecenia
zasady klastra	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, 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-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
pule wystąpień	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
profile wystąpień	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
Biblioteki	Polecenia instalowania, odinstalowywania i pobierania stanu bibliotek w klastrze: all-cluster-statuses, , cluster-status, , installuninstall
rodziny zasad	Polecenia do wyświetlenia dostępnych typów polityk. get, list

Polecenia zadań

Group	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-permissionsupdate-permissions

Polecenia deklaratywne potoków platformy Spark w usłudze Lakeflow

Group	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 związane z uczeniem maszynowym

Group	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
inżynieria cech	Polecenia umożliwiające interakcję z funkcjami w magazynie funkcji usługi Databricks, która udostępnia centralny rejestr funkcji używanych w modelach sztucznej inteligencji i uczenia maszynowego. create-feature, , delete-feature, get-feature, , list-featuresupdate-feature
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-webhook get-permission-levels, , get-permissions, , set-permissionsupdate-permissions

Polecenia przetwarzania w czasie rzeczywistym

Group	Opis i polecenia
obsługa punktów końcowych	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ścią i dostępem

Group	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, , profilestoken
bieżący użytkownik	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, update get-permission-levels
jednostki usługi	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, , patchupdate get-permission-levels, , get-permissions, , set-permissionsupdate-permissions

Polecenia związane z językiem SQL

Group	Opis i polecenia
alerts	Polecenia do wykonywania operacji na alertach: create, , delete, get, , listupdate
alerts-legacy	Komendy do wykonywania operacji na starszych alertach: create, , delete, get, , listupdate
źródła danych	Polecenia służące do tworzenia nowych obiektów zapytań: list
queries	Polecenia do wykonywania operacji na definicjach zapytań: create, , delete, get, list, , restoreupdate
zapytania-legacy	Polecenia do wykonywania operacji na starszych definicjach zapytań: create, , delete, get, list, , restoreupdate
historia zapytań	Polecenia umożliwiające dostęp do historii zapytań za pośrednictwem usługi SQL Warehouse: list
Magazyny	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

Group	Opis i polecenia
listy dozwolonych artefaktów	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ójwarstwowej przestrzeni nazw Unity Catalog: create, , delete, get, , listupdate
Poświadczenia	Polecenia do zarządzania poświadczeniami, które są mechanizmem uwierzytelniania i autoryzacji na potrzeby uzyskiwania dostępu do usług w dzierżawie chmury. Każde poświadczenie podlega zasadom kontroli dostępu Unity Catalog, które określają, którzy użytkownicy i grupy mogą uzyskiwać dostęp do poświadczenia. create-credential, delete-credential, , generate-temporary-service-credential, get-credential, list-credentials, , update-credentialvalidate-credential
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: create, , delete, get, , listupdate
grants	Polecenia udzielania dostępu do danych w katalogu Unity: get get-effective, update
metastore	Polecenia do zarządzania repozytoriami metadanych, które są głównym kontenerem obiektów w Unity Catalog: assign, create, , , currentdeletegetlistsummaryunassignupdateupdate-assignment
wersje modelu	Polecenia do zarządzania wersjami modelu. Usługa Databricks oferuje hostowaną wersję rejestru modeli MLflow w Unity Catalog. delete, , get, get-by-alias, , listupdate
tabele online	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
monitory jakości	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
zarejestrowane modele	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
przydziały zasobów	Polecenia do zarządzania limitami zasobów wymuszanymi przez katalog Unity na wszystkich obiektach podlegających zabezpieczeniu, ograniczające liczbę zasobów, które można utworzyć. get-quota, list-quotas
schemas	Polecenia do zarządzania schematami, które są drugą warstwą trzystopniowej przestrzeni nazw Unity Catalog. 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
schematy systemowe	Polecenia do zarządzania schematami systemowymi, które są schematami, które znajdują się w katalogu systemowym: disable enable, list
ograniczenia tabeli	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 przestrzeni nazw trójpoziomowego katalogu Unity: delete, , exists, get, , listlist-summaries
tymczasowe dane uwierzytelniające tabeli	Polecenia do zarządzania tymczasowymi poświadczeniami tabeli, które są krótkotrwałymi poświadczeniami z ograniczonym zakresem, używanymi do uzyskiwania dostępu do lokalizacji przechowywania danych w chmurze, w których dane tabeli są przechowywane w usłudze Databricks. generate-temporary-table-credentials
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
powiązania obszaru roboczego	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

Group	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
aktywacja odbiorcy	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
Adresatów	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-tokenupdate share-permissions
udziały	Polecenia do zarządzania zasobami, które są kontenerami utworzonymi za pomocą :method:shares/create: create, , delete, get, list, , list-sharesupdate share-permissions, update-permissions

Polecenia ustawień

Group	Opis i polecenia
listy dostępu ip	Polecenia umożliwiające administratorom konfigurowanie list dostępu do adresów IP: create, , delete, get, list, , replaceupdate
miejsca docelowe powiadomień	Polecenia do zarządzania miejscami docelowymi powiadomień obszaru roboczego: create, , delete, get, , listupdate
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
zarządzanie tokenami	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
Tokeny	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

Group	Opis i polecenia
bundle	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 plan run schema summary sync validate
sync	Synchronizowanie katalogu lokalnego z katalogiem obszaru roboczego.

Polecenia wyszukiwania wektorowego

Group	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

Group	Opis i polecenia
dashboards	Polecenia do modyfikowania starszych pulpitów nawigacyjnych: create, , delete, get, list, , restoreupdate
genie	Polecenia służące do modyfikowania usługi Genie, która zapewnia użytkownikom biznesowym środowisko bez kodu obsługiwane przez sztuczną inteligencję/usługę BI: create-message, , execute-message-attachment-query, get-message, get-message-attachment-query-result, , get-spacedstart-conversation
Lakeview	Polecenia, które umożliwiają określone operacje zarządzania dla pulpitów nawigacyjnych AI/BI: create, create-schedule, , , create-subscriptiondelete-scheduledelete-subscriptiongetget-publishedget-scheduleget-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublishupdateupdate-schedule

Polecenia witryny Marketplace

Group	Opis i polecenia
realizacje dla konsumentów	Polecenia do zarządzania realizacjami, które są jednostkami, które umożliwiają konsumentom wyświetlanie podglądu instalacji. get, list
instalacje konsumenckie	Polecenia do zarządzania instalacjami, które są jednostkami umożliwiającymi konsumentom interakcję z ofertami w Marketplace Databricks. create, , delete, list, , list-listing-installationsupdate
listy konsumentów	Polecenia zarządzania ofertami dla konsumentów w witrynie Databricks Marketplace: batch-get, , get, , listsearch
żądania personalizacji konsumenckiej	Polecenia do zarządzania żądaniami personalizacji, które umożliwiają klientom interakcję ze spersonalizowanym przepływem ofert na Marketplace. create get, list
dostawcy usług konsumenckich	Polecenia do zarządzania dostawcami, które są podmiotami zamieszczającymi ogłoszenia w witrynie Marketplace. batch-get get, list
filtry-wymiany-dostawcy	Polecenia do zarządzania filtrami wymiany w witrynie Marketplace, które umożliwiają zarządzanie grupami, które mogą uzyskiwać dostęp do wymiany. create, , delete, , listupdate
wymiany z dostawcami	Polecenia do zarządzania wymianami w witrynie Marketplace, które umożliwiają dostawcom udostępnianie swoich ofert zestawowi wyselekcjonowanych klientów. add-listing-to-exchange, create, , delete, delete-listing-from-exchangeget, list, , list-exchanges-for-listinglist-listings-for-exchangeupdate
pliki dostawcy	Polecenia do zarządzania plikami Marketplace, takimi jak notesy podglądowe i ikony dostawcy. create, , delete, , getlist
lista dostawców	Polecenia do zarządzania listami dostawców: create, , delete, get, , listupdate
żądania dostawcy dotyczące personalizacji	Polecenia do zarządzania żądaniami personalizacji, które są alternatywą dla list dostępnych od ręki. list, update
tablice-analytics-dostawcy-usług	Polecenia do zarządzania analizami szablonowymi dla dostawców: create, , get, , get-latest-versionupdate
dostawca-dostawcy	Polecenia do zarządzania dostawcami, które zarządzają zasobami na platformie Marketplace. create, , delete, get, , listupdate

Polecenia aplikacji

Group	Opis i polecenia
apps	Polecenia do zarządzania aplikacjami usługi Databricks, które są uruchamiane bezpośrednio w wystąpieniu usługi Databricks, integrują się z danymi, używają i rozszerzają usługi Databricks oraz umożliwiają użytkownikom interakcję za pomocą logowania jednokrotnego. create delete deploy get get-deployment list list-deployments logs run-local start stop update

Polecenia czyszczenia pomieszczeń

Group	Opis i polecenia
czyste pomieszczenie - zasoby	Polecenia do zarządzania zasobami środowisk czystych, które są danymi i obiektami kodu, takimi jak tabele, woluminy i notatniki, współużytkowanymi w środowisku czystym. create, , delete, get, , listupdate
wykonania zadań w czystym pomieszczeniu	Polecenia do zarządzania wykonaniami zadań w pomieszczeniu czystym, które są uruchomieniami notebooków w czystym pomieszczeniu. list
czyste pokoje	Polecenia do zarządzania czystymi pokojami. Czyste pomieszczenia korzystają z funkcji Delta Sharing i bezserwerowych zasobów obliczeniowych, aby zapewnić bezpieczne i chroniące prywatność środowisko, w którym wiele stron może współpracować ze sobą na poufnych danych przedsiębiorstwa bez bezpośredniego dostępu do danych. create, , create-output-catalog, delete, get, , listupdate

Polecenia bazy danych

Group

Opis i polecenia

baza danych

Polecenia do zarządzania wystąpieniami bazy danych Lakebase. create-database-catalog create-database-instance create-database-table create-synced-database-table delete-database-catalog delete-database-instance delete-database-table delete-synced-database-table find-database-instance-by-uid generate-database-credential get-database-catalog get-database-instance get-database-table get-synced-database-table list-database-instances update-database-instance

Dodatkowe polecenia

Group	Opis i polecenia
api	Polecenia do tworzenia żądań do interfejsu API REST usługi Databricks: delete, , get, head, patch, , postput
completion	Polecenia służące do generowania skryptu autouzupełniania dla określonej powłoki: bash, , fish, , powershellzsh
configure	Skonfiguruj interfejs wiersza polecenia usługi Databricks.
help	Informacje podsumowujące dla wszystkich poleceń CLI Databricks.
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ń.

--debug

  Czy włączyć logowanie debugowe.

-h lub --help

    Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia.

--log-file struna

    Ciąg reprezentujący plik 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 formatowanie

    Format typu logu text lub json. Wartość domyślna to text.

--log-level struna

    Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony.

-o, --output typ

    Typ danych wyjściowych polecenia: text lub json. Wartość domyślna to text.

-p, --profile struna

    Nazwa profilu pliku ~/.databrickscfg, którego użyć do uruchomienia polecenia. Jeśli ta flaga nie zostanie określona, zostanie użyty profil o nazwie DEFAULT .

--progress-format formatowanie

    Format wyświetlania dzienników postępu: default, , appendinplacelubjson

-t, --target struna

    Jeśli ma to zastosowanie, docelowy obiekt pakietu do użycia