> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

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

# system.documentation

<div id="description">
  ## الوصف
</div>

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

يُجمَّع `description` من الأجزاء المنظَّمة للوثائق المضمّنة (`description` و`syntax` والوسيطات والأمثلة وما إلى ذلك)، بحيث يحتوي عمود واحد على الوثائق الكاملة للكيان. وعندما تتضمّن الوثائق المضمّنة الصفحة المرجعية كاملةً داخل `description` الخاص بها (كما هو الحال بالنسبة إلى المكوّنات التي تُولَّد صفحات موقعها الإلكتروني منها تلقائيًا: محركات الجداول، ومحركات قواعد البيانات، وأنواع البيانات، والتنسيقات، ودوال الجداول)، تُنشر الصفحة كما هي، من دون إلحاق أقسام مُنشأة من حقول البيانات الوصفية المنظَّمة — لأن متن الصفحة يغطي هذه المادة بالفعل. وتُعرض الأسماء المستعارة كإحالة مرجعية قصيرة إلى الكيان المرجعي، مثل: ``Alias of `trunc`.``

يجمع هذا الجدول، إلى حدٍّ ما، المعلومات المتاحة في جداول الوثائق الخاصة بكل نوع ([`system.functions`](/docs/ar/reference/system-tables/functions)، و[`system.table_engines`](/docs/ar/reference/system-tables/table_engines)، و[`system.data_type_families`](/docs/ar/reference/system-tables/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` على مسار الملف المصدري الذي تُعرَّف فيه وثائق الكيان، نسبةً إلى جذر المستودع. وبالنسبة إلى معظم الكيانات، يُلتقط هذا تلقائيًا في الموضع الذي يُنشأ فيه كائن الوثائق (موضع تسجيل المكوّن)؛ أما الأنواع التي يُوثَّق كلٌّ منها في ملف مصدري واحد (مثل الإعدادات وأحداث الملف الشخصي والمقاييس الحالية)، فيكون ذلك الملف.

<div id="columns">
  ## الأعمدة
</div>

* `name` ([String](/docs/ar/reference/data-types/index)) — اسم الكيان، مثل `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)](/docs/ar/reference/data-types/index)) — نوع الكيان، مثل `Function` أو `Table Engine`.
* `description` ([String](/docs/ar/reference/data-types/index)) — الوثائق المرجعية للكيان معروضة بتنسيق Markdown، ومجمّعة من الوثائق المضمّنة (وهي نفس المحتوى المنشور على الموقع الإلكتروني)، بما في ذلك syntax والأمثلة والأجزاء المنظَّمة الأخرى، إن وُجدت.
* `source` ([String](/docs/ar/reference/data-types/index)) — المسار إلى الملف المصدري الذي تُعرَّف فيه وثائق الكيان، نسبةً إلى جذر المستودع. يكون فارغًا إذا كان موقع المصدر غير معروف.

<div id="example">
  ## مثال
</div>

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

```sql title="Query" theme={null}
SELECT description
FROM system.documentation
WHERE type = 'Table Engine' AND name = 'MergeTree'
FORMAT TSVRaw;
```

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

```sql title="Query" theme={null}
SELECT type, name
FROM system.documentation
WHERE name = 'file'
ORDER BY type;
```

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

```sql title="Query" theme={null}
SELECT type, count()
FROM system.documentation
GROUP BY type
ORDER BY count() DESC;
```

<div id="see-also">
  ## انظر أيضًا
</div>

* [`system.functions`](/docs/ar/reference/system-tables/functions) — الدوال العادية والتجميعية.
* [`system.table_functions`](/docs/ar/reference/system-tables/table_functions) — دوال الجداول.
* [`system.table_engines`](/docs/ar/reference/system-tables/table_engines) — محركات الجداول.
* [`system.database_engines`](/docs/ar/reference/system-tables/database_engines) — محركات قواعد البيانات.
* [`system.data_type_families`](/docs/ar/reference/system-tables/data_type_families) — أنواع البيانات.
* [`system.disk_types`](/docs/ar/reference/system-tables/disk_types) — أنواع الأقراص.
* [`system.settings`](/docs/ar/reference/system-tables/settings) — الإعدادات.
* [`system.merge_tree_settings`](/docs/ar/reference/system-tables/merge_tree_settings) — إعدادات MergeTree.
* [`system.server_settings`](/docs/ar/reference/system-tables/server_settings) — إعدادات الخادم.
* [`system.formats`](/docs/ar/reference/system-tables/formats) — التنسيقات.