開始
用戶指南
管理指南
參考指南
資源
2022年12月22日更新
給我們反饋
通過將Databricks作業的CLI子命令追加到磚工作和Databricks作業通過將CLI子命令追加到磚運行.對於Databricks作業運行的CLI子命令,請參見CLI運行.這些子命令一起調用職位API 2.1而且Jobs API 2.0.
磚工作
磚運行
重要的
Databricks作業CLI支持調用兩個版本的Databricks作業REST API:版本2.1和2.0。版本2.1增加了對多任務作業編排的支持;看到創建、運行和管理Databricks作業而且job API更新.Databricks建議您調用2.1版本,除非您有依賴於2.0版本且無法遷移的遺留腳本。
除非另有說明,本文中描述的編程行為同樣適用於版本2.1和2.0。
要設置和使用Databricks作業命令行(以及作業運行命令行)調用作業REST API 2.1,請執行以下操作:
更新命令行到0.16.0或以上版本。
做以下其中一件事:
執行命令磚工作配置——版本= 2.1.這就添加了設置jobs-api-version=2.1到文件~ / .databrickscfg在Unix、Linux或macOS上運行% USERPROFILE % \ .databrickscfg在Windows上。默認情況下,所有作業CLI(以及作業運行CLI)子命令都將調用jobs REST API 2.1。
磚工作配置——版本= 2.1
jobs-api-version=2.1
~ / .databrickscfg
% USERPROFILE % \ .databrickscfg
手動添加設置jobs-api-version=2.1到文件~ / .databrickscfg在Unix、Linux或macOS上運行% USERPROFILE % \ .databrickscfg在Windows上。默認情況下,所有作業CLI(以及作業運行CLI)子命令都將調用jobs REST API 2.1。
附加選項——版本= 2.1(例如,磚工作列表——版本= 2.1),指示jobs CLI僅為該調用調用jobs REST API 2.1。
——版本= 2.1
磚工作列表——版本= 2.1
如果您不采取上述任何操作,作業CLI(以及作業運行CLI)將默認調用作業REST API 2.0。
要設置和使用Databricks作業CLI(以及作業運行CLI)來調用作業REST API 2.0,請執行以下操作之一:
使用低於0.16.0的Databricks CLI版本
更新命令行轉到X.Y.Z或以上版本,然後執行下列其中一項:
執行命令磚工作配置——版本= 2.0.這就添加了設置jobs-api-version=2.0到文件~ / .databrickscfg在Unix、Linux或macOS上運行% USERPROFILE % \ .databrickscfg在Windows上。默認情況下,所有作業CLI(以及作業運行CLI)子命令都將調用作業REST API 2.0。
磚工作配置——版本= 2.0
jobs-api-version=2.0
手動添加設置jobs-api-version=2.0到文件~ / .databrickscfg在Unix、Linux或macOS上運行% USERPROFILE % \ .databrickscfg在Windows上。默認情況下,所有作業CLI(以及作業運行CLI)子命令都將調用作業REST API 2.0。
附加選項——版本= 2.1(例如,磚工作列表——版本= 2.0),指示jobs CLI僅為該調用調用jobs REST API 2.0。
磚工作列表——版本= 2.0
磚工作- h
用法:databricks jobs [OPTIONS] COMMAND [ARGS]…與作業交互的實用程序。作業運行由“databricks runs”處理。選項:-v,——version [version] -h,——help顯示此信息並退出。命令:create創建作業。選項:——JSON - File PATH POST到/api/2.0/jobs/create的JSON請求文件。POST到/api/2.0/jobs/create的json字符串。delete刪除作業。選項:——job-id JOB_ID可在https://< databicks -instance>/?o=<16-digit-number>#job/$JOB_ID中獲取。[必選]get描述作業的元數據。 Options: --job-id JOB_ID Can be found in the URL at https:///?o=<16-digit-number>#job/$JOB_ID. [required] list Lists the jobs in the Databricks Job Service. reset Resets (edits) the definition of a job. Options: --job-id JOB_ID Can be found in the URL at https:///?o=<16-digit-number>#job/$JOB_ID. [required] --json-file PATH File containing JSON request to POST to /api/2.0/jobs/create. --json JSON JSON string to POST to /api/2.0/jobs/create. run-now Runs a job with optional per-run parameters. Options: --job-id JOB_ID Can be found in the URL at https:///#job/$JOB_ID. [required] --jar-params JSON JSON string specifying an array of parameters. i.e. '["param1", "param2"]' --notebook-params JSON JSON string specifying a map of key-value pairs. i.e. '{"name": "john doe", "age": 35}' --python-params JSON JSON string specifying an array of parameters. i.e. '["param1", "param2"]' --spark-submit-params JSON JSON string specifying an array of parameters. i.e. '["--class", "org.apache.spark.examples.SparkPi"]'
要顯示使用文檔,請運行磚工作創建——幫助.
磚工作創建——幫助
磚工作創建——json-file Create -job.json
看到創建在job API更新.
create-job.json:
create-job.json
{“名稱”:“我的工作”,“existing_cluster_id”:“1234 - 567890 reef123”,“notebook_task”:{“notebook_path”:“/用戶/ someone@example.com/My筆記本”},“email_notifications”:{“on_success”:[“someone@example.com”),“on_failure”:[“someone@example.com”]}}
{"job_id": 246}
提示
要複製作業,請運行創建命令,並傳遞一個帶有要複製的作業設置的JSON對象。此示例複製ID為的作業的設置246找一份新工作。它需要金橋實用程序。
創建
246
SETTINGS_JSON=$ (磚工作得到,作業標識246|金橋.settings)磚工作創建——json"SETTINGS_JSON美元"
{"job_id": 247}
要顯示使用文檔,請運行磚工作刪除——幫助.
磚工作刪除——幫助
數據庫作業刪除——job-id246
如果成功,則無輸出。
若要刪除具有相同設置的多個作業,請獲取與該設置匹配的作業id列表,然後運行刪除命令為每個匹配的作業ID。此示例刪除作業名稱為的所有作業無標題的.它需要金橋實用程序。
刪除
無標題的
磚工作List——輸出json|金橋”。job [] | select(.settings.name == "Untitled") | .job_id'|xargs - n1磚工作刪除——作業標識
要顯示使用文檔,請運行磚工作得到——幫助.
磚工作得到——幫助
磚工作得到,作業標識246
看到得到在job API更新.
{“job_id”:246年,"設置":{“名稱”:“我的工作”,“existing_cluster_id”:“1234 - 567890 reef123”," email_notifications ": {“on_success”:(“someone@example.com”),“on_failure”:(“someone@example.com”]},“timeout_seconds”:0," notebook_task ": {"notebook_path": "/Users/someone@example.com/My Notebook"},“max_concurrent_runs”:1},“created_time”:1620163107742,“creator_user_name”:“someone@example.com”}
要顯示使用文檔,請運行磚工作列表——幫助.
磚工作列表——幫助
磚工作列表
看到列表在job API更新.
{“工作”:({“job_id”:246年,"設置":{“名稱”:“我的工作”,“existing_cluster_id”:“1234 - 567890 reef123”," email_notifications ": {“on_success”:(“someone@example.com”),“on_failure”:(“someone@example.com”]},“timeout_seconds”:0," notebook_task ": {"notebook_path": "/Users/someone@example.com/My Notebook"},“max_concurrent_runs”:1},“created_time”:1620163107742,“creator_user_name”:“someone@example.com”},...]}
要顯示使用文檔,請運行磚工作重置——幫助.
磚工作重置——幫助
磚工作重置,作業標識246——json文件reset-job.json
看到更新而且重置在job API更新.
reset-job.json:
reset-job.json
{“job_id”:246,“existing_cluster_id”:“2345 - 678901 batch234”,“名稱”:“my-changed-job”,“notebook_task”:{“notebook_path”:"/Users/someone@example.com/My其他筆記本"},“email_notifications”:{“on_success”:[“someone-else@example.com”),“on_failure”:[“someone-else@example.com”]}}
要顯示使用文檔,請運行磚工作現在——幫助.
磚工作現在——幫助
磚工作現在,作業標識246
{“run_id”:122年,“number_in_job”:1}