system.documentation

جدول نظامي يجمع الوثائق المضمّنة لمكوّنات النظام الموحّدة (مثل الدوال، ومحركات الجداول، وأنواع البيانات، وغير ذلك) في جدول واحد، مع عرض الوثائق المرجعية بصيغة Markdown.

الوصف

يجمع هذا الجدول الوثائق المضمّنة للمكوّنات الموحّدة في النظام في جدول واحد. ويمثّل كل صف كيانًا واحدًا (مثل دالة، أو محرك جدول، أو نوع بيانات، وما إلى ذلك)، ويحتوي على الوثائق المرجعية لذلك الكيان معروضة بصيغة Markdown — أي المحتوى نفسه المنشور على الموقع الإلكتروني والمُتاح عبر جداول system.* الخاصة بكل نوع.

يُجمَّع description من الأجزاء المنظَّمة للوثائق المضمّنة (description وsyntax والوسيطات والأمثلة وما إلى ذلك)، بحيث يحتوي عمود واحد على الوثائق الكاملة للكيان. وتُعرض الأسماء المستعارة كإحالة مرجعية قصيرة إلى الكيان المرجعي، مثل: 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)

بالنسبة إلى الإعدادات، تكون الوثائق هي وصف الإعداد؛ ولا تُعرض الإعدادات المتقادمة.

الأعمدة

• 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)) — نوع الكيان، مثل Function أو Table Engine.
• description (String) — الوثائق المرجعية للكيان معروضة بتنسيق Markdown، ومجمّعة من الوثائق المضمّنة (وهي نفس المحتوى المنشور على الموقع الإلكتروني)، بما في ذلك syntax والأمثلة والأجزاء المنظَّمة الأخرى، إن وُجدت.

مثال

راجع وثائق كيان معيّن:

Query

SELECT description
FROM system.documentation
WHERE type = 'Table Engine' AND name = 'MergeTree'
FORMAT TSVRaw;

يمكن أن يشير الاسم نفسه إلى عدة أنواع من الكيانات (على سبيل المثال، توجد file كدالة جدول وكمصدر قاموس)، لذا من المفيد البحث عن الاسم عبر جميع الأنواع:

Query

SELECT type, name
FROM system.documentation
WHERE name = 'file'
ORDER BY type;

احسب الكيانات الموثقة لكل نوع:

Query

SELECT type, count()
FROM system.documentation
GROUP BY type
ORDER BY count() DESC;

انظر أيضًا

• 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 — التنسيقات.