github-actions[bot]
7b17cac772
Created by Github action <!-- This is an auto-generated description by cubic. --> <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22273?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. --> Co-authored-by: github-actions <github-actions@twenty.com>
98 lines
6.5 KiB
Plaintext
98 lines
6.5 KiB
Plaintext
---
|
|
title: نظرة عامة
|
|
description: شكّل البيانات التي يضيفها تطبيقك إلى مساحة العمل — الكائنات والحقول والعلاقات.
|
|
icon: database
|
|
---
|
|
|
|
طبقة **البيانات** في تطبيق Twenty هي البيانات التي *يضيفها* تطبيقك إلى مساحة العمل — أنواع السجلات الجديدة التي يصرّح عنها، والأعمدة التي يضيفها إلى الكائنات الموجودة، وكيف ترتبط هذه السجلات ببعضها البعض.
|
|
|
|
```text
|
|
┌──────────────────────────────────────────────────┐
|
|
│ Object — a record type, e.g. PostCard │
|
|
│ ├─ Field (name, type, label) │
|
|
│ ├─ Field │
|
|
│ └─ Relation (link to another object) │
|
|
└──────────────────────────────────────────────────┘
|
|
│
|
|
├── lives in your app, OR
|
|
│
|
|
▼
|
|
┌──────────────────────────────────────────────────┐
|
|
│ Standard / other apps' objects │
|
|
│ └─ Field added by your app via defineField │
|
|
└──────────────────────────────────────────────────┘
|
|
```
|
|
|
|
## في هذا القسم
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="كائنات" icon="table" href="/l/ar/developers/extend/apps/data/objects">
|
|
`defineObject` — صرّح عن أنواع سجلات جديدة مع حقولها الخاصة.
|
|
</Card>
|
|
<Card title="توسيع الكائنات" icon="wand-magic-sparkles" href="/l/ar/developers/extend/apps/data/extending-objects">
|
|
`defineField` — أضِف حقولًا إلى كائنات قياسية أو كائنات تطبيقات أخرى.
|
|
</Card>
|
|
<Card title="العلاقات" icon="diagram-project" href="/l/ar/developers/extend/apps/data/relations">
|
|
اتصالات ثنائية الاتجاه من نوع `MANY_TO_ONE` / `ONE_TO_MANY` بين الكائنات.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## الكيانات بنظرة سريعة
|
|
|
|
| كيان | الغرض | مُعرَّفة باستخدام |
|
|
| ---------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------- |
|
|
| **الكائن** | نوع سجل مخصص جديد (مثل PostCard أو Invoice) مع حقوله الخاصة | `defineObject()` |
|
|
| **الحقل** | عمود على كائن. يمكن للحقول المستقلة توسيع الكائنات التي لم تنشئها (مثل إضافة `loyaltyTier` إلى Company) | `defineField()` |
|
|
| **علاقة** | ارتباط ثنائي الاتجاه بين كائنين — يُصرّح عن كلا الجانبين كحقول | `defineField()` مع `FieldType.RELATION` |
|
|
| **الفهرس** | فهرس قاعدة بيانات لتسريع استعلام متكرر على أحد الكائنات لديك | `defineIndex()` |
|
|
|
|
يكتشف SDK هذه العناصر عبر تحليل AST أثناء وقت البناء، لذا تنظيم الملفات يعود إليك — القاعدة المتّبعة هي `src/objects/` و `src/fields/` و `src/indexes/`. معرّفات UUID ثابتة من نوع `universalIdentifier` تربط كل شيء معًا عبر عمليات النشر.
|
|
|
|
## الفهارس (اختياري)
|
|
|
|
يمكن للتطبيقات إرفاق الفهارس مع الكائنات الخاصة بها للحفاظ على سرعة الاستعلامات المتكررة. أكثر الحالات شيوعًا هي عمود حالة أو مفتاح أجنبي تقوم بقراءته بشكل متكرر.
|
|
|
|
```ts src/indexes/post-card-status.index.ts
|
|
import { defineIndex } from 'twenty-sdk/define';
|
|
|
|
import {
|
|
POST_CARD_UNIVERSAL_IDENTIFIER,
|
|
STATUS_FIELD_UNIVERSAL_IDENTIFIER,
|
|
} from '../objects/post-card.object';
|
|
|
|
export default defineIndex({
|
|
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff0',
|
|
objectUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
|
|
fields: [
|
|
{
|
|
universalIdentifier: 'b6e9d2a1-5a4c-46ca-9d52-42c8f02d1ff1',
|
|
fieldUniversalIdentifier: STATUS_FIELD_UNIVERSAL_IDENTIFIER,
|
|
},
|
|
],
|
|
});
|
|
```
|
|
|
|
### الفهارس الفريدة
|
|
|
|
تقبل `defineIndex` الخيار `isUnique: true` لكلٍّ من التفرد على عمود واحد أو على عدّة أعمدة. هذه هي البنية الموصى بها — إن `defineField({ isUnique: true })` مهملة وسيتم إزالتها في إصدار قادم.
|
|
|
|
```ts
|
|
defineIndex({
|
|
universalIdentifier: '…',
|
|
objectUniversalIdentifier: PERSON_UNIVERSAL_IDENTIFIER,
|
|
isUnique: true,
|
|
fields: [{ universalIdentifier: '…', fieldUniversalIdentifier: EMAIL_FIELD_UNIVERSAL_IDENTIFIER }],
|
|
});
|
|
```
|
|
|
|
### قيود أخرى
|
|
|
|
* تظل عبارات `WHERE` الجزئية تحت تحكم المشرف — لا يمكن للتطبيقات التصريح بها.
|
|
* يتم تقييد كل كائن بعدد 10 فهارس مخصصة (لا تُحتسب فهارس الإطار نفسه).
|
|
|
|
رتّب مصفوفة `fields` بالطريقة التي ينبغي على Postgres استخدامها — العمود في أقصى اليسار أولًا، مثل دليل الهاتف. الفهارس ليست مجانية: كل عملية كتابة في الجدول تقوم بتحديثها. أضِف واحدًا فقط عندما يكون لديك استعلام يحتاج إليه.
|
|
|
|
<Note>
|
|
هل تبحث عن **Application Config** أو **Roles & Permissions**؟ هذه تصف التطبيق نفسه بدلًا من البيانات التي يضيفها — وتوجد ضمن [Config](/l/ar/developers/extend/apps/config/overview). هل تبحث عن **Connections** (Linear, GitHub, Slack OAuth)؟ هذه وُجِدت ليتم استدعاؤها *من* دوال المنطق وتوجد ضمن [Logic](/l/ar/developers/extend/apps/logic/connections).
|
|
</Note>
|