apps gruppo di comandi

Il apps gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks consente di gestire le app. Le app vengono eseguite direttamente nell'istanza di Databricks di un cliente, si integrano con i dati, usano ed estendono i servizi di Databricks e consentono agli utenti di interagire tramite Single Sign-On. Vedere App di Databricks.

Creare applicazioni databricks

Crea una nuova app.

databricks apps create NAME [flags]

Arguments

NAME

    Nome dell'app. Il nome deve contenere solo caratteri alfanumerici minuscoli e trattini. Deve essere univoco all'interno dell'area di lavoro.

Options

--budget-policy-id string

    ID della politica di budget per l'app.

--compute-size ComputeSize

    Dimensione di calcolo per l'app. Valori supportati: LARGE, MEDIUM.

--description string

    Descrizione dell'app.

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

--no-compute

    Se vero, l'app non verrà avviata dopo la creazione.

--no-wait

    Non attendere il raggiungimento dello stato ATTIVO.

--space string

    Nome dello spazio a cui appartiene l'app.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato ATTIVO (impostazione predefinita 20m0s).

--usage-policy-id string

    ID dei criteri di utilizzo per l'app.

Flag globali

Examples

L'esempio seguente crea un'app di base:

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

L'esempio seguente crea un'app senza avviarla:

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

L'esempio seguente crea un'app con un timeout personalizzato:

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

creazione-aggiornamento delle app databricks

Crea un aggiornamento dell'app e avvia il processo di aggiornamento. Il processo di aggiornamento è asincrono e lo stato dell'aggiornamento può essere controllato con il metodo GetAppUpdate.

databricks apps create-update APP_NAME UPDATE_MASK [flags]

Arguments

APP_NAME

    Nome dell'app.

UPDATE_MASK

    La maschera di campo deve essere una singola stringa, con più campi separati da virgole (senza spazi). Il percorso del campo è relativo all'oggetto risorsa, usando un punto (.) per esplorare i sottocampi (ad esempio, author.given_name). La specifica degli elementi nei campi sequenza o mappa non è consentita, perché è possibile specificare solo l'intero campo della raccolta. I nomi dei campi devono corrispondere esattamente ai nomi dei campi delle risorse.

    Una maschera di campo * indica la sostituzione completa. È consigliabile elencare sempre in modo esplicito i campi da aggiornare ed evitare di usare * caratteri jolly, in quanto può causare risultati imprevisti se l'API cambia in futuro.

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

--no-wait

    Non attendere il raggiungimento dello stato SUCCEEDED.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato SUCCEEDED (impostazione predefinita 20m0s).

Flag globali

Examples

L'esempio seguente crea un aggiornamento dell'app con una maschera di campo specifica:

databricks apps create-update my-analytics-app "description" --json '{"description": "Updated app description"}'

L'esempio seguente crea un aggiornamento dell'app senza attendere il completamento:

databricks apps create-update my-data-app "budget_policy_id" --json '{"budget_policy_id": "new-policy-123"}' --no-wait

L'esempio seguente crea un aggiornamento dell'app con un timeout personalizzato:

databricks apps create-update my-ml-app "description,budget_policy_id" --json '{"description": "Updated ML app", "budget_policy_id": "ml-policy-456"}' --timeout 30m

Eliminazione delle app databricks

Eliminare un'app.

Quando viene eseguito da una directory di progetto di Databricks Apps (contenente databricks.yml) senza un NAME argomento, questo comando elimina tutte le risorse distribuite dal progetto. Quando viene NAME specificato un argomento o quando non si trova in una directory del progetto, elimina direttamente l'app specificata usando l'API.

databricks apps delete [NAME] [flags]

Arguments

NAME

    Nome dell'app. Obbligatorio quando non si trova in una directory del progetto. Quando viene fornito in una directory del progetto, usa l'eliminazione dell'API anziché l'eliminazione definitiva del progetto.

Options

--auto-approve

    Ignorare le approvazioni interattive per l'eliminazione di risorse e file.

--force-lock

    Forzare l'acquisizione del blocco di distribuzione.

Flag globali

Examples

L'esempio seguente elimina un'app:

databricks apps delete my-analytics-app

Nell'esempio seguente vengono eliminate tutte le risorse del progetto da una directory del progetto:

databricks apps delete

L'esempio seguente elimina definitivamente le risorse del progetto con l'approvazione automatica:

databricks apps delete --auto-approve

Distribuzione di app Databricks

Creare una distribuzione di app.

Quando viene eseguito da una directory di progetto di Databricks Apps (contenente databricks.yml) senza un APP_NAME argomento, questo comando esegue una pipeline di distribuzione avanzata che convalida il progetto, lo distribuisce nell'area di lavoro ed esegue l'app. APP_NAME Quando viene specificato un argomento o quando non si trova in una directory del progetto, crea direttamente una distribuzione di app usando l'API.

databricks apps deploy [APP_NAME] [flags]

Arguments

APP_NAME

    Nome dell'app. Obbligatorio quando non si trova in una directory del progetto. Se specificato in una directory del progetto, usa la distribuzione api anziché la distribuzione del progetto.

Options

--deployment-id string

    ID univoco della distribuzione.

--force

    Forzare l'override della convalida del ramo Git.

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

--mode AppDeploymentMode

    Modalità di gestione del codice sorgente da parte della distribuzione. Valori supportati: AUTO_SYNC, SNAPSHOT.

--no-wait

    Non attendere il raggiungimento dello stato SUCCEEDED.

--skip-tests

    Ignorare l'esecuzione dei test durante la convalida (valore predefinito true).

--skip-validation

    Ignorare la convalida del progetto (compilazione, controllo del tipo, lint).

--source-code-path string

    Percorso del file system dell'area di lavoro del codice sorgente usato per creare la distribuzione dell'app.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato SUCCEEDED (impostazione predefinita 20m0s).

Flag globali

Examples

L'esempio seguente crea una distribuzione con modalità di sincronizzazione automatica:

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

L'esempio seguente crea una distribuzione con la modalità snapshot:

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

L'esempio seguente crea una distribuzione con un ID distribuzione personalizzato:

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

Ottieni le app databricks

Ottenere informazioni per l'app con il nome specificato.

databricks apps get NAME [flags]

Arguments

NAME

    Nome dell'app.

Options

Flag globali

Examples

L'esempio seguente ottiene informazioni sull'app:

databricks apps get my-analytics-app

L'esempio seguente ottiene informazioni sull'app in formato JSON:

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

L'esempio seguente ottiene informazioni sull'app usando un profilo specifico:

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

databricks apps ottieni-distribuzione

Ottenere informazioni per la distribuzione dell'app con il nome e l'ID distribuzione specificati.

databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]

Arguments

APP_NAME

    Nome dell'app.

DEPLOYMENT_ID

    ID univoco della distribuzione.

Options

Flag globali

Examples

L'esempio seguente ottiene informazioni sulla distribuzione:

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

L'esempio seguente ottiene informazioni sulla distribuzione in formato JSON:

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

L'esempio seguente ottiene informazioni sulla distribuzione usando un profilo specifico:

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

get-update delle app databricks

Ottenere lo stato di un aggiornamento dell'app.

databricks apps get-update APP_NAME [flags]

Arguments

APP_NAME

    Nome dell'app.

Options

Flag globali

Examples

L'esempio seguente ottiene lo stato di un aggiornamento dell'app:

databricks apps get-update my-analytics-app

L'esempio seguente ottiene lo stato di aggiornamento in formato JSON:

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

L'esempio seguente ottiene lo stato di aggiornamento usando un profilo specifico:

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

Importazione di app databricks

(Sperimentale) Importare un'app Databricks esistente come bundle.

Importare un'app Databricks esistente e convertirla in una configurazione bundle. Questo comando crea una nuova directory bundle con la configurazione dell'app, scarica il codice sorgente dell'app, associa il bundle all'app esistente e lo distribuisce usando la modalità di distribuzione diretta.

databricks apps import [flags]

Arguments

None

Options

--cleanup

    Pulire la cartella dell'app precedente e tutto il relativo contenuto.

--force-import

    Forzare l'importazione di un'app già importata (funziona solo per le app di cui si è proprietari).

--name string

    Nome dell'app da importare. Se non specificato, elenca tutte le app per la selezione interattiva.

--output-dir string

    Directory in cui restituire il bundle. L'impostazione predefinita è il nome dell'app.

-q, --quiet

    Elimina i messaggi informativi (visualizza solo errori e richieste).

Flag globali

Examples

L'esempio seguente importa un'app, creando una directory denominata dopo l'app:

databricks apps import --name my-streamlit-app

L'esempio seguente importa un'app con una directory di output personalizzata:

databricks apps import --name my-app --output-dir ~/my-apps/analytics

L'esempio seguente importa un'app e pulisce la cartella dell'app precedente:

databricks apps import --name my-app --cleanup

Elenco delle app Databricks

Elencare tutte le app nell'area di lavoro.

databricks apps list [flags]

Arguments

None

Options

--page-size int

    Limite superiore per gli elementi restituiti.

--page-token string

    Token di paginazione per passare alla pagina successiva delle app.

--space string

    Filtrare le app in base al nome dello spazio app.

Flag globali

Examples

L'esempio seguente elenca tutte le app:

databricks apps list

L'esempio seguente elenca le app con dimensioni di pagina specifiche:

databricks apps list --page-size 10

L'esempio seguente elenca le app con paginazione:

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

elenco distribuzioni app databricks

Elencare tutte le distribuzioni di app per l'app con il nome specificato.

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    Nome dell'app.

Options

--page-size int

    Limite superiore per gli elementi restituiti.

--page-token string

    Token di paginazione per passare alla pagina successiva delle app.

Flag globali

Examples

L'esempio seguente elenca tutte le distribuzioni per un'app:

databricks apps list-deployments my-analytics-app

L'esempio seguente elenca le distribuzioni con dimensioni di pagina specifiche:

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

Log delle app Databricks

Trasmettere in streaming i log stdout/stderr di un'app Databricks utilizzando il suo flusso di log. Per impostazione predefinita, questo comando recupera i log più recenti fino a --tail-lines ed esce. Il filtro lato server è disponibile tramite --search e il filtro lato client è disponibile tramite --source APP|SYSTEM.

databricks apps logs [NAME] [flags]

Arguments

NAME

    Nome dell'app.

Options

-f, --follow

    Continuare a trasmettere i log fino alla cancellazione o al raggiungimento di un timeout specificato.

--tail-lines int

    Numero di righe di log recenti da visualizzare prima dello streaming. Impostare 0 per visualizzare tutti gli elementi. Impostazione predefinita: 200

--timeout duration

    Tempo massimo per lo streaming quando --follow è impostato. Impostare su 0 per disabilitare il timeout.

--search string

    Inviare un termine di ricerca al servizio di log prima dello streaming.

--source strings

    Limitare i log alle sorgenti APP o SYSTEM.

--output-file string

    Percorso di file facoltativo per scrivere log oltre a stdout.

Flag globali

Examples

L'esempio seguente recupera i log più recenti per un'app:

databricks apps logs my-analytics-app

L'esempio seguente trasmette i log in modo continuo fino a quando non viene interrotto:

databricks apps logs my-analytics-app --follow

Nell'esempio seguente vengono recuperate le ultime 500 righe di log:

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

L'esempio seguente trasmette i log con un timeout di 10 minuti:

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

L'esempio seguente filtra i log in base a un termine di ricerca:

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

L'esempio seguente limita i log solo all'output a livello di app:

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

L'esempio seguente scrive i log sia in stdout che in un file:

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

Applicazioni Databricks in esecuzione locale

Avviare un'app in locale.

databricks apps run-local [flags]

Arguments

None

Options

--app-port int

    Porta su cui eseguire l'app (impostazione predefinita 8000).

--debug

    Abilitare la modalità di debug.

--debug-port string

    Porta su cui eseguire il debugger.

--entry-point string

    Specificare il punto di ingresso personalizzato con la configurazione (.yml file) per l'app. Il valore predefinito è app.yml.

--env strings

    Impostare le variabili di ambiente.

--port int

    Porta su cui eseguire il proxy dell'app (impostazione predefinita 8001).

--prepare-environment

    Prepara l'ambiente per l'esecuzione dell'app. Richiede l'installazione di uv.

Flag globali

Examples

L'esempio seguente esegue un'app in locale con le impostazioni predefinite:

databricks apps run-local

L'esempio seguente esegue un'app in locale su una porta specifica:

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

Avvia le app Databricks

Avviare l'ultima distribuzione attiva dell'app nell'area di lavoro.

databricks apps start [NAME] [flags]

Arguments

NAME

    Nome dell'app.

Options

--no-wait

    Non attendere il raggiungimento dello stato ATTIVO.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato ATTIVO (impostazione predefinita 20m0s).

Flag globali

Examples

L'esempio seguente avvia un'app:

databricks apps start my-analytics-app

L'esempio seguente avvia un'app senza attendere:

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

L'esempio seguente avvia un'app con un timeout personalizzato:

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

Le app databricks si arrestano

Arrestare la distribuzione attiva dell'app nell'area di lavoro.

databricks apps stop [NAME] [flags]

Arguments

NAME

    Nome dell'app.

Options

--no-wait

    Non attendere il raggiungimento dello stato STOPPED.

--timeout duration

    Quantità massima di tempo per raggiungere lo stato STOPPED (valore predefinito 20m0s).

Flag globali

Examples

L'esempio seguente arresta un'app:

databricks apps stop my-analytics-app

L'esempio seguente arresta un'app senza attendere:

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

L'esempio seguente arresta un'app con un timeout personalizzato:

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

Aggiornamento delle app Databricks

Aggiornare l'app con il nome specificato.

databricks apps update NAME [flags]

Arguments

NAME

    Nome dell'app. Il nome deve contenere solo caratteri alfanumerici minuscoli e trattini. Deve essere univoco all'interno dell'area di lavoro.

Options

--budget-policy-id string

    ID della politica di budget per l'app.

--compute-size ComputeSize

    Dimensione di calcolo per l'app. Valori supportati: LARGE, MEDIUM.

--description string

    Descrizione dell'app.

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

--space string

    Nome dello spazio a cui appartiene l'app.

--usage-policy-id string

    ID dei criteri di utilizzo per l'app.

Flag globali

Examples

L'esempio seguente aggiorna la descrizione di un'app:

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

get-permission-levels delle app di databricks

Ottenere i livelli di autorizzazione dell'app.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    App per cui ottenere o gestire le autorizzazioni.

Options

Flag globali

Examples

L'esempio seguente ottiene i livelli di autorizzazione per un'app:

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

Ottenere le autorizzazioni delle app Databricks

Ottenere le autorizzazioni di un'app. Le app possono ereditare le autorizzazioni dal relativo oggetto radice.

databricks apps get-permissions APP_NAME [flags]

Arguments

APP_NAME

    App per cui ottenere o gestire le autorizzazioni.

Options

Flag globali

Examples

L'esempio seguente ottiene le autorizzazioni per un'app:

databricks apps get-permissions my-analytics-app

L'esempio seguente ottiene le autorizzazioni usando un profilo specifico:

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

Autorizzazioni impostate per le app databricks

Impostare le autorizzazioni dell'app.

Imposta le autorizzazioni per un oggetto, sostituendo le autorizzazioni esistenti, se esistenti. Elimina tutte le autorizzazioni dirette se non è specificato alcuno. Gli oggetti possono ereditare le autorizzazioni dal relativo oggetto radice.

databricks apps set-permissions APP_NAME [flags]

Arguments

APP_NAME

    App per cui ottenere o gestire le autorizzazioni.

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

Flag globali

Examples

L'esempio seguente imposta le autorizzazioni usando la configurazione JSON:

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

Aggiornamento delle autorizzazioni delle app databricks

Aggiornare le autorizzazioni per un'app. Le app possono ereditare le autorizzazioni dal relativo oggetto radice.

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    App per cui ottenere o gestire le autorizzazioni.

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

Flag globali

Examples

L'esempio seguente aggiorna le autorizzazioni usando la configurazione JSON:

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

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file corda

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di text formato del log o json. Il valore predefinito è text.

--log-level corda

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di text output del comando o json. Il valore predefinito è text.

-p, --profile corda

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target corda

    Se applicabile, la destinazione del bundle da usare