Prezentare generală

Ce acoperă nivelul de date

Stratul de date al unei aplicații Twenty reprezintă datele pe care aplicația le adaugă într-un spațiu de lucru — noile tipuri de înregistrări pe care le declară, coloanele pe care le adaugă la obiectele existente și modul în care aceste înregistrări se conectează între ele.

┌──────────────────────────────────────────────────┐
│ 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    │
└──────────────────────────────────────────────────┘

În această secțiune

Obiectele

defineObject - declara noi tipuri de înregistrări cu propriile lor câmpuri.

Extinderea obiectelor

defineField - adaugă câmpuri la obiectele standard sau alte aplicații.

Relaţiile

Conexiuni bidirecţionale MANY_TO_ONE / ONE_TO_MANY între obiecte.

Tipuri de activitate de cronologie

Definiți evenimentele automate de audit și evenimentele aplicației explicite pentru cronologii înregistrate.

Reguli de validare

defineValidationRule — declară condițiile pe care trebuie să le îndeplinească o înregistrare înainte de a putea fi salvată.

Entități dintr-o privire

Entitate	Scop	Definit cu
Obiect	Un nou tip de înregistrare personalizat (de ex. PostCard, Invoice) cu propriile sale câmpuri	`defineObject()`
Câmp	O coloană pe un obiect. Câmpurile independente pot extinde obiecte pe care nu le-ați creat (de ex. adăugați `loyaltyTier` la Company)	`defineField()`
Relație	O legătură bidirecțională între două obiecte — ambele părți declarate ca câmpuri	`defineField()` cu `FieldType.RELATION`
Indice	Un indice de bază de date pentru a accelera o interogare recurentă asupra unuia dintre obiectele tale	`defineIndex()`
Tip de activitate a cronologiei	Un eveniment automat de audit sau un eveniment explicit de domeniu afișat în cronologiile înregistrărilor	`defineTimelineActivityType()`
Cale de înregistrări asociate	Un lanț de până la trei relații prin care accesul la o înregistrare se extinde la înregistrările sale asociate	`defineRelatedRecordPath()`
Regulă de validare	O condiție pe care trebuie să o îndeplinească o înregistrare înainte de a putea fi salvată	`defineValidationRule()`

CLI-ul detectează acestea prin analiza AST la momentul build-ului, astfel încât organizarea fișierelor ține de tine — convenția este src/objects/, src/validation-rules/, src/fields/, src/indexes/, src/timeline-activity-types/ și src/related-record-paths/. UUID-urile stabile universalIdentifier leagă totul în toate implementările.

Indici (opțional)

Aplicațiile pot livra indici împreună cu obiectele lor pentru a menține rapide interogările recurente. Cel mai comun caz este o coloană de status sau o coloană cu cheie străină pe care o citești frecvent.

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,
    },
  ],
});

Indici unici

defineIndex acceptă isUnique: true atât pentru unicitatea pe o singură coloană, cât și pe mai multe coloane. Aceasta este primitiva recomandată — defineField({ isUnique: true }) este învechită (deprecated) și va fi eliminată într-o versiune viitoare.

defineIndex({
  universalIdentifier: '…',
  objectUniversalIdentifier: PERSON_UNIVERSAL_IDENTIFIER,
  isUnique: true,
  fields: [{ universalIdentifier: '…', fieldUniversalIdentifier: EMAIL_FIELD_UNIVERSAL_IDENTIFIER }],
});

Alte constrângeri

Clauzele WHERE parțiale rămân sub controlul administratorului — aplicațiile nu le pot declara.
Fiecare obiect este limitat la 10 indici personalizați (indicii proprii ai framework-ului nu se pun la socoteală).

Ordonează array-ul fields în modul în care Postgres ar trebui să îl folosească — coloana din stânga prima, ca într-o agendă telefonică. Indicii nu sunt gratuiți: fiecare scriere în tabel îi actualizează. Adaugă unul doar atunci când ai o interogare care are nevoie de el.

Căi de înregistrări asociate (opțional)

Căile către înregistrări asociate sunt în previzualizare: se sincronizează cu aplicația dvs., însă permisiunile pentru înregistrări nu le folosesc încă. După ce sunt aplicate, necesită planul Organization sau unul superior, la fel ca securitatea la nivel de rând.

O cale către înregistrări asociate începe pe un obiect și urmează până la trei câmpuri de relație, fiecare pe obiectul la care a ajuns cel precedent. Permisiunile pentru înregistrări folosesc aceste căi pentru a extinde accesul de la o înregistrare la înregistrările sale asociate.

O cale inerentă (isInherent: true) se aplică ori de câte ori înregistrarea de început poate fi citită, indiferent de modul în care a fost acordat acel acces. Folosiți-o pentru înregistrările care aparțin părintelui lor, cum ar fi atașamentele unui card de postare.
O cale obișnuită se aplică numai atunci când accesul la înregistrarea de început provine direct dintr-un rol, astfel încât spațiile de lucru aleg pe care să se bazeze.

src/related-record-paths/post-card-attachments.related-record-path.ts

import { defineRelatedRecordPath } from 'twenty-sdk/define';

import { POST_CARD_UNIVERSAL_IDENTIFIER } from '../objects/post-card.object';
import { ATTACHMENTS_ON_POST_CARD_UNIVERSAL_IDENTIFIER } from '../fields/attachments-on-post-card.field';

export default defineRelatedRecordPath({
  universalIdentifier: 'c1b8f0d2-7e4a-4b6c-9a1d-3f5e2b7c8d90',
  objectUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
  firstFieldMetadataUniversalIdentifier:
    ATTACHMENTS_ON_POST_CARD_UNIVERSAL_IDENTIFIER,
  isInherent: true,
});

Adăugați secondFieldMetadataUniversalIdentifier și thirdFieldMetadataUniversalIdentifier pentru căi mai lungi. Fiecare salt trebuie să fie o relație activă pe obiectul atins până în acel moment, o cale nu poate vizita același obiect de două ori, iar două căi nu pot folosi aceleași salturi.

Căutați Application Config sau Roles & Permissions? Acestea descriu aplicația în sine, mai degrabă decât datele pe care le adaugă — se află la Config. Căutați Connections (Linear, GitHub, Slack OAuth)? Acestea există pentru a fi apelate din funcții de logică și se află la Logic.

Dezvoltatori

Aplicații

API

Autogazda

Contribuie

Biblioteca UI

Ce acoperă nivelul de date

În această secțiune

Entități dintr-o privire

Indici (opțional)

Indici unici

Alte constrângeri

Căi de înregistrări asociate (opțional)

​Ce acoperă nivelul de date

​În această secțiune

​Entități dintr-o privire

​Indici (opțional)

​Indici unici

​Alte constrângeri

​Căi de înregistrări asociate (opțional)

Ce acoperă nivelul de date

În această secțiune

Entități dintr-o privire

Indici (opțional)

Indici unici

Alte constrângeri

Căi de înregistrări asociate (opțional)