الوصف
system.* الخاصة بكل نوع.
يُجمَّع description من الأجزاء المنظَّمة للوثائق المضمّنة (description وsyntax والوسيطات والأمثلة وما إلى ذلك)، بحيث يحتوي عمود واحد على الوثائق الكاملة للكيان. وعندما تتضمّن الوثائق المضمّنة الصفحة المرجعية كاملةً داخل description الخاص بها (كما هو الحال بالنسبة إلى المكوّنات التي تُولَّد صفحات موقعها الإلكتروني منها تلقائيًا: محركات الجداول، ومحركات قواعد البيانات، وأنواع البيانات، والتنسيقات، ودوال الجداول)، تُنشر الصفحة كما هي، من دون إلحاق أقسام مُنشأة من حقول البيانات الوصفية المنظَّمة — لأن متن الصفحة يغطي هذه المادة بالفعل. وتُعرض الأسماء المستعارة كإحالة مرجعية قصيرة إلى الكيان المرجعي، مثل: Alias of `trunc`.
يجمع هذا الجدول، إلى حدٍّ ما، المعلومات المتاحة في جداول الوثائق الخاصة بكل نوع (system.functions، وsystem.table_engines، وsystem.data_type_families، وغيرها). وهو مخصّص، على وجه الخصوص، لدعم أمر help تفاعلي في العميل، لكنه مفيد أيضًا بحد ذاته.
تُجمع الأنواع التالية من الكيانات (وتظهر قيمة العمود type بين قوسين):
- الدوال (
Function) - الدوال التجميعية (
Aggregate Function) - دوال الجداول (
Table Function) - محركات الجداول (
Table Engine) - محركات قواعد البيانات (
Database Engine) - أنواع البيانات (
Data Type) - تخطيطات القواميس (
Dictionary Layout) - مصادر القواميس (
Dictionary Source) - مُركِّبات الدوال التجميعية (
Aggregate Function Combinator) - أنواع فهارس تخطي البيانات (
Data Skipping Index) - أنواع الأقراص (
Disk Type) - الإعدادات (
Setting) - إعدادات MergeTree (
MergeTree Setting) - إعدادات الخادم (
Server Setting) - التنسيقات (
Format) - ترميزات الضغط (
Compression Codec) - أحداث الملف الشخصي (
Profile Event) - المقاييس الحالية (
Current Metric) - المقاييس غير المتزامنة (
Asynchronous Metric) - جداول النظام (
System Table)
source على مسار الملف المصدري الذي تُعرَّف فيه وثائق الكيان، نسبةً إلى جذر المستودع. وبالنسبة إلى معظم الكيانات، يُلتقط هذا تلقائيًا في الموضع الذي يُنشأ فيه كائن الوثائق (موضع تسجيل المكوّن)؛ أما الأنواع التي يُوثَّق كلٌّ منها في ملف مصدري واحد (مثل الإعدادات وأحداث الملف الشخصي والمقاييس الحالية)، فيكون ذلك الملف.
الأعمدة
name(String) — اسم الكيان، مثلdomainWithoutWWWأوMergeTree.type(Enum8(‘Function’ = 1, ‘Aggregate Function’ = 2, ‘Table Function’ = 3, ‘Table Engine’ = 4, ‘Database Engine’ = 5, ‘Data Type’ = 6, ‘Dictionary Layout’ = 7, ‘Dictionary Source’ = 8, ‘Aggregate Function Combinator’ = 9, ‘Data Skipping Index’ = 10, ‘Disk Type’ = 11, ‘Setting’ = 12, ‘MergeTree Setting’ = 13, ‘Server Setting’ = 14, ‘Format’ = 15, ‘Compression Codec’ = 16, ‘Profile Event’ = 17, ‘Current Metric’ = 18, ‘Asynchronous Metric’ = 19, ‘System Table’ = 20)) — نوع الكيان، مثلFunctionأوTable Engine.description(String) — الوثائق المرجعية للكيان معروضة بتنسيق Markdown، ومجمّعة من الوثائق المضمّنة (وهي نفس المحتوى المنشور على الموقع الإلكتروني)، بما في ذلك syntax والأمثلة والأجزاء المنظَّمة الأخرى، إن وُجدت.source(String) — المسار إلى الملف المصدري الذي تُعرَّف فيه وثائق الكيان، نسبةً إلى جذر المستودع. يكون فارغًا إذا كان موقع المصدر غير معروف.
مثال
Query
file كدالة جدول وكمصدر قاموس)، لذا من المفيد البحث عن الاسم عبر جميع الأنواع:
Query
Query
انظر أيضًا
system.functions— الدوال العادية والتجميعية.system.table_functions— دوال الجداول.system.table_engines— محركات الجداول.system.database_engines— محركات قواعد البيانات.system.data_type_families— أنواع البيانات.system.disk_types— أنواع الأقراص.system.settings— الإعدادات.system.merge_tree_settings— إعدادات MergeTree.system.server_settings— إعدادات الخادم.system.formats— التنسيقات.