أوامر Databricks CLI

إشعار

تنطبق هذه المعلومات على إصدارات Databricks CLI 0.205 والإصدارات الأحدث، الموجودة في المعاينة العامة. للعثور على إصدار Databricks CLI الخاص بك، قم بتشغيل databricks -v.

توفر هذه المقالة معلومات حول أوامر 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 (المجموعة) الوصف والأوامر
خ أوامر لإدارة الملفات ونظام الملفات:

cat، cp، ls، ، mkdirrm
git-credentials أوامر لتسجيل الرموز المميزة للوصول الشخصي ل Databricks للقيام بعمليات نيابة عن المستخدم:

create، delete، get، ، listupdate
repos أوامر للسماح للمستخدمين بإدارة مستودعات git الخاصة بهم:

create، delete، get، ، listupdate

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
secrets أوامر لإدارة الأسرار والنطاقات السرية وأذونات الوصول:

create-scope، delete-acl، delete-scope، delete-secret، get-acl، get-secret، list-acls، list-scopes، list-secrets، ، ، ، put-aclput-secret
workspace أوامر لسرد دفاتر الملاحظات والمجلدات واستيرادها وتصديرها وحذفها في مساحة العمل:

delete، export، export-dir، get-status، import، import-dir، ، list، mkdirs

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions

أوامر الحوسبة

Group (المجموعة) الوصف والأوامر
cluster-policies أوامر للتحكم في قدرة المستخدمين على تكوين أنظمة المجموعات استنادا إلى مجموعة من القواعد:

create، delete، edit، ، getlist

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
clusters الأوامر التي تسمح لك بإنشاء المجموعات وبدء تشغيلها وتحريرها وإدراجها وإنهائها وحذفها:

change-owner، ، createdelete، edit، events، get، list، list-node-types، ، list-zones،pinpermanent-delete ، ، ، resizerestart، ، ، startspark-versionsunpin

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
global-init-scripts الأوامر التي تمكن مسؤولي مساحة العمل من تكوين البرامج النصية للتهيئة العمومية لمساحة العمل الخاصة بهم:

create، delete، get، ، listupdate
instance-pools أوامر لإنشاء تجمعات المثيلات وتحريرها وحذفها وإدراجها باستخدام مثيلات سحابية جاهزة للاستخدام مما يقلل من أوقات بدء نظام المجموعة والتحجيم التلقائي:

create، delete، edit، ، getlist

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
instance-profiles أوامر للسماح للمسؤولين بإضافة ملفات تعريف المثيلات وإدراجها وإزالتها التي يمكن للمستخدمين تشغيلها باستخدام:

add، ، edit، listremove
libraries أوامر تثبيت المكتبات وإلغاء تثبيتها والحصول على حالة المكتبات على نظام مجموعة:

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، submitupdate

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions

أوامر Delta Live Tables

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و و delete-experimentو و delete-runو delete-runsو get-by-namedelete-tagو get-experimentو get-historyو get-runGetو list-artifactsو list-experimentslog-paramlog-metriclog-modellog-batchrestore-experimentsearch-runssearch-experimentsrestore-runsrestore-runset-experiment-taglog-inputsو و update-experimentset-tagcreate-runupdate-run

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
model-registry أوامر لسجل نموذج مساحة العمل:

approve-transition-requestو و create-commentو و create-model-versionو create-webhookcreate-transition-requestو delete-commentو delete-modeldelete-transition-requestlist-webhooksreject-transition-requestlist-transition-requestslist-modelsget-model-version-download-urirename-modelget-model-versionget-modelsearch-model-versionstest-registry-webhookset-model-version-tagtransition-stageset-model-tagupdate-commentupdate-modeldelete-model-tagdelete-model-version-tagupdate-model-versiondelete-model-versiondelete-webhookget-latest-versionssearch-modelscreate-modelupdate-webhook

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions

أوامر التقديم في الوقت الحقيقي

Group (المجموعة) الوصف والأوامر
serving-endpoints أوامر لإنشاء نقاط نهاية خدمة النموذج وتحديثها وحذفها:

build-logs، create، delete، export-metrics، get، list، logs، patch، put، ، ، ، queryupdate-config

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions

أوامر إدارة الهوية والوصول

Group (المجموعة) الوصف والأوامر
account أوامر لإدارة حسابات Databricks:

* الهوية والوصول: access-control، groups، service-principals، ، usersworkspace-assignment
* كتالوج Unity: metastore-assignments، ، metastoresstorage-credentials
* الإعدادات: ip-access-lists، ، network-connectivitysettings
* التوفير: credentials، encryption-keys، networks، private-access، storage، ، ، vpc-endpointsworkspaces
* الفوترة: billable-usage، log-delivery
* OAuth: custom-app-integration، o-auth-published-apps، ، published-app-integrationservice-principal-secrets
المصادقه أوامر المصادقة:

describe، env، login، ، profilestoken
current-user أوامر لاسترداد معلومات حول المستخدم المصادق عليه حاليا أو كيان الخدمة:

me
groups أوامر للمجموعات التي تبسط إدارة الهوية، مما يسهل تعيين الوصول إلى مساحة عمل Databricks والبيانات والكائنات الأخرى القابلة للتأمين:

create، delete، get، list، ، patchupdate
permissions أوامر لإنشاء الوصول للقراءة والكتابة والتحرير والتحديث والإدارة لمختلف المستخدمين على كائنات ونقاط نهاية مختلفة:

get، ، setupdate

get-permission-levels
service-principals أوامر للهويات للاستخدام مع الوظائف والأدوات التلقائية والأنظمة مثل البرامج النصية والتطبيقات وأنظمة CI/CD الأساسية:

create، delete، get، list، ، patchupdate
users أوامر لهويات المستخدم التي تعرف عليها Databricks وتمثيلها بواسطة عناوين البريد الإلكتروني:

create، delete، get، list، ، patchupdate

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
Group (المجموعة) الوصف والأوامر
alerts أوامر لتنفيذ العمليات على التنبيهات:

create، delete، get، ، listupdate
data-sources أوامر لإنشاء كائنات استعلام جديدة:

list
queries أوامر لتنفيذ العمليات على تعريفات الاستعلام:

create، delete، get، list، ، restoreupdate
query-history أوامر للوصول إلى محفوظات الاستعلامات من خلال مستودعات SQL:

list
warehouses أوامر لإدارة مستودعات SQL، وهي مورد حساب يتيح لك تشغيل أوامر SQL على كائنات البيانات داخل Databricks SQL:

create، ، editdelete، get، get-workspace-warehouse-config، list، set-workspace-warehouse-config، ، start،stop

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions

أوامر كتالوج Unity

Group (المجموعة) الوصف والأوامر
artifact-allowlists أوامر لإدارة قوائم السماح للبيانات الاصطناعية. في Databricks Runtime 13.3 وما فوق، يمكنك إضافة المكتبات والبرامج النصية init إلى قائمة السماح في UC بحيث يمكن للمستخدمين الاستفادة من هذه البيانات الاصطناعية على الحساب الذي تم تكوينه باستخدام وضع الوصول المشترك:

get, update
catalogs أوامر لإدارة الكتالوجات، الطبقة الأولى من مساحة الاسم ثلاثية المستوى في كتالوج Unity:

create، delete، get، ، listupdate
connections أوامر لإنشاء اتصال بمصدر بيانات خارجي:

create، delete، get، ، listupdate
external-locations أوامر لإدارة المواقع الخارجية، والتي تجمع بين مسار تخزين سحابي وبيانات اعتماد تخزين تخول الوصول إلى مسار التخزين السحابي:

create، delete، get، ، listupdate
functions أوامر لإدارة الوظائف المعرفة من قبل المستخدم (UDFs) في كتالوج Unity:

create، delete، get، ، listupdate
grants أوامر لمنح الوصول إلى البيانات في كتالوج Unity:

get، ، get-effectiveupdate
metastores أوامر لإدارة metastores، وهي حاوية المستوى الأعلى للكائنات في كتالوج Unity:

assign، create، current، delete، get، list، summary، unassign، ، updateupdate-assignment
model-versions أوامر لإدارة إصدارات النموذج. يوفر Databricks إصدارا مستضافا من سجل نموذج MLflow في كتالوج Unity.

delete، get، get-by-alias، ، listupdate
online-tables أوامر لإدارة الجداول عبر الإنترنت، والتي توفر زمن انتقال أقل ووصولا أعلى ل QPS إلى البيانات من جداول Delta:

create، ، deleteget
quality-monitors أوامر لإدارة أجهزة العرض، التي تحسب البيانات أو مقاييس جودة النموذج وتراقبها لجدول مع مرور الوقت:

create، delete، get، get-refresh، list-refreshes، ، run-refreshupdate
registered-models أوامر لإدارة النماذج المسجلة. يوفر Databricks إصدارا مستضافا من سجل نموذج MLflow في كتالوج Unity.

create، delete، delete-alias، get، list، ، set-aliasupdate
schemas أوامر لإدارة المخططات، وهي الطبقة الثانية من مساحة الاسم ثلاثية المستوى في كتالوج Unity:

create، delete، get، ، listupdate
storage-credentials أوامر لإدارة بيانات اعتماد التخزين، وهي آلية مصادقة وتخويل للوصول إلى البيانات المخزنة على مستأجر السحابة الخاص بك:

create، delete، get، list، ، updatevalidate
system-schemas أوامر لإدارة مخططات النظام، وهي مخططات موجودة داخل كتالوج النظام:

disable، ، enablelist
table-constraints أوامر لإدارة قيود المفتاح الأساسي والمفتاح الخارجي التي تقوم بترميز العلاقات بين الحقول في الجداول:

create, delete
tables أوامر لإدارة الجداول، الموجودة في الطبقة الثالثة من مساحة الاسم ثلاثية المستوى في كتالوج Unity:

delete، exists، get، ، listlist-summaries
volumes أوامر لإدارة وحدات التخزين، وهي إمكانية كتالوج Unity (UC) للوصول إلى الملفات وتخزينها وإدارتها وتنظيمها ومعالجتها:

create، delete، list، ، readupdate
workspace-bindings أوامر لإدارة روابط مساحة العمل القابلة للتأمين. يمكن تكوين المكونات القابلة للتأمين في Databricks ك OPEN أو ISOLATED.

get، ، get-bindings، updateupdate-bindings

أوامر مشاركة دلتا

Group (المجموعة) الوصف والأوامر
providers أوامر لإدارة موفري البيانات، والتي تمثل المؤسسات التي تشارك البيانات:

create، delete، get، list، ، list-sharesupdate
recipient-activation أوامر لإدارة تنشيط المستلم، والتي تنطبق فقط في نموذج المشاركة المفتوح حيث يحتوي كائن المستلم على نوع مصادقة الرمز المميز:

get-activation-url-info, retrieve-token
recipients أوامر لإدارة المستلمين، والتي تقوم بإنشائها باستخدام :method:recipients/create لتمثيل مؤسسة تريد السماح بالوصول إلى المشاركات:

create، delete، get، list، ، rotate-tokenupdate

share-permissions
shares أوامر لإدارة المشاركات، وهي حاويات تم إنشاء مثيل لها باستخدام :method:shares/create:

create، delete، get، ، listupdate

share-permissions, update-permissions

أوامر الإعدادات

Group (المجموعة) الوصف والأوامر
ip-access-lists أوامر لتمكين المسؤولين من تكوين قوائم الوصول إلى IP:

create، delete، get، list، ، replaceupdate
settings أوامر للسماح للمستخدمين بإدارة الإعدادات على مستوى مساحة العمل:

automatic-cluster-update، csp-enablement، default-namespace، ، esm-enablementrestrict-workspace-admins
token-management الأوامر التي تمكن المسؤولين من الحصول على جميع الرموز المميزة وحذف الرموز المميزة للمستخدمين الآخرين:

create-obo-token، ، delete، getlist

get-permission-levels، ، get-permissions، set-permissionsupdate-permissions
tokens أوامر لإنشاء الرموز المميزة التي يمكن استخدامها لمصادقة واجهات برمجة تطبيقات Databricks REST وسردها وإبطالها:

create، ، deletelist
workspace-conf أوامر لتحديث إعدادات مساحة العمل:

get-status, set-status

أوامر أدوات المطور

Group (المجموعة) الوصف والأوامر
حزمه أوامر لإدارة حزم أصول Databricks، والتي تتيح لك التعبير عن مشاريع Databricks كتعلم برمجي:

deploy، ، destroydeployment، generate، init، run، schema، ، sync،validate
مزامنه مزامنة دليل محلي إلى دليل مساحة عمل.

أوامر البحث عن المتجهات

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-index، upsert-data-vector-index

أوامر لوحة المعلومات

Group (المجموعة) الوصف والأوامر
dashboards أوامر لتعديل لوحات المعلومات:

create، delete، get، list، ، restoreupdate
lakeview الأوامر التي توفر عمليات إدارة محددة للوحات معلومات Lakeview:

create، get، get-published، migrate، publish، trash، ، unpublish، update

أوامر إضافية

Group (المجموعة) الوصف والأوامر
واجهة برمجة التطبيقات أوامر لتقديم طلبات إلى Databricks REST API:

delete، get، head، patch، ، postput
إنجاز أوامر لإنشاء برنامج نصي للإكمال التلقائي ل shell المحدد:

bash، ، fish، powershellzsh
تكوين تكوين Databricks CLI.
help معلومات استخدام الإخراج لأي أمر.
مختبرات أوامر لإدارة عمليات تثبيت Databricks Labs:

clear-cache، install، installed، list، show، ، uninstallupgrade
version استرداد إصدار CLI المستخدم حاليا.

علامات عمومية

تتوفر العلامات التالية لجميع أوامر Databricks CLI. لاحظ أن بعض العلامات لا تنطبق على بعض الأوامر. للحصول على معلومات مفصلة حول أوامر معينة وأعلامها، راجع تعليمات سطر الأوامر.

العلامة ‏‏الوصف
-h أو --help عرض التعليمات ل Databricks CLI أو مجموعة الأوامر ذات الصلة أو الأمر ذي الصلة.
-e أو --environment string سلسلة تمثل بيئة المجموعة لاستخدامها إذا كان ذلك ممكنا للأمر ذي الصلة.
--log-file سلسلة تمثل لكتابة سجلات الإخراج إليها. إذا لم يتم تحديد هذه العلامة، فإن الإعداد الافتراضي هو كتابة سجلات الإخراج إلى stderr.
--log-format text لكتابة سجلات الإخراج إلى نص أو json لكتابة سجلات الإخراج إلى JSON. إذا لم يتم تحديد هذه العلامة، فستتم كتابة سجلات الإخراج كنص.
--log-level سلسلة تمثل مستوى تنسيق السجل. إذا لم يتم تحديده، فسيتم تعطيل مستوى تنسيق السجل.
-o أو --output text لكتابة الإخراج كنص أو json لكتابة الإخراج ك JSON. إذا لم يتم تحديد هذه العلامة، تتم كتابة الإخراج كنص.
-p أو --profile سلسلة تمثل ملف تعريف التكوين المسمى لاستخدامه داخل الملف الخاص بك .databrickscfg . إذا لم يتم تحديد هذه العلامة، فسيتم استخدام ملف التعريف المسمى DEFAULT إذا كان موجودا. يمكنك الضغط Tab بعد --profile أو -p لعرض قائمة بملفات تعريف التكوين المتوفرة الحالية للاختيار من بينها بدلا من إدخال اسم ملف تعريف التكوين يدويا.
--progress-format تنسيق سجلات التقدم لعرض ( (defaultالافتراضي) أو أو appendinplace ).json