تتيح الدوال المعرّفة من قبل المستخدم (UDF) للمستخدمين توسيع إمكانات ClickHouse بما يتجاوز ما توفره أكثر من ألف دالة جاهزة.
في ClickHouse Cloud، توجد عدة طرق لإنشاء الدوال المعرّفة من قبل المستخدم وإدارتها:
- باستخدام SQL
- باستخدام UI والتعليمات البرمجية الخاصة بك (الإصدار التجريبي العام)
- باستخدام Cloud واجهة برمجة تطبيقات (تجريبي)
- باستخدام Terraform (تجريبي)
الدوال المعرّفة من قبل المستخدم في SQL
يمكن إنشاء UDFs في SQL باستخدام عبارة CREATE FUNCTION انطلاقًا من تعبير lambda.
في هذا المثال، سننشئ دالة معرّفة من قبل المستخدم قابلة للتنفيذ وبسيطة باسم isBusinessHours.
ستتحقق الدالة مما إذا كان طابع زمني معيّن يقع ضمن ساعات العمل المعتادة، وستُرجع true إذا كان كذلك، وإلا false.
- سجّل الدخول إلى Cloud Console وافتح SQL Console
- اكتب استعلام SQL التالي لإنشاء الدالة
isBusinessHours:
CREATE FUNCTION isBusinessHours AS (ts) ->
toDayOfWeek(ts) BETWEEN 1 AND 5
AND toHour(ts) BETWEEN 9 AND 17;- نفّذ ما يلي لاختبار UDF الذي أنشأته للتو:
SELECT isBusinessHours('2026-03-20 10:00:00'::DateTime), isBusinessHours('2026-03-20 23:00:00'::DateTime);من المفترض أن تظهر لك النتيجة التالية:
1 0- يمكنك استخدام الأمر
DROP FUNCTIONلإزالة دالة UDF التي أنشأتها للتو:
DROP FUNCTION isBusinessHoursهذا يعني:
- لا تنتقل الإعدادات على مستوى الجلسة (المعيَّنة عبر عبارة
SET) إلى سياق تنفيذ UDF - لا ترث UDFs إعدادات ملف تعريف المستخدم
- لا تنطبق الإعدادات على مستوى الاستعلام ضمن تنفيذ UDF
الدوال المُعرَّفة من قبل المستخدم المُنشأة عبر UI
يوفّر ClickHouse Cloud واجهة إعداد عبر UI لإنشاء الدوال المُعرَّفة من قبل المستخدم.
في هذا المثال، سننشئ الدالة البسيطة نفسها المُعرَّفة من قبل المستخدم والقابلة للتنفيذ isBusinessHours، والتي تتحقق مما إذا كان timestamp معيّن يقع ضمن ساعات العمل المعتادة.
سبق أن أنشأناها باستخدام SQL، ولكن هذه المرة سننشئها باستخدام بايثون ونُعدّها عبر UI.
أنشئ ملف بايثون
أنشئ ملفًا جديدًا باسم main.py على جهازك المحلي:
cat > main.py << 'EOF'
import sys
from datetime import datetime
for line in sys.stdin:
ts = datetime.fromisoformat(line.strip())
result = 1 if (0 <= ts.weekday() <= 4 and 9 <= ts.hour <= 17) else 0
print(result)
sys.stdout.flush()
EOFإذا كان سكربت بايثون لديك يستورد حزمًا تابعة لجهات خارجية، فأدرجها في ملف requirements.txt وسيتولى ClickHouse Cloud تثبيتها لك. ويمكنك بدلًا من ذلك تضمين التبعيات مباشرةً في ملف ZIP، لكن عندئذٍ يجب تضمين الحزم المخزنة مؤقتًا لكلتا معماريتَي CPU، لذا يُعد requirements.txt الخيار الأبسط. على سبيل المثال:
requests>=2.28.0
numpy>=1.23.0تجميع التبعيات والملفات المحلية
لتضمين حزم التبعيات وأي ملفات محلية إضافية (مثل ملفات wheel أو ملفات الإعداد أو ملفات البيانات)، ضعها في المجلد نفسه إلى جانب main.py وrequirements.txt. عند إنشاء أرشيف ZIP، ضمّن جميع الملفات:
zip is_business_hours.zip main.py requirements.txtيمكنك الإشارة إلى الدليل الأساسي للمسار المحلي المضمَّن في شيفرة بايثون الخاصة بك باستخدام os.path.dirname(os.path.abspath(__file__)). يُرجع هذا التعبير المسار المطلق إلى الدليل الذي يوجد فيه ملف main.py داخل أرشيف ZIP، مما يتيح لك الوصول إلى الملفات المضمَّنة الأخرى:
import os
# Get the base directory of the bundled files
base_dir = os.path.dirname(os.path.abspath(__file__))
config_path = os.path.join(base_dir, 'config.json')يكون ذلك مفيدًا عندما تحتاج إلى:
- الوصول إلى ملفات التهيئة المضمّنة مع UDF الخاصة بك
- تحميل حزم wheel للتبعيات المخصّصة
- الإشارة إلى نصوص برمجية إضافية أو ملفات بيانات
الآن قم بضغط الملف في أرشيف ZIP:
zip is_business_hours.zip main.pyأنشئ UDF عبر واجهة المستخدم
- من الصفحة الرئيسية لـ Cloud Console، انقر على اسم مؤسستك في القائمة السفلية اليسرى.
- اختر الدوال المعرّفة من قبل المستخدم من القائمة.
- في صفحة الدوال المعرّفة من قبل المستخدم، انقر على Set up a UDF. ستُفتح لوحة إعدادات على الجانب الأيمن من الشاشة.
- أدخل اسمًا للدالة. في هذا المثال، استخدم
isBusinessHours. - اختر نوع الدالة: إما Executable pool أو Executable:
- Executable pool: يُحفَظ pool من العمليات المستمرة، وتُؤخَذ منه عملية لتنفيذ reads.
- Executable: يُشغَّل السكربت مع كل query.
- في هذا المثال، استخدم الإعدادات الافتراضية. للاطلاع على القائمة الكاملة لمعلمات الإعداد، راجع الدوال المعرّفة من قبل المستخدم التنفيذية.
- انقر على Browse File لتحميل ملف
.zipالذي أُنشئ في بداية هذا الدليل. - أضف argument جديدًا. في هذا المثال، أضف argument باسم
timestampمن النوعDateTime. - اختر return type. في هذا المثال، اختر
Bool. - انقر على Create UDF. سيعرض مربع حوار حالة build الحالية.
- إذا كانت هناك أي مشكلات، فستتغير الحالة إلى error.
- بخلاف ذلك، ستنتقل الحالة من building إلى provisioning. يجب أن تكون الخدمة في حالة تشغيل لإكمال provisioning. إذا كانت الخدمة في حالة idle، فانقر على Wake Up Service في لوحة UDF details بجوار اسم الخدمة.
- عند اكتمال العملية، ستتغير الحالة إلى deployed.
اختبر UDF الخاص بك
- ارجع إلى الصفحة الرئيسية في SQL Console بالنقر على Settings - return to your service view من الزاوية العلوية اليسرى للصفحة
- انقر على SQL Console في القائمة الجانبية اليسرى
- اكتب الاستعلام التالي:
SELECT isBusinessHours('2026-03-20 10:00:00'::DateTime), isBusinessHours('2026-03-20 23:00:00'::DateTime);من المفترض أن تظهر لك النتيجة:
true falseإنشاء إصدار جديد
لتغيير شيفرة UDF، أنشئ إصدارًا جديدًا. لا تُستخدم لوحة Edit إلا لإدارة الخدمات المُسنَدة إلى UDF؛ ولن يؤدي رفع ملف من خلالها إلى استبدال الشيفرة المنشورة.
- من الصفحة الرئيسية في Cloud Console، انقر على اسم مؤسستك في القائمة السفلية اليسرى.
- اختر الدوال المعرّفة من قبل المستخدم من القائمة.
- انقر على النقاط الثلاث ضمن الإجراءات الخاصة بـ UDF
isBusinessHours، ثم انقر على إنشاء إصدار جديد - ارفع ملف zip يتضمن الشيفرة المعدّلة، أو غيّر الإعدادات ثم انقر على إنشاء إصدار جديد
لقد أضفت بنجاح أول دالة معرّفة من قبل المستخدم عبر UI، وتحققت من أنها تعمل، ورأيت كيفية إنشاء إصدار جديد لها عند الحاجة.
إدارة UDFs باستخدام Cloud واجهة برمجة تطبيقات
يتوفر كل ما هو متاح في واجهة المستخدم برمجيًا أيضًا عبر ClickHouse Cloud واجهة برمجة تطبيقات. تتيح لك نقاط نهاية UDF إعداد برنامج نصي لإدارة دورة الحياة الكاملة لـ UDF، بما في ذلك تحميل أرشيفات المصدر وإنشاء الدالات والإصدارات وإرفاقها بالخدمات وحذفها.
سير العمل المعتاد لإنشاء UDF ونشرها عبر واجهة برمجة تطبيقات هو:
- أنشئ URL للتحميل للحصول على URL تحميل
application/zipموقّع مسبقًا، ثم حمّل أرشيف ZIP إليه. لا يمكن استخدام كل معرّف تحميل إلا لمحاولة إنشاء واحدة، سواء لـ UDF أو لإصدار؛ اطلب URL تحميل جديدًا عند إعادة المحاولة. - أنشئ UDF من الأرشيف المُحمَّل، مع تحديد اسم الدالة وبيئة التشغيل والوسيطات ونوع الإرجاع.
- أرفق UDF بخدمة. إذا لم يُحدَّد الإصدار، يُرفق أحدث إصدار جاهز. يجب أن تكون الخدمة قيد التشغيل؛ ويمكن إيقاظ الخدمات الخاملة أولًا.
المجموعة الكاملة من نقاط النهاية:
| نقطة النهاية | الوصف |
|---|---|
| إنشاء URL لتحميل UDF | ينشئ URL تحميل application/zip موقّعًا مسبقًا على مستوى المؤسسة |
| إنشاء UDF | ينشئ UDF جديدة من أرشيف مُحمَّل |
| إدراج UDFs | يعيد أحدث إصدار من كل UDF في المؤسسة |
| الحصول على UDF | يعيد أحدث إصدار من UDF |
| حذف UDF | يحذف جميع إصدارات UDF ويفصلها عن كل الخدمات |
| إنشاء إصدار UDF | يستخدم أرشيف مصدر، ويعيّن إصدارًا، ويبدأ بناء UDF |
| إدراج إصدارات UDF | يعيد جميع إصدارات UDF |
| حذف إصدار UDF | يحذف إصدار UDF غير المرفق بأي خدمة |
| إرفاق UDF بخدمة | يرفق إصدارًا واحدًا من UDF بخدمة، ويستبدل الإصدار الحالي عند الضرورة |
| إدراج إرفاقات UDF | يعيد إرفاقات الخدمة الحالية لـ UDF |
| الحصول على إرفاق UDF | يعيد الإرفاق الحالي لـ UDF بخدمة واحدة |
| فصل UDF عن خدمة | يفصل UDF عن خدمة |
راجع مرجع UDF واجهة برمجة تطبيقات للاطلاع على مخططات الطلبات والاستجابات.
إدارة UDFs باستخدام Terraform
يتضمن موفّر Terraform الرسمي لـ ClickHouse موردين لإدارة UDFs كبنية تحتية معرّفة بالشيفرة:
- يدير
clickhouse_udfالدالة نفسها. ويأخذ أرشيف ZIP يتضمن شيفرة مصدر الدالة وينشر إصدارًا جديدًا كلما تغيّر hash الأرشيف، مع انتظار اكتمال عملية البناء. - يرفق
clickhouse_udf_attachmentإصدار UDF بخدمة. لا يمكن أن تحتوي الخدمة إلا على إصدار واحد من الدالة في الوقت نفسه. يمكنك تثبيت رقم إصدار محدد، أو الإشارة إلىclickhouse_udf.<name>.versionلترقية الخدمات تلقائيًا إلى أحدث إصدار.
على سبيل المثال، لنشر UDF isBusinessHours من المثال السابق باستخدام Terraform:
resource "clickhouse_udf" "is_business_hours" {
function_name = "isBusinessHours"
runtime = "python3.11"
type = "executable_pool"
return_type = "Bool"
arguments = [
{ name = "timestamp", type = "DateTime" },
]
source_archive_path = "${path.module}/is_business_hours.zip"
source_archive_hash = filebase64sha256("${path.module}/is_business_hours.zip")
}
resource "clickhouse_udf_attachment" "production" {
function_name = clickhouse_udf.is_business_hours.function_name
service_id = var.service_id
version = clickhouse_udf.is_business_hours.version
}لا تنجح عملية الإرفاق إلا للإصدارات الجاهزة، وقد تستغرق عدة دقائق؛ وتُفعَّل الخدمات الخاملة تلقائيًا. يؤدي حذف مورد clickhouse_udf إلى إزالة جميع إصدارات الدالة وفصلها عن جميع الخدمات.