共用方式為

Databricks CLI 命令

Note

此資訊適用於 Databricks CLI 0.205 版和更新版本。 Databricks CLI 處於 公開預覽狀態。

Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。

本文提供可用 Databricks CLI 命令的相關資訊。 此資訊補充命令列說明。 如需安裝和使用 Databricks CLI 的詳細資訊，請參閱安裝或更新 Databricks CLI 和 什麼是 Databricks CLI？。

Databricks CLI 包含了下表所列的命令群組。 命令群組包含一組相關的命令，也可包含子命令。 要輸出命令群組、個別命令或子命令的使用方式和語法資訊：

  • databricks <command-group> -h
  • databricks <command-group> <command-name> -h
  • databricks <command-group> <command-name> <subcommand-name> -h

許多 CLI 命令會對應至 Azure Databricks REST API 參考中記載的作業。

工作區命令

Group 描述和命令
fs 用於管理檔案與檔案系統的命令：
cat、、 cp、 ls、 mkdir、 rm
git-credentials 註冊 Databricks 個人存取憑證以便代替使用者執行作業的指令：
create、、 delete、 get、 list、 update
repos 允許使用者管理其 Git 存放庫的命令：
create、、 delete、 get、 list、 update
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions
secrets 用於管理祕密、祕密範圍和存取權限的命令：
create-scope、delete-acl、delete-scope、delete-secret、get-acl、get-secretlist-aclslist-scopes、、 list-secretsput-aclput-secret
workspace 列出、匯入、匯出及刪除工作區中筆記本和資料夾的命令：
delete、export、export-dir、get-status、import、import-dir、、、 listmkdirs
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions

計算機指令

Group 描述和命令
cluster-policies 控制使用者根據一組規則設定叢集能力的命令：
create、、 delete、 edit、 get、 list
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions
clusters 允許您建立、啟動、編輯、列出、終止和刪除叢集的命令：
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 可讓工作區系統管理員為其工作區設定全域初始化指令碼的命令：
create、、 delete、 get、 list、 update
instance-pools 使用現成可用的雲端實例來建立、編輯、刪除和列出實例池的命令，以縮短叢集啟動和自動調整的時間：
create、、 delete、 edit、 get、 list
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions
instance-profiles 可讓系統管理員新增、列出和移除使用者可啟動叢集的執行個體設定檔的命令：
add、 、 edit、 listremove
圖書館 安裝、卸載和取得叢集上程式庫狀態的命令：
all-cluster-statuses、 、 cluster-status、 installuninstall
policy-families 查看可用策略家族的命令：
get、list

作業命令

Group 描述和命令
jobs 管理作業的命令：
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

Lakeflow Spark 宣告式流程命令

Group 描述和命令
pipelines 用於建立、編輯、刪除、啟動和檢視管線相關詳細資料的命令：
create、delete、get、get-update、list-pipeline-events、list-pipelines、list-updates、、start-update、、 stopupdate
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions

機器學習命令

Group 描述和命令
experiments 與實驗互動的命令，實驗是 MLflow 中組織的主要單位；所有 MLflow 執行都屬於實驗：
create-experiment、create-run、delete-experiment、delete-run、delete-runs、delete-tag、get-by-name、get-experiment、get-history、get-runGet、list-artifacts、list-experiments、log-batch、log-inputs、log-metric、log-model、log-param、restore-experiment、restore-run、restore-runs、search-experiments、search-runs、set-experiment-tag、set-tag、update-experiment、update-run
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions
功能工程 與 Databricks 功能存放區中功能互動的命令，為 AI 和 ML 模型中使用的功能提供中央登錄。
create-feature、、 delete-feature、 get-feature、 list-features、 update-feature
model-registry 用於工作區模型登錄的命令：
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

即時服務命令

Group 描述和命令
serving-endpoints 用來建立、更新和刪除服務端點之模型的命令：
build-logs、create、delete、export-metrics、get、listlogspatch、、 putqueryupdate-config
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions

身分識別和存取權管理命令

Group 描述和命令
account 用於管理 Databricks 帳戶的命令：
  • 身分識別和存取：access-control、groups、service-principals、users、workspace-assignment
  • Unity 目錄：metastore-assignments、metastores、storage-credentials
  • 設定：ip-access-lists、network-connectivity、settings
  • 布建：credentials、encryption-keys、networks、private-access、storage、vpc-endpoints、workspaces
  • 計費：billable-usage、log-delivery
  • OAuth：custom-app-integration、o-auth-published-apps、published-app-integration、service-principal-secrets
auth 用於認證的命令：
describe、、 env、 login、 profiles、 token
current-user 擷取目前已驗證使用者或服務主體相關資訊的命令：
me
groups 群組命令可簡化身分識別管理，讓您更輕鬆地指派對 Databricks 工作區、資料和其他安全性實體物件的存取權：
create、、deleteget、list、、patch、update
permissions 針對不同物件和端點上的各種使用者，建立讀取、寫入、編輯、更新及管理存取權的命令：
get、set、update
get-permission-levels
service-principals 用於工作、自動化工具和系統（例如腳本、應用程式和 CI/CD 平台）的識別指令：
create、、deleteget、list、、patch、update
users 由 Databricks 辨識並透過電子郵件地址表示的使用者身分識別命令：
create、、deleteget、list、、patch、update
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions
Group 描述和命令
alerts 對警示進行操作的指令：
create、、 delete、 get、 list、 update
alerts-legacy 在舊版警示上執行作業的命令：
create、、 delete、 get、 list、 update
數據源 建立新查詢物件的命令：
list
queries 對查詢定義執行作業的命令：
create、、deleteget、list、、restore、update
queries-legacy 對舊版查詢定義執行作業的命令：
create、、deleteget、list、、restore、update
query-history 透過 SQL 倉儲存取查詢歷程記錄的命令：
list
倉庫 管理 SQL 倉儲的命令是一種計算資源，可讓您在 Databricks SQL 內的資料物件上執行 SQL 命令：
create、delete、edit、get、get-workspace-warehouse-config、list、set-workspace-warehouse-config、 startstop
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions

Unity Catalog 命令

Group 描述和命令
artifact-allowlists 管理工件允許清單的命令。 在 Databricks Runtime 13.3 和更新版本中，您可以將程式庫和 init 腳本新增至 UC 中的允許清單，讓使用者可以在設定為標準存取模式的計算資源上運用這些資源。
get、update
catalogs 管理目錄的命令，這是 Unity 目錄三層命名空間的第一層：
create、、 delete、 get、 list、 update
憑據 用來管理認證的命令，這些認證是用來存取雲端租用戶上服務的驗證和授權機制。 每個認證都受限於 Unity 目錄存取原則，可控制哪些使用者和群組可以存取認證。
create-credential、delete-credential、、generate-temporary-service-credentialget-credential、list-credentials、、、 update-credentialvalidate-credential
connections 建立外部資料來源連線的命令：
create、、 delete、 get、 list、 update
external-locations 管理外部位置的命令，可將雲端儲存體路徑與授權存取雲端儲存體路徑的儲存體認證相結合：
create、、 delete、 get、 list、 update
functions 在 Unity 目錄中管理 使用者定義函式 （UDF） 的 指令：
create、、 delete、 get、 list、 update
grants 授與對 Unity 目錄中資料的存取權的命令：
get、get-effective、update
中繼存放區 管理中繼存放區的命令，中繼存放區是 Unity 目錄中物件的最上層容器：
assign、create、current、delete、get、list、summary、、unassign、、 updateupdate-assignment
model-versions 管理模型版本的命令。 Databricks 提供 Unity 目錄中 MLflow 模型登錄的託管版本。
delete、、 get、 get-by-alias、 list、 update
online-tables 管理即時資料表的命令，能以較低延遲和更高的 QPS 存取 Delta 資料表中的數據：
create、delete、get
quality-monitors 管理監視器的命令，該監視器可計算和監視一段時間內資料表的數據或模型品質指標：
create、delete、、getget-refresh、list-refreshes、、、 run-refreshupdate
registered-models 管理已註冊模型的命令。 Databricks 提供 Unity 目錄中 MLflow 模型登錄的託管版本。
create、delete、、delete-aliasget、list、、、 set-aliasupdate
resource-quotas 管理資源配額的命令，這些配額由 Unity Catalog 在所有安全物件上強制執行，用以限制可建立的資源數量。
get-quota、list-quotas
schemas 管理架構的命令，這是 Unity 目錄三層命名空間的第二層：
create、、 delete、 get、 list、 update
storage-credentials 管理儲存體認證的命令，儲存體認證是存取雲端租用戶上所儲存資料的驗證和授權機制：
create、、deleteget、list、、update、validate
system-schemas 用來管理系統結構描述的命令，這些是系統類別目錄中的結構描述：
disable、enable、list
table-constraints 管理主索引鍵和外部索引鍵限制式的命令，這些限制式會編碼資料表中欄位之間的關聯性：
create、delete
tables 管理資料表的命令，其位於 Unity 目錄三層命名空間的第三層：
delete、、 exists、 get、 list、 list-summaries
temporary-table-credentials 用來管理臨時表認證的命令，這些認證是短期的縮小範圍認證，用來存取數據表數據儲存在 Databricks 中的雲端儲存位置。
generate-temporary-table-credentials
volumes 管理磁碟區的命令，這是 Unity 目錄 (UC) 功能，可用來存取、儲存、控管、組織和處理檔案：
create、、 delete、 list、 read、 update
workspace-bindings 管理安全性工作區繫結的命令。 Databricks 中的可保護項目可以設定為 OPEN 或 ISOLATED。
get、 、 get-bindings、 updateupdate-bindings

Delta Sharing 指令

Group 描述和命令
providers 管理資料提供者的命令，資料提供者代表共用資料的組織：
create、、deleteget、list、、list-shares、update
recipient-activation 用於管理收件者啟用的命令，僅適用於在開放共享模型中具有 TOKEN 驗證類型的收件者物件：
get-activation-url-info、retrieve-token
收件者 使用 :method:recipients/create 來建立管理收件者的命令，以代表您想要允許其存取共用的組織：
create、、deleteget、list、、rotate-token、update
share-permissions
股票 用來管理資源共享的命令，這些資源共享由 :method:shares/create 實例化為容器：
create、、deleteget、list、、list-shares、update
share-permissions、update-permissions

設定命令

Group 描述和命令
ip-access-lists 可讓系統管理員設定 IP 存取清單的命令：
create、、deleteget、list、、replace、update
notification-destinations 管理工作區通知目標的指令：
create、、 delete、 get、 list、 update
settings 允許使用者在工作區層級管理設定的命令：
automatic-cluster-update、、 csp-enablement、 default-namespace、 esm-enablement、 restrict-workspace-admins
token-management 可讓系統管理員取得其他使用者所有權杖和刪除權杖的命令：
create-obo-token、 、 delete、 getlist
get-permission-levels、 、 get-permissions、 set-permissionsupdate-permissions
令牌 用於建立、列出及撤銷憑證的命令，這些憑證可用於驗證及存取 Databricks REST API：
create、delete、list
workspace-conf 更新工作區設定的命令：
get-status、set-status

開發人員工具命令

Group 描述和命令
bundle 管理 Databricks Asset Bundles 組合的命令，可讓您將 Databricks 專案表示為程式碼：
deploy、deployment、destroy、generate、init、open、plan、run、schema、summary、sync、validate
sync 將本機目錄同步至工作區目錄。

向量搜尋命令

Group 描述和命令
vector-search-endpoints 管理向量搜尋端點的命令，向量搜尋端點代表裝載向量搜尋索引的計算資源：
create-endpoint、 、 delete-endpoint、 get-endpointlist-endpoints
vector-search-indexes 管理向量搜尋索引的命令，向量搜尋索引是內嵌向量的有效表示法，可支援即時且有效率的近似近鄰 (ANN) 搜尋查詢：
create-index、delete-data-vector-index、delete-index、get-index、list-indexes、query-index、、、 sync-indexupsert-data-vector-index

儀表板命令

Group 描述和命令
dashboards 修改舊版儀表板的命令：
create、、deleteget、list、、restore、update
genie 修改 Genie 的命令，其為商務使用者提供無程式代碼體驗，由 AI/BI 提供支援：
create-message、、execute-message-attachment-queryget-message、get-message-attachment-query-result、、get-spaced、start-conversation
湖 景 提供 AI/BI 儀表板特定管理作業的命令：
create、create-schedule、create-subscription、delete-schedule、delete-subscription、get、get-published、get-schedule、get-subscription、list、list-schedules、list-subscriptions、migrate、publish、trash、unpublish、update、update-schedule

Marketplace 命令

Group 描述和命令
消費者履行 用於管理履行的命令，這些是允許取用者預覽安裝的實體。
get、list
consumer-installations 用於管理安裝的命令，這些實體可讓取用者與 Databricks Marketplace 列表互動。
create、、 delete、 list、 list-listing-installations、 update
consumer-listings 管理 Databricks Marketplace 取用者列表的命令：
batch-get、 、 get、 listsearch
consumer-personalization-requests 管理個人化要求的命令，可讓客戶與個別化 Marketplace 清單流程互動。
create、get、list
consumer-providers 管理供應商的命令，這些是將商品資訊發佈至 Marketplace 的實體。
batch-get、get、list
provider-exchange-filters 管理 Marketplace 交換篩選器的命令，可策劃哪些群組可以存取交換。
create、 、 delete、 listupdate
provider-exchanges 用於管理 Marketplace 交換的命令，可讓提供者與一組策劃的客戶共用其清單。
add-listing-to-exchange、create、delete、delete-listing-from-exchange、get、list、list-exchanges-for-listing、 list-listings-for-exchangeupdate
provider-files 用於管理 Marketplace 檔案的命令，例如預覽筆記本和提供者圖示。
create、 、 delete、 getlist
provider-listings 管理提供者清單的指令：
create、、 delete、 get、 list、 update
provider-personalization-requests 管理個人化請求的命令，作為即時可用清單的替代選擇。
list、update
provider-provider-analytics-dashboards 管理服務提供者範本化分析的指令：
create、 、 get、 get-latest-versionupdate
provider-providers 用來管理 Marketplace 中資產的提供商的命令。
create、、 delete、 get、 list、 update

應用程式命令

Group 描述和命令
apps 管理 Databricks 應用程式的命令，其會直接在 Databricks 實例上執行、與您的資料整合、使用及擴充 Databricks 服務，以及讓使用者透過單一登錄互動。
create、delete、deploy、get、get-deployment、list、list-deployments、logs、run-local、start、stop、update

無塵室命令

Group 描述和命令
clean-room-assets 管理清理室資產的命令，這些資產是數據與程式代碼物件，例如與清理室共用的數據表、磁碟區和筆記本。
create、、 delete、 get、 list、 update
clean-room-task-runs 管理清理室工作執行的命令，這是在清理室中執行筆記本的命令。
list
clean-rooms 管理無塵室的命令。 清理室使用 Delta 共用和無伺服器計算來提供安全且隱私權保護的環境，讓多方可以共同處理敏感數據，而不需要直接存取彼此的數據。
create、、create-output-catalogdelete、get、、list、update

資料庫命令

Group 描述和命令
資料庫 管理 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

其他命令

Group 描述和命令
api 針對 Databricks REST API 提出要求的命令：
delete、、gethead、patch、、post、put
completion 生成指定 Shell 的自動完成腳本的命令為：
bash、 、 fish、 powershellzsh
configure 設定 Databricks CLI。
help 所有 Databricks CLI 命令的輸出摘要資訊。
labs 管理 Databricks Labs 安裝的命令：
clear-cache、install、、installedlist、show、、、 uninstallupgrade
version 擷取目前正在使用的 CLI 版本。

全域旗標

下列旗標可供全部 Databricks CLI 命令使用。 請注意，某些旗標不適用於某些命令。 如需特定命令及其旗標的詳細資訊，請參閱命令列說明。

--debug

  是否要啟用偵錯記錄。

-h 或 --help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--log-file 字串

    字串，表示要寫入輸出記錄檔的檔案。 若未指定此旗標，則預設值是將輸出記錄寫入 stderr。

--log-format 格式

    記錄格式類型，text 或 json。 預設值是 text。

--log-level 字串

    表示日誌格式層級的字串。 若未指定，則日誌的格式層級功能將被停用。

-o, --output 類型

    指令輸出類型，text 或 json。 預設值是 text。

-p, --profile 字串

    用於執行命令的~/.databrickscfg檔案中的配置檔名稱。 如果未指定此旗標，則如果存在，則會使用名為 DEFAULT 的配置檔。

--progress-format 格式

    顯示進度記錄的格式：default、、appendinplace、 或json

-t, --target 字串

    如果適用，要使用的套件組合目標

  • Last updated on