Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Note
Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.
Med apps kommandogruppen i Databricks CLI kan du hantera appar. Appar körs direkt på en kunds Databricks-instans, integrerar med sina data, använder och utökar Databricks-tjänster och gör det möjligt för användare att interagera via enkel inloggning. Se Databricks-appar.
skapa databricks-appar
Skapa en ny app.
databricks apps create NAME [flags]
Arguments
NAME
Namnet på appen. Namnet får endast innehålla alfanumeriska gemener och bindestreck. Den måste vara unik inom arbetsytan.
Options
--budget-policy-id string
Budgetprincip-ID för appen.
--compute-size ComputeSize
Appens beräkningsstorlek. Värden som stöds: LARGE, MEDIUM.
--description string
Beskrivningen av appen.
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
--no-compute
Om det är sant startas inte appen när den har skapats.
--no-wait
Vänta inte med att nå ACTIVE-tillståndet.
--space string
Namnet på det utrymme som appen tillhör.
--timeout duration
Maximal tid för att nå ACTIVE-tillstånd (standard 20m0s).
--usage-policy-id string
Användningsprincip-ID för appen.
Examples
I följande exempel skapas en grundläggande app:
databricks apps create my-analytics-app --description "Analytics dashboard app"
I följande exempel skapas en app utan att starta den:
databricks apps create my-data-app --description "Data processing app" --no-compute
I följande exempel skapas en app med en anpassad tidsgräns:
databricks apps create my-ml-app --description "Machine learning app" --timeout 30m
databricks-appar create-update
Skapar en appuppdatering och startar uppdateringsprocessen. Uppdateringsprocessen är asynkron och statusen för uppdateringen kan kontrolleras med metoden GetAppUpdate.
databricks apps create-update APP_NAME UPDATE_MASK [flags]
Arguments
APP_NAME
Namnet på appen.
UPDATE_MASK
Fältmasken måste vara en enda sträng med flera fält avgränsade med kommatecken (inga blanksteg). Fältsökvägen är relativ till resursobjektet och använder en punkt (.) för att navigera i underfält (t.ex. author.given_name). Specifikation av element i sekvens- eller kartfält tillåts inte, eftersom endast hela samlingsfältet kan anges. Fältnamn måste exakt matcha resursfältnamnen.
En fältmask av * anger fullständig ersättning. Vi rekommenderar att du alltid uttryckligen listar fälten som uppdateras och undviker att använda * jokertecken, eftersom det kan leda till oavsiktliga resultat om API:et ändras i framtiden.
Options
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
--no-wait
Vänta inte tills du når tillståndet AVSLUTAT.
--timeout duration
Maximal tid för att nå SUCCEEDED-tillstånd (standard 20m0s).
Examples
I följande exempel skapas en appuppdatering med en specifik fältmask:
databricks apps create-update my-analytics-app "description" --json '{"description": "Updated app description"}'
I följande exempel skapas en appuppdatering utan att vänta på att slutföras:
databricks apps create-update my-data-app "budget_policy_id" --json '{"budget_policy_id": "new-policy-123"}' --no-wait
I följande exempel skapas en appuppdatering med en anpassad tidsgräns:
databricks apps create-update my-ml-app "description,budget_policy_id" --json '{"description": "Updated ML app", "budget_policy_id": "ml-policy-456"}' --timeout 30m
ta bort Databricks-appar
Ta bort en app.
När du kör från en Databricks Apps-projektkatalog (som innehåller databricks.yml) utan argument NAME förstör det här kommandot alla resurser som distribueras av projektet. När ett NAME argument anges eller när det inte finns i en projektkatalog, tas den angivna appen bort direkt med hjälp av API:et.
databricks apps delete [NAME] [flags]
Arguments
NAME
Namnet på appen. Krävs när den inte finns i en projektkatalog. När det anges i en projektkatalog använder api-borttagning i stället för projektförstörande.
Options
--auto-approve
Hoppa över interaktiva godkännanden för att ta bort resurser och filer.
--force-lock
Framtvinga förvärv av distributionslås.
Examples
I följande exempel tas en app bort:
databricks apps delete my-analytics-app
I följande exempel förstörs alla projektresurser från en projektkatalog:
databricks apps delete
I följande exempel förstörs projektresurser med automatiskt godkännande:
databricks apps delete --auto-approve
Databricks Apps delete-app-thumbnail
Ta bort en app-miniatyr.
databricks apps delete-app-thumbnail NAME [flags]
Arguments
NAME
Namnet på appen.
Options
Examples
Följande exempel tar bort en app-miniatyr:
databricks apps delete-app-thumbnail my-app
driftsätta Databricks-appar
Skapa en appdistribution.
När du kör från en Databricks Apps-projektkatalog (som innehåller databricks.yml) utan argument APP_NAME kör det här kommandot en förbättrad distributionspipeline som validerar projektet, distribuerar det till arbetsytan och kör appen. När ett APP_NAME argument anges eller inte finns i en projektkatalog skapar du en appdistribution med hjälp av API:et direkt.
databricks apps deploy [APP_NAME] [flags]
Arguments
APP_NAME
Namnet på appen. Krävs när den inte finns i en projektkatalog. När det anges i en projektkatalog använder api-distribution i stället för projektdistribution.
Options
--deployment-id string
Implementeringens unika ID.
--force
Tvinga fram verifiering av Git-grenen.
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
--mode AppDeploymentMode
Hur distributionen kommer att hantera källkoden. Värden som stöds: AUTO_SYNC, SNAPSHOT.
--no-wait
Vänta inte tills du når tillståndet AVSLUTAT.
--skip-tests
Hoppa över att köra tester under valideringen (standard sant).
--skip-validation
Hoppa över projektverifiering (build, typecheck, lint).
--source-code-path string
Sökvägen till arbetsytans filsystem för källkoden som används för att skapa distribueringen av appen.
--timeout duration
Maximal tid för att nå SUCCEEDED-tillstånd (standard 20m0s).
Examples
I följande exempel skapas en distribution med läget för automatisk synkronisering:
databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC
I följande exempel skapas en distribution med ögonblicksbildsläge:
databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT
I följande exempel skapas en distribution med ett anpassat distributions-ID:
databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app
Databricks Apps dev-remote
Kör AppKit-appen lokalt med WebSocket-brygga till fjärrservern. Startar en lokal Vite-utvecklingsserver och etablerar en WebSocket-brygga till den fjärranslutna Databricks-appen för utveckling med hot module-ersättning.
databricks apps dev-remote [flags]
Arguments
None
Options
--auto-approve
Godkänn automatiskt varje viewer-anslutning. Alla med den delbara utvecklar-URL:en kommer att litas på under hela sessionen; Använd endast i betrodda miljöer.
--client-path string
Väg till Vite-klientkatalogen (standard ./client).
--name string
Namnet på appen att ansluta till (promptar om de inte finns).
--port int
Port för att köra Vite-servern (standard 5173).
Examples
Följande exempel startar en utvecklingsserver för en specifik app:
databricks apps dev-remote --name my-app
Följande exempel använder en anpassad klientväg och port:
databricks apps dev-remote --name my-app --client-path ./frontend --port 3000
databricks-appar hämtar
Hämta information för appen med det angivna namnet.
databricks apps get NAME [flags]
Arguments
NAME
Namnet på appen.
Options
Examples
I följande exempel hämtas appinformation:
databricks apps get my-analytics-app
I följande exempel hämtas appinformation i JSON-format:
databricks apps get my-data-app --output json
I följande exempel hämtas appinformation med hjälp av en specifik profil:
databricks apps get my-ml-app --profile production
databricks-appar – get-deployment
Hämta information för appdistributionen med det angivna namnet och distributions-ID:t.
databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]
Arguments
APP_NAME
Namnet på appen.
DEPLOYMENT_ID
Implementeringens unika ID.
Options
Examples
I följande exempel hämtas distributionsinformation:
databricks apps get-deployment my-analytics-app v1.0.0
I följande exempel hämtas distributionsinformation i JSON-format:
databricks apps get-deployment my-data-app v2.1.0 --output json
I följande exempel hämtas distributionsinformation med hjälp av en specifik profil:
databricks apps get-deployment my-ml-app latest --profile production
databricks-appar get-update
Hämta status för en appuppdatering.
databricks apps get-update APP_NAME [flags]
Arguments
APP_NAME
Namnet på appen.
Options
Examples
I följande exempel hämtas status för en appuppdatering:
databricks apps get-update my-analytics-app
I följande exempel hämtas uppdateringsstatus i JSON-format:
databricks apps get-update my-data-app --output json
I följande exempel hämtas uppdateringsstatus med hjälp av en specifik profil:
databricks apps get-update my-ml-app --profile production
importera databricks-appar
(Experimentell) Importera en befintlig Databricks-app som ett paket.
Importera en befintlig Databricks-app och konvertera den till en paketkonfiguration. Det här kommandot skapar en ny paketkatalog med appkonfigurationen, laddar ned appens källkod, binder paketet till den befintliga appen och distribuerar det med direkt distributionsläge.
databricks apps import [flags]
Arguments
None
Options
--cleanup
Rensa den tidigare appmappen och allt dess innehåll.
--force-import
Framtvinga återimport av en app som redan har importerats (fungerar bara för appar som du äger).
--name string
Namnet på den app som ska importeras. Om det inte anges visas alla appar för interaktiv markering.
--output-dir string
Katalog som paketet ska matas ut till. Standardvärdet är appnamnet.
-q, --quiet
Ignorera informationsmeddelanden (visa endast fel och uppmaningar).
Examples
I följande exempel importeras en app och en katalog skapas med namnet efter appen:
databricks apps import --name my-streamlit-app
I följande exempel importeras en app med en anpassad utdatakatalog:
databricks apps import --name my-app --output-dir ~/my-apps/analytics
I följande exempel importeras en app och den gamla appmappen rensas:
databricks apps import --name my-app --cleanup
Databricks Apps Init
Initiera en ny AppKit-applikation från en mall. När den körs utan argument använder den standardmallen AppKit och en interaktiv prompt guidar dig genom installationen. När den körs med --name, körs i icke-interaktivt läge (alla nödvändiga flaggor måste tillhandahållas). Som standard använder kommandot den senaste versionen av AppKit. Använd --version för att specificera en annan version.
databricks apps init [flags]
Arguments
None
Options
--auto-approve
Hoppa över bekräftelsepromptar för valfria resurser. Valfria resurser konfigureras endast när deras värden tillhandahålls via --set.
--branch string
Git-gren eller tagg (för GitHub-mallar, ömsesidigt uteslutande med --version).
--deploy
Distribuera appen efter skapandet.
--description string
Appbeskrivning.
--features strings
Funktioner/plugins att aktivera (komma-separerade, som definierat i mallmanifestet).
--name string
Project namn (promptar om de inte finns).
--output-dir string
Katalog att skriva projektet till.
--run string
Kör appen efter skapandet (ingen, dev, dev-remote).
--set stringArray
Sätt resursvärden (format: plugin.resourceKey.field=value, kan specificera flera).
--skip-install
Hoppa över att installera projektberoenden (t.ex. npm-installation / UV-synkronisering). Det går inte att kombinera med --run.
--template string
Mallsökväg (lokal katalog eller GitHub-URL).
--version string
AppKit-version att använda (standard: automatisk upptäckt, använd latest för huvudgrenen).
Examples
Följande exempel initierar en ny app med interaktiva promptar:
databricks apps init
Följande exempel initierar en ny app med en specifik version:
databricks apps init --version v0.2.0
Följande exempel initierar en ny app icke-interaktivt:
databricks apps init --name my-app
Följande exempel initierar en app med analysfunktion:
databricks apps init --name my-app --features=analytics --set analytics.sql-warehouse.id=abc123
Följande exempel initierar en app, distribuerar och kör dev-remote:
databricks apps init --name my-app --deploy --run=dev-remote
lista över databricks-appar
Visa en lista över alla appar på arbetsytan.
databricks apps list [flags]
Arguments
None
Options
--page-size int
Övre gräns för returnerade objekt.
--page-token string
Sidnumreringstoken för att gå till nästa sida med appar.
--space string
Filtrera appar efter namn på apputrymme.
Examples
I följande exempel visas alla appar:
databricks apps list
I följande exempel visas appar med en specifik sidstorlek:
databricks apps list --page-size 10
I följande exempel visas appar med sidnumrering:
databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
databricks applikationer lista-utplaceringar
Visa en lista över alla appdistributioner för appen med det angivna namnet.
databricks apps list-deployments APP_NAME [flags]
Arguments
APP_NAME
Namnet på appen.
Options
--page-size int
Övre gräns för returnerade objekt.
--page-token string
Sidnumreringstoken för att gå till nästa sida med appar.
Examples
I följande exempel visas alla distributioner för en app:
databricks apps list-deployments my-analytics-app
I följande exempel visas distributioner med en specifik sidstorlek:
databricks apps list-deployments my-data-app --page-size 10
Databricks Apps manifest
Lös en mall (standard AppKit-repo eller --template URL), hitta appkit.plugins.json, och skriv ut dess råa innehåll till stdout. Ingen autentisering i arbetsytan krävs. Använd samma --template, --branch, och --version flaggor som databricks apps init för att rikta in sig på en specifik mall. Utan --template, använder man standardmallen för AppKit.
databricks apps manifest [flags]
Arguments
None
Options
--branch string
Git-gren eller tagg (för GitHub-mallar, ömsesidigt uteslutande med --version).
--template string
Mallsökväg (lokal katalog eller GitHub-URL).
--version string
AppKit-versionen för standardmall (standard: huvud, använd latest för huvudbranch).
Examples
Följande exempel visar standardmallens manifest:
databricks apps manifest
Följande exempel visar manifestet för en specifik version:
databricks apps manifest --version v0.2.0
Följande exempel visar manifestet från ett GitHub-arkiv:
databricks apps manifest --template https://github.com/user/repo --branch main
Databricks-applikationsloggar
Strömma stdout-/stderr-loggar för en Databricks-applikation med hjälp av dess loggström. Som standard hämtar det här kommandot de senaste loggarna upp till --tail-lines och avslutar. Filtrering på serversidan är tillgänglig med hjälp av --search och filtrering på klientsidan är tillgänglig med hjälp av --source APP|SYSTEM.
databricks apps logs [NAME] [flags]
Arguments
NAME
Namnet på appen.
Options
-f, --follow
Fortsätt att strömma loggar tills de blir avbrutna eller en angiven tidsgräns har nåtts.
--tail-lines int
Antal senaste loggrader som ska visas före direktuppspelning. Ange till 0 för att visa allt. Förval: 200
--timeout duration
Maximal tid att strömma när --follow har angetts. Ange till 0 för att inaktivera tidsgränsen.
--search string
Skicka en sökterm till loggtjänsten före direktuppspelning.
--source strings
Begränsa loggar till APP eller SYSTEM källor.
--output-file string
Valfri filsökväg för att, utöver stdout, skriva loggar.
Examples
I följande exempel hämtas de senaste loggarna för en app:
databricks apps logs my-analytics-app
I följande exempel strömmas loggar kontinuerligt tills de avbryts:
databricks apps logs my-analytics-app --follow
I följande exempel hämtas de sista 500 raderna av loggar:
databricks apps logs my-data-app --tail-lines 500
I följande exempel strömmas loggarna med en tidsgräns på 10 minuter:
databricks apps logs my-ml-app --follow --timeout 10m
I följande exempel filtreras loggar efter en söktermen:
databricks apps logs my-analytics-app --search "error"
I följande exempel begränsas loggarna endast till utdata på appnivå:
databricks apps logs my-data-app --source APP
I följande exempel skrivs loggar till både stdout och en fil:
databricks apps logs my-ml-app --output-file /tmp/app-logs.txt
databricks-appar kör lokalt
Starta en app lokalt.
databricks apps run-local [flags]
Arguments
None
Options
--app-port int
Port där appen ska köras (standard 8000).
--debug
Aktivera felsökningsläge.
--debug-port string
Port som felsökningsprogrammet ska köras på.
--entry-point string
Ange den anpassade startpunkten med konfiguration (.yml fil) för appen. Standardinställningen är app.yml.
--env strings
Ange miljövariabler.
--port int
Port där appproxyn ska köras (standard 8001).
--prepare-environment
Förbereder miljön för att köra appen. Kräver att uv installeras.
Examples
I följande exempel körs en app lokalt med standardinställningar:
databricks apps run-local
I följande exempel körs en app lokalt på en specifik port:
databricks apps run-local --app-port 9000 --port 9001
databricks-appar startar
Starta den senaste aktiva distributionen av appen på arbetsytan.
databricks apps start [NAME] [flags]
Arguments
NAME
Namnet på appen.
Options
--no-wait
Vänta inte med att nå ACTIVE-tillståndet.
--timeout duration
Maximal tid för att nå ACTIVE-tillstånd (standard 20m0s).
Examples
I följande exempel startas en app:
databricks apps start my-analytics-app
Följande exempel startar en app utan att vänta:
databricks apps start my-data-app --no-wait
I följande exempel startas en app med en anpassad tidsgräns:
databricks apps start my-ml-app --timeout 30m
Databricks-appar stoppa
Stoppa den aktiva distributionen av appen på arbetsytan.
databricks apps stop [NAME] [flags]
Arguments
NAME
Namnet på appen.
Options
--no-wait
Vänta inte med att nå STOPPED-tillståndet.
--timeout duration
Maximal tid för att nå STOPPED-tillstånd (standard 20 m0s).
Examples
I följande exempel stoppas en app:
databricks apps stop my-analytics-app
I följande exempel stoppas en app utan att vänta:
databricks apps stop my-data-app --no-wait
I följande exempel stoppas en app med en anpassad tidsgräns:
databricks apps stop my-ml-app --timeout 30m
uppdatering av databricks-appar
Uppdatera appen med det angivna namnet.
databricks apps update NAME [flags]
Arguments
NAME
Namnet på appen. Namnet får endast innehålla alfanumeriska gemener och bindestreck. Den måste vara unik inom arbetsytan.
Options
--budget-policy-id string
Budgetprincip-ID för appen.
--compute-size ComputeSize
Appens beräkningsstorlek. Värden som stöds: LARGE, MEDIUM.
--description string
Beskrivningen av appen.
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
--space string
Namnet på det utrymme som appen tillhör.
--usage-policy-id string
Användningsprincip-ID för appen.
Examples
I följande exempel uppdateras en apps beskrivning:
databricks apps update my-analytics-app --description "Updated analytics dashboard"
Databricks Apps Update-App-Thumbnail
Uppdatera en app-miniatyr.
databricks apps update-app-thumbnail NAME [flags]
Arguments
NAME
Namnet på appen.
Options
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
Examples
Följande exempel uppdaterar en app-miniatyr:
databricks apps update-app-thumbnail my-app --json '{"image": "base64_encoded_image_data"}'
Databricks Apps validate
Validera ett Databricks App-projekt genom att köra bygg-, typkontroll- och luddkontroller. Detta kommando upptäcker projekttypen och kör lämplig validering. För Node.js projekt (package.jsonkörs npm-installation, bygg, typkontroll, ludd och tester.
databricks apps validate [flags]
Arguments
None
Options
--path string
Sökväg till projektkatalogen (standard är aktuell katalog).
--skip-tests
Hoppa över att köra tester för snabbare validering.
Examples
Följande exempel validerar den aktuella katalogen:
databricks apps validate
Följande exempel validerar en specifik katalog:
databricks apps validate --path ./my-app
Följande exempel kör validering utan tester:
databricks apps validate --skip-tests
databricks-apparna hämta-behörighetsnivåer
Hämta behörighetsnivåer för appar.
databricks apps get-permission-levels APP_NAME [flags]
Arguments
APP_NAME
Appen som du vill hämta eller hantera behörigheter för.
Options
Examples
I följande exempel hämtas behörighetsnivåer för en app:
databricks apps get-permission-levels my-analytics-app
databricks-appar – hämta behörigheter
Hämta behörigheter för en app. Appar kan ärva behörigheter från sina rotobjekt.
databricks apps get-permissions APP_NAME [flags]
Arguments
APP_NAME
Appen som du vill hämta eller hantera behörigheter för.
Options
Examples
I följande exempel hämtas behörigheter för en app:
databricks apps get-permissions my-analytics-app
I följande exempel hämtas behörigheter med hjälp av en specifik profil:
databricks apps get-permissions my-ml-app --profile production
Ange behörigheter för Databricks-appar
Ange appbehörigheter.
Anger behörigheter för ett objekt och ersätter befintliga behörigheter om de finns. Tar bort alla direktbehörigheter om inga har angetts. Objekt kan ärva behörigheter från sina rotobjekt.
databricks apps set-permissions APP_NAME [flags]
Arguments
APP_NAME
Appen som du vill hämta eller hantera behörigheter för.
Options
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
Examples
I följande exempel anges behörigheter med JSON-konfiguration:
databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'
uppdateringsbehörigheter för databricks-appar
Uppdatera behörigheterna för en app. Appar kan ärva behörigheter från sina rotobjekt.
databricks apps update-permissions APP_NAME [flags]
Arguments
APP_NAME
Appen som du vill hämta eller hantera behörigheter för.
Options
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
Examples
I följande exempel uppdateras behörigheter med JSON-konfiguration:
databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'
Globala flaggor
--debug
Om felsökningsloggning ska aktiveras.
-h eller --help
Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.
--log-file sträng
En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.
--log-format Format
Loggformattypen, text eller json. Standardvärdet är text.
--log-level sträng
En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.
-o, --output typ
Kommandots utdatatyp, text eller json. Standardvärdet är text.
-p, --profile sträng
Namnet på profilen i ~/.databrickscfg-filen som ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.
--progress-format Format
Formatet för att visa förloppsloggar: default, append, inplaceeller json
-t, --target sträng
Om tillämpligt, paketmålet som ska användas