Teilen über


apps Befehlsgruppe

Note

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Mit apps der Befehlsgruppe in der Databricks CLI können Sie Apps verwalten. Apps werden direkt auf der Databricks-Instanz eines Kunden ausgeführt, in ihre Daten integriert, Databricks-Dienste verwendet und erweitert und ermöglichen Benutzern die Interaktion über einmaliges Anmelden. Siehe Databricks-Apps.

Databricks-Apps erstellen

Erstellen Sie eine neue App.

databricks apps create NAME [flags]

Arguments

NAME

    Der Name der App. Der Name darf nur alphanumerische Zeichen und Bindestriche in Kleinbuchstaben enthalten. Er muss innerhalb des Arbeitsbereichs eindeutig sein.

Options

--budget-policy-id string

    Budgetrichtlinien-ID für die App.

--description string

    Beschreibung der App.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--no-compute

    Falls "true", wird die App nach der Erstellung nicht gestartet.

--no-wait

    Warten Sie nicht, bis der ACTIVE-Zustand erreicht ist.

--timeout duration

    Maximale Zeitspanne, um den ACTIVE-Zustand zu erreichen (Standard 20m0s).

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine einfache App erstellt:

databricks apps create my-analytics-app --description "Analytics dashboard app"

Im folgenden Beispiel wird eine App erstellt, ohne sie zu starten:

databricks apps create my-data-app --description "Data processing app" --no-compute

Im folgenden Beispiel wird eine App mit einem benutzerdefinierten Timeout erstellt:

databricks apps create my-ml-app --description "Machine learning app" --timeout 30m

Databricks-Apps löschen

Löschen sie eine App.

databricks apps delete NAME [flags]

Arguments

NAME

    Der Name der App.

Options

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine App gelöscht:

databricks apps delete my-analytics-app

Databricks-Anwendungen implementieren

Erstellen Sie eine App-Bereitstellung für die App mit dem angegebenen Namen.

databricks apps deploy APP_NAME [flags]

Arguments

APP_NAME

    Der Name der App.

Options

--deployment-id string

    Die eindeutige ID der Bereitstellung.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--mode AppDeploymentMode

    Der Modus, in dem die Bereitstellung den Quellcode verwaltet. Unterstützte Werte: AUTO_SYNC, SNAPSHOT.

--no-wait

    Warten Sie nicht, bis der Status "ERFOLGREICH" erreicht ist.

--source-code-path string

    Der Dateisystempfad des Arbeitsbereichs für den Quellcode, der zur Bereitstellung der App verwendet wird.

--timeout duration

    Maximale Zeitspanne, um den STATUS ERFOLGREICH zu erreichen (Standard 20m0s).

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine Bereitstellung mit dem automatischen Synchronisierungsmodus erstellt:

databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC

Im folgenden Beispiel wird eine Bereitstellung im Snapshot-Modus erstellt:

databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT

Im folgenden Beispiel wird eine Bereitstellung mit einer benutzerdefinierten Bereitstellungs-ID erstellt:

databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app

Databricks-Apps abrufen

Rufen Sie Informationen zur App mit dem angegebenen Namen ab.

databricks apps get NAME [flags]

Arguments

NAME

    Der Name der App.

Options

Globale Kennzeichnungen

Examples

Das folgende Beispiel ruft App-Informationen ab:

databricks apps get my-analytics-app

Das folgende Beispiel ruft App-Informationen im JSON-Format ab:

databricks apps get my-data-app --output json

Das folgende Beispiel ruft App-Informationen mithilfe eines bestimmten Profils ab:

databricks apps get my-ml-app --profile production

databricks apps get-deployment

Informationen zur App-Bereitstellung mit dem angegebenen Namen und der Bereitstellungs-ID abrufen.

databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]

Arguments

APP_NAME

    Der Name der App.

DEPLOYMENT_ID

    Die eindeutige ID der Bereitstellung.

Options

Globale Kennzeichnungen

Examples

Das folgende Beispiel ruft Informationen zur Bereitstellung ab:

databricks apps get-deployment my-analytics-app v1.0.0

Das folgende Beispiel ruft Bereitstellungsinformationen im JSON-Format ab:

databricks apps get-deployment my-data-app v2.1.0 --output json

Das folgende Beispiel ruft Informationen zur Bereitstellung über ein bestimmtes Profil ab:

databricks apps get-deployment my-ml-app latest --profile production

Databricks-App-Liste

Listet alle Apps im Arbeitsbereich auf.

databricks apps list [flags]

Arguments

None

Options

--page-size int

    Obere Grenze für zurückgegebene Elemente.

--page-token string

    Paginierungstoken, um zur nächsten Seite von Anwendungen zu wechseln.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden alle Apps aufgelistet:

databricks apps list

Im folgenden Beispiel werden Apps mit einem bestimmten Seitenformat aufgelistet:

databricks apps list --page-size 10

Im folgenden Beispiel werden Apps mit Paginierung aufgelistet:

databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

databricks apps Listenbereitstellungen

Listet alle App-Bereitstellungen für die App mit dem angegebenen Namen auf.

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    Der Name der App.

Options

--page-size int

    Obere Grenze für zurückgegebene Elemente.

--page-token string

    Paginierungstoken, um zur nächsten Seite von Anwendungen zu wechseln.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden alle Bereitstellungen für eine App aufgelistet:

databricks apps list-deployments my-analytics-app

Im folgenden Beispiel werden Bereitstellungen mit einer bestimmten Seitengröße aufgelistet:

databricks apps list-deployments my-data-app --page-size 10

Databricks-App-Protokolle

Streamen Sie stdout/stderr-Protokolle für eine Databricks-App mit ihrem Protokolldatenstrom. Standardmäßig ruft dieser Befehl die neuesten Logs bis zu --tail-lines ab und beendet sich. Die serverseitige Filterung ist über --search verfügbar, und die clientseitige Filterung ist über --source APP|SYSTEM verfügbar.

databricks apps logs NAME [flags]

Arguments

NAME

    Der Name der App.

Options

-f, --follow

    Fahren Sie mit dem Streamen von Protokollen fort, bis es abgebrochen wird oder eine angegebene Zeitüberschreitung erreicht ist.

--tail-lines int

    Anzahl der zuletzt verwendeten Protokollzeilen, die vor dem Streaming angezeigt werden sollen. Setzen Sie 0 fest, um alles anzuzeigen. Standardwert: 200

--timeout duration

    Maximale Zeit zum Streamen, wenn --follow festgelegt wird. Stellen Sie den Wert auf 0, um das Timeout zu deaktivieren.

--search string

    Senden Sie vor dem Streaming einen Suchbegriff an den Protokolldienst.

--source strings

    Protokolle auf APP- oder SYSTEM-Quellen beschränken.

--output-file string

    Optionaler Dateipfad zum Schreiben von Protokollen zusätzlich zu Stdout.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden die neuesten Protokolle für eine App abgerufen:

databricks apps logs my-analytics-app

Im folgenden Beispiel werden Protokolle kontinuierlich gestreamt, bis sie unterbrochen wurden:

databricks apps logs my-analytics-app --follow

Im folgenden Beispiel werden die letzten 500 Protokollzeilen abgerufen:

databricks apps logs my-data-app --tail-lines 500

Im folgenden Beispiel werden Protokolle mit einem Timeout von 10 Minuten gestreamt:

databricks apps logs my-ml-app --follow --timeout 10m

Im folgenden Beispiel werden Protokolle nach einem Suchbegriff gefiltert:

databricks apps logs my-analytics-app --search "error"

Im folgenden Beispiel werden Protokolle nur auf die App-Ebenen-Ausgabe beschränkt.

databricks apps logs my-data-app --source APP

Im folgenden Beispiel werden Protokolle sowohl in stdout als auch in eine Datei geschrieben:

databricks apps logs my-ml-app --output-file /tmp/app-logs.txt

Databricks-Apps lokal ausführen

Starten Sie eine App lokal.

databricks apps run-local [flags]

Arguments

None

Options

--app-port int

    Port, für den die App ausgeführt werden soll (Standard 8000).

--debug

    Aktivieren des Debug-Modus.

--debug-port string

    Port, auf dem der Debugger ausgeführt werden soll.

--entry-point string

    Geben Sie den benutzerdefinierten Einstiegspunkt mit konfiguration (.yml Datei) für die App an. Wird standardmäßig auf app.yml festgelegt.

--env strings

    Legen Sie Umgebungsvariablen fest.

--port int

    Port, auf dem der App-Proxy ausgeführt werden soll (Standard 8001).

--prepare-environment

    Bereitet die Umgebung für die Ausführung der App vor. Erfordert die Installation von UV.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine App lokal mit Standardeinstellungen ausgeführt:

databricks apps run-local

Im folgenden Beispiel wird eine App lokal auf einem bestimmten Port ausgeführt:

databricks apps run-local --app-port 9000 --port 9001

Databricks-Apps starten

Starten Sie die letzte aktive Bereitstellung der App im Arbeitsbereich.

databricks apps start NAME [flags]

Arguments

NAME

    Der Name der App.

Options

--no-wait

    Warten Sie nicht, bis der ACTIVE-Zustand erreicht ist.

--timeout duration

    Maximale Zeitspanne, um den ACTIVE-Zustand zu erreichen (Standard 20m0s).

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine App gestartet:

databricks apps start my-analytics-app

Im folgenden Beispiel wird eine App gestartet, ohne zu warten:

databricks apps start my-data-app --no-wait

Im folgenden Beispiel wird eine App mit einem benutzerdefinierten Timeout gestartet:

databricks apps start my-ml-app --timeout 30m

Databricks-Anwendungen beenden

Beenden Sie die aktive Bereitstellung der App im Arbeitsbereich.

databricks apps stop NAME [flags]

Arguments

NAME

    Der Name der App.

Options

--no-wait

    Warten Sie nicht, bis der Status "GESTOPPT" erreicht ist.

--timeout duration

    Maximale Zeitspanne, um den STATUS "STOPP" zu erreichen (Standard 20m0s).

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine App beendet:

databricks apps stop my-analytics-app

Im folgenden Beispiel wird eine App beendet, ohne darauf zu warten:

databricks apps stop my-data-app --no-wait

Im folgenden Beispiel wird eine App mit einem benutzerdefinierten Timeout beendet:

databricks apps stop my-ml-app --timeout 30m

Databricks-Apps aktualisieren

Aktualisieren Sie die App mit dem angegebenen Namen.

databricks apps update NAME [flags]

Arguments

NAME

    Der Name der App. Der Name darf nur alphanumerische Zeichen und Bindestriche in Kleinbuchstaben enthalten. Er muss innerhalb des Arbeitsbereichs eindeutig sein.

Options

--budget-policy-id string

    Budgetrichtlinien-ID für die App.

--description string

    Beschreibung der App.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird die Beschreibung einer App aktualisiert:

databricks apps update my-analytics-app --description "Updated analytics dashboard"

databricks-Apps Berechtigungsstufen abrufen

Rufen Sie App-Berechtigungsstufen ab.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    Die App, für die Berechtigungen abgerufen oder verwaltet werden sollen.

Options

Globale Kennzeichnungen

Examples

Das folgende Beispiel ruft Berechtigungsstufen für eine App ab:

databricks apps get-permission-levels my-analytics-app

databricks apps Berechtigungen-abrufen

Rufen Sie die Berechtigungen einer App ab. Apps können Berechtigungen von ihrem Stammobjekt erben.

databricks apps get-permissions APP_NAME [flags]

Arguments

APP_NAME

    Die App, für die Berechtigungen abgerufen oder verwaltet werden sollen.

Options

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden Berechtigungen für eine App abgerufen:

databricks apps get-permissions my-analytics-app

Das folgende Beispiel verwendet ein bestimmtes Profil, um Berechtigungen zu erhalten:

databricks apps get-permissions my-ml-app --profile production

databricks apps Berechtigungen festlegen

Legen Sie App-Berechtigungen fest.

Legt Berechtigungen für ein Objekt fest, wobei vorhandene Berechtigungen ersetzt werden, sofern vorhanden. Löscht alle direkten Berechtigungen, wenn keine angegeben sind. Objekte können Berechtigungen vom Stammobjekt erben.

databricks apps set-permissions APP_NAME [flags]

Arguments

APP_NAME

    Die App, für die Berechtigungen abgerufen oder verwaltet werden sollen.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden Berechtigungen mithilfe der JSON-Konfiguration festgelegt:

databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

Databricks-Apps-Berechtigungen aktualisieren

Aktualisieren Sie die Berechtigungen für eine App. Apps können Berechtigungen von ihrem Stammobjekt erben.

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    Die App, für die Berechtigungen abgerufen oder verwaltet werden sollen.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden Berechtigungen mithilfe der JSON-Konfiguration aktualisiert:

databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel