واجهات برمجة التطبيقات لنقاط النهاية SQL

هام

للوصول إلى واجهات برمجة التطبيقات Rest Databricks، يجب عليك المصادقة.

لتكوين نقاط نهاية SQL فردية، استخدم واجهة برمجة تطبيقات نقاط النهاية SQL. لتكوين كافة نقاط النهاية SQL، استخدم API نقاط النهاية SQL العمومية.

المتطلبات

  • لإنشاء نقاط نهاية SQL يجب أن يكون لديك إذن إنشاء الكتلة، والذي تم تمكينه في مساحة عمل هندسة علوم البيانات.
  • لإدارة نقطة نهاية SQL يجب أن يكون لديك إذن إدارة في Databricks SQL نقطة النهاية.

واجهة برمجة تطبيقات نقاط النهاية SQL

استخدم واجهة برمجة التطبيقات هذه لإنشاء نقاط نهاية SQL وتحريرها وسردها والحصول عليها.

في هذا القسم:

خلق

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/ POST

إنشاء نقطة نهاية SQL.

اسم الحقل النوع الوصف
name STRING اسم نقطة النهاية SQL. يجب أن تكون فريدة من نوعها. هذه الحقل مطلوب.
cluster_size STRING حجم الكتل المخصصة لنقطة النهاية: "2X-Small""X-Small" ، ، ، ، ، "Small" ، ، ، ، "Medium""Large""X-Large""2X-Large""3X-Large""4X-Large" . للحصول على التعيين من الكتلة إلى حجم المثيل، راجع الحصة النسبية ل Azure vCPU المطلوبة. هذه الحقل مطلوب.
min_num_clusters INT32 الحد الأدنى لعدد المجموعات المتوفرة عند تشغيل نقطة نهاية SQL. الإعداد الافتراضي هو 1.
max_num_clusters INT32 الحد الأقصى لعدد المجموعات المتوفرة عند تشغيل نقطة نهاية SQL. هذه الحقل مطلوب. إذا لم يتم تمكين موازنة تحميل متعددة الكتل، فهذا يقتصر على .
auto_stop_mins INT32 الوقت بالدقائق حتى تنتهي نقطة نهاية SQL خاملة كافة الكتل وتوقف. هذا الحقل اختياري. الافتراضي هو 0، مما يعني تعطيل الإيقاف التلقائي.
tags علامات النهاية أزواج القيمة المفتاحية التي تصف نقطة النهاية. يقوم Azure Databricks بعلامات على كافة موارد نقطة النهاية باستخدام هذه العلامات. هذا الحقل اختياري.
enable_photon BOOLEAN ما إذا كان يتم تنفيذ الاستعلامات على مشغل متجه أصلي يسرع تنفيذ الاستعلام. هذا الحقل اختياري. الافتراضي هو true.
channel القناة سواء لاستخدام الإصدار الحالي SQL نقطة النهاية حساب أو إصدار المعاينة. تتيح لك إصدارات المعاينة تجربة الوظائف قبل أن تصبح معيار Databricks SQL. عادة، يتم ترقية إصدارات المعاينة إلى الإصدار الحالي بعد أسبوعين من إصدار المعاينة الأولية، ولكن قد تستمر بعض المعاينات لفترة أطول. يمكنك التعرف على الميزات في أحدث إصدار معاينة من خلال مراجعة ملاحظات الإصدار. لا ينصح Databricks باستخدام إصدارات المعاينة لأحمال العمل الإنتاج. هذا الحقل اختياري. الافتراضي هو CHANNEL_NAME_CURRENT.

طلب مثال

{
  "name": "My SQL Endpoint",
  "cluster_size": "Medium",
  "min_num_clusters": 1,
  "max_num_clusters": 10,
  "tags": {
    "custom_tags": [
      {
        "key": "mykey",
        "value": "myvalue"
      }
    ]
  },
  "enable_photon": "true",
  "channel": {
    "name": "CHANNEL_NAME_CURRENT"
  }
}

مثال على الاستجابة

{
  "id": "0123456789abcdef"
}

حذف

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/{id} DELETE

حذف نقطة نهاية SQL.

حرر

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/{id}/edit POST

تعديل نقطة نهاية SQL. جميع الحقول اختيارية. الحقول المفقودة الافتراضية للقيم الحالية.

اسم الحقل النوع الوصف
id STRING معرف نقطة النهاية SQL.
name STRING اسم نقطة النهاية SQL.
cluster_size STRING حجم الكتل المخصصة لنقطة النهاية: "2X-Small""X-Small" ، ، ، ، ، "Small" ، ، ، ، "Medium""Large""X-Large""2X-Large""3X-Large""4X-Large" . للحصول على التعيين من الكتلة إلى حجم المثيل، راجع الحصة النسبية ل Azure vCPU المطلوبة.
min_num_clusters INT32 الحد الأدنى لعدد المجموعات المتوفرة عند تشغيل نقطة نهاية SQL.
max_num_clusters INT32 الحد الأقصى لعدد المجموعات المتوفرة عند تشغيل نقطة نهاية SQL. هذه الحقل مطلوب. إذا لم يتم تمكين موازنة تحميل متعددة الكتل، تقتصر على .
auto_stop_mins INT32 الوقت بالدقائق حتى تنتهي نقطة نهاية SQL خاملة كافة الكتل وتوقف.
tags علامات النهاية أزواج القيمة المفتاحية التي تصف نقطة النهاية.
enable_photon BOOLEAN ما إذا كان يتم تنفيذ الاستعلامات على مشغل متجه أصلي يسرع تنفيذ الاستعلام.
channel القناة سواء لاستخدام الإصدار الحالي SQL نقطة النهاية حساب أو إصدار المعاينة. تتيح لك إصدارات المعاينة تجربة الوظائف قبل أن تصبح معيار Databricks SQL. عادة، يتم ترقية إصدارات المعاينة إلى الإصدار الحالي بعد أسبوعين من إصدار المعاينة الأولية، ولكن قد تستمر بعض المعاينات لفترة أطول. يمكنك التعرف على الميزات في أحدث إصدار معاينة من خلال مراجعة ملاحظات الإصدار. لا ينصح Databricks باستخدام إصدارات المعاينة لأحمال العمل الإنتاج. هذا الحقل اختياري. الافتراضي هو CHANNEL_NAME_CURRENT.

طلب مثال

{
  "name": "My Edited SQL endpoint",
  "cluster_size": "Large",
  "auto_stop_mins": 60
}

Get

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/{id} GET

استرداد المعلومات لنقطة نهاية SQL.

اسم الحقل النوع الوصف
id STRING معرف نقطة النهاية SQL.
name STRING اسم نقطة النهاية SQL.
cluster_size STRING حجم الكتل المخصصة لنقطة النهاية: "2X-Small""X-Small" ، ، ، ، ، "Small" ، ، ، ، "Medium""Large""X-Large""2X-Large""3X-Large""4X-Large" . للحصول على التعيين من الكتلة إلى حجم المثيل، راجع الحصة النسبية ل Azure vCPU المطلوبة.
auto_stop_mins INT32 الوقت حتى نهاية SQL خاملة إنهاء كافة الكتل وتوقف.
num_clusters INT32 عدد الكتل المخصصة لنقطة النهاية.
min_num_clusters INT32 الحد الأدنى لعدد المجموعات المتوفرة عند تشغيل نقطة نهاية SQL.
max_num_clusters INT32 الحد الأقصى لعدد المجموعات المتوفرة عند تشغيل نقطة نهاية SQL.
num_active_sessions INT32 عدد جلسات عمل JDBC و ODBC النشطة التي تعمل على نقطة النهاية SQL.
state نقطة النهايةتستية حالة نقطة النهاية SQL.
creator_name STRING عنوان البريد الإلكتروني للمستخدم الذي أنشأ نقطة النهاية.
creator_id STRING معرف Azure Databricks للمستخدم الذي أنشأ نقطة النهاية.
jdbc_url STRING يستخدم URL لإرسال أوامر SQL إلى نقطة النهاية SQL باستخدام JDBC.
odbc_params ODBCبارامس المضيف والمسار والبروتوكول ومعلومات المنفذ المطلوبة لإرسال أوامر SQL إلى نقطة النهاية SQL باستخدام ODBC.
tags علامات النهاية أزواج القيمة المفتاحية التي تصف نقطة النهاية.
health نقطة النهايةهيل الصحية صحة نقطة النهاية.
enable_photon BOOLEAN ما إذا كان يتم تنفيذ الاستعلامات على مشغل متجه أصلي يسرع تنفيذ الاستعلام.
channel القناة ما إذا كانت نقطة النهاية SQL تستخدم إصدار حساب نقطة النهاية SQL الحالي أو إصدار المعاينة. تتيح لك إصدارات المعاينة تجربة الوظائف قبل أن تصبح معيار Databricks SQL. عادة، يتم ترقية إصدارات المعاينة إلى الإصدار الحالي بعد أسبوعين من إصدار المعاينة الأولية، ولكن قد تستمر بعض المعاينات لفترة أطول. يمكنك التعرف على الميزات في أحدث إصدار معاينة من خلال مراجعة ملاحظات الإصدار. لا ينصح Databricks باستخدام إصدارات المعاينة لأحمال العمل الإنتاج. هذا الحقل اختياري. الافتراضي هو CHANNEL_NAME_CURRENT.

مثال على الاستجابة

{
  "id": "7f2629a529869126",
  "name": "MyEndpoint",
  "size": "SMALL",
  "min_num_clusters": 1,
  "max_num_clusters": 1,
  "auto_stop_mins": 0,
  "auto_resume": true,
  "num_clusters": 0,
  "num_active_sessions": 0,
  "state": "STOPPED",
  "creator_name": "user@example.com",
  "jdbc_url": "jdbc:spark://hostname.staging.cloud.databricks.com:443/default;transportMode=http;ssl=1;AuthMech=3;httpPath=/sql/1.0/endpoints/7f2629a529869126;",
  "odbc_params": {
    "hostname": "hostname.cloud.databricks.com",
    "path": "/sql/1.0/endpoints/7f2629a529869126",
    "protocol": "https",
    "port": 443
  },
  "tags": {
    "custom_tags": [
      {
        "key": "mykey",
        "value": "myvalue"
      }
    ]
  },
  "enable_photon": true,
  "cluster_size": "Small",
  "channel": {
    "name": "CHANNEL_NAME_CURRENT"
  }
}

قائمة

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/ GET

سرد كافة نقاط النهاية SQL في مساحة العمل.

مثال على الاستجابة

{
  "endpoints": [
    { "id": "123456790abcdef", "name": "My SQL endpoint", "cluster_size": "Medium", },
    { "id": "098765321fedcba", "name": "Another SQL endpoint", "cluster_size": "Large", }
  ]
}

بدء

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/{id}/start POST

بدء نقطة نهاية SQL.

إيقاف

نقطة النهاية أسلوب HTTP
2.0/sql/endpoints/{id}/stop POST

إيقاف نقطة نهاية SQL.

API نقاط النهاية SQL العمومية

استخدم واجهة برمجة التطبيقات هذه لتكوين نهج الأمان وخصائص الوصول إلى البيانات ومعلمات التكوين لكافة نقاط النهاية SQL.

في هذا القسم:

حصل

نقطة النهاية أسلوب HTTP
/2.0/sql/config/endpoints GET

الحصول على التكوين لكافة نقاط النهاية SQL.

اسم الحقل النوع الوصف
security_policy نقطة النهايةالشرطة الأمنية سياسة التحكم في الوصول إلى مجموعات البيانات.
data_access_config صفيف من نقطة النهايةكونفبير صفيفة من أزواج القيمة المفتاحية التي تحتوي على خصائص لمتجر Metastore خلية خارجية.
sql_configuration_parameters تكراريانبوينتكونفبيرس معلمات تكوين SQL.

مثال على الاستجابة

{
  "security_policy": "DATA_ACCESS_CONTROL",
  "data_access_config": [
    {
      "key": "spark.sql.hive.metastore.jars",
      "value": "/databricks/hive_metastore_jars/*"
    }
  ],
  "sql_configuration_parameters": {
    "configuration_pairs": [
      {
         "key" : "legacy_time_parser_policy",
         "value": "LEGACY"
      }
    ]
  }
}

حرر

تحرير التكوين لكافة نقاط النهاية SQL.

هام

  • كافة الحقول مطلوبة.
  • استدعاء هذا الأسلوب إعادة تشغيل كافة نقاط النهاية SQL قيد التشغيل.
نقطة النهاية أسلوب HTTP
/2.0/sql/config/endpoints PUT
اسم الحقل النوع الوصف
security_policy نقطة النهايةالشرطة الأمنية سياسة التحكم في الوصول إلى مجموعات البيانات.
data_access_config صفيف من نقطة النهايةكونفبير صفيفة من أزواج القيمة المفتاحية التي تحتوي على خصائص لمتجر Metastore خلية خارجية.
sql_configuration_parameters تكراريانبوينتكونفبيرس معلمات تكوين SQL.

طلب مثال

{
  "data_access_config": [
    {
      "key": "spark.sql.hive.metastore.jars",
      "value": "/databricks/hive_metastore_jars/*"
    }
  ],
  "sql_configuration_parameters": {
     "configuration_pairs": [
       {
          "key" : "legacy_time_parser_policy",
          "value": "LEGACY"
       }
     ]
  }
}

هياكل البيانات

في هذا القسم:

نقطة النهايةكونفبير

اسم الحقل النوع الوصف
key STRING اسم مفتاح التكوين.
value STRING قيمة مفتاح التكوين.

نقطة النهايةهيل الصحية

اسم الحقل النوع الوصف
status نقطة النهايةاستحصاة حالة نقطة النهاية.
message STRING رسالة وصفية حول الحالة الصحية. يتضمن معلومات حول الأخطاء التي تساهم في الحالة الصحية الحالية.

نقطة النهايةالشرطة الأمنية

خيار الوصف
DATA_ACCESS_CONTROL استخدم التحكم في الوصول إلى البيانات للتحكم في الوصول إلى مجموعات البيانات.

نقطة النهايةتستية

حالة نقطة نهاية SQL. الانتقالات الحالة المسموح بها هي:

  • STARTING ->STARTING, RUNNING, STOPPING, DELETING
  • RUNNING ->STOPPING, DELETING
  • STOPPING ->STOPPED, STARTING
  • STOPPED ->STARTING, DELETING
  • DELETING ->DELETED
الولاية الوصف
STARTING نقطة النهاية في عملية البدء.
RUNNING يتم إجراء عملية البدء ونقطة النهاية جاهزة للاستخدام.
STOPPING نقطة النهاية قيد التوقف.
STOPPED تم إيقاف نقطة النهاية. ابدأ بالاتصال ببدء أو بإرسال طلب JDBC أو ODBC.
DELETING نقطة النهاية في طور التدمير.
DELETED تم حذف نقطة النهاية ولا يمكن استردادها.

نقطة النهايةاستحصاة

الولاية الوصف
HEALTHY نقطة النهاية تعمل بشكل طبيعي ولا توجد أية مشكلات معروفة.
DEGRADED قد تكون نقطة النهاية وظيفية، ولكن هناك بعض المشكلات المعروفة. قد يتأثر الأداء.
FAILED نقطة النهاية تتأثر بشدة ولن تكون قادرة على تقديم الاستعلامات.

علامات النهاية

اسم الحقل النوع الوصف
custom_tags صفيف من نقطة النهايةتانتاجبير كائن يحتوي على صفيف من أزواج قيمة المفتاح.

نقطة النهايةتانتاجبير

اسم الحقل النوع الوصف
key STRING علامة اسم المفتاح.
value STRING قيمة مفتاح العلامة.

ODBCبارامس

اسم الحقل النوع الوصف
host STRING اسم مضيف ملقم ODBC.
path STRING مسار ملقم ODBC.
protocol STRING بروتوكول ملقم ODBC.
port INT32 منفذ ملقم ODBC

تكراريانبوينتكونفبيرس

اسم الحقل النوع الوصف
configuration_pairs صفيف من نقطة النهايةكونفبير كائن يحتوي على صفيف من أزواج قيمة المفتاح.

القناة

اسم الحقل النوع الوصف
name اسم القناة اسم القناة

اسم القناة

الاسم الوصف
CHANNEL_NAME_PREVIEW SQL نقطة النهاية إلى قناة المعاينة وتستخدم الوظائف القادمة.
CHANNEL_NAME_CURRENT يتم تعيين نقطة النهاية SQL إلى القناة الحالية.