Vztahy

Relace propojují dva objekty. Ve Twenty jsou relace vždy obousměrné — každá relace má dvě strany a každá strana je deklarována jako pole, které odkazuje na tu druhou.

Typ vztahu	Popis	Má cizí klíč?
`MANY_TO_ONE`	Mnoho záznamů tohoto objektu ukazuje na jeden záznam cílového objektu	Ano (`joinColumnName`)
`ONE_TO_MANY`	Jeden záznam tohoto objektu má mnoho záznamů cílového objektu	Ne (inverzní strana)

Jak fungují relace

Každá relace vyžaduje dvě pole, která na sebe vzájemně odkazují:

Strana MANY_TO_ONE — je na objektu, který drží cizí klíč.
Strana ONE_TO_MANY — je na objektu, který vlastní kolekci.

Obě pole používají FieldType.RELATION a vzájemně se odkazují prostřednictvím relationTargetFieldMetadataUniversalIdentifier.

Příklad: Pohlednice má mnoho příjemců

PostCard lze odeslat mnoha záznamům PostCardRecipient. Každý příjemce náleží přesně jedné pohlednici. Krok 1: Definujte stranu ONE_TO_MANY na PostCard (strana “one”):

src/fields/post-card-recipients-on-post-card.field.ts

import { defineField, FieldType, RelationType } from 'twenty-sdk/define';
import { POST_CARD_UNIVERSAL_IDENTIFIER } from '../objects/post-card.object';
import { POST_CARD_RECIPIENT_UNIVERSAL_IDENTIFIER } from '../objects/post-card-recipient.object';

// Export so the other side can reference it
export const POST_CARD_RECIPIENTS_FIELD_ID = 'a1111111-1111-1111-1111-111111111111';
// Import from the other side
import { POST_CARD_FIELD_ID } from './post-card-on-post-card-recipient.field';

export default defineField({
  universalIdentifier: POST_CARD_RECIPIENTS_FIELD_ID,
  objectUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
  type: FieldType.RELATION,
  name: 'postCardRecipients',
  label: 'Post Card Recipients',
  icon: 'IconUsers',
  relationTargetObjectMetadataUniversalIdentifier: POST_CARD_RECIPIENT_UNIVERSAL_IDENTIFIER,
  relationTargetFieldMetadataUniversalIdentifier: POST_CARD_FIELD_ID,
  universalSettings: {
    relationType: RelationType.ONE_TO_MANY,
  },
});

Krok 2: Definujte stranu MANY_TO_ONE na PostCardRecipient (strana “many” — drží cizí klíč):

src/fields/post-card-on-post-card-recipient.field.ts

import { defineField, FieldType, RelationType, OnDeleteAction } from 'twenty-sdk/define';
import { POST_CARD_UNIVERSAL_IDENTIFIER } from '../objects/post-card.object';
import { POST_CARD_RECIPIENT_UNIVERSAL_IDENTIFIER } from '../objects/post-card-recipient.object';

// Export so the other side can reference it
export const POST_CARD_FIELD_ID = 'b2222222-2222-2222-2222-222222222222';
// Import from the other side
import { POST_CARD_RECIPIENTS_FIELD_ID } from './post-card-recipients-on-post-card.field';

export default defineField({
  universalIdentifier: POST_CARD_FIELD_ID,
  objectUniversalIdentifier: POST_CARD_RECIPIENT_UNIVERSAL_IDENTIFIER,
  type: FieldType.RELATION,
  name: 'postCard',
  label: 'Post Card',
  icon: 'IconMail',
  relationTargetObjectMetadataUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
  relationTargetFieldMetadataUniversalIdentifier: POST_CARD_RECIPIENTS_FIELD_ID,
  universalSettings: {
    relationType: RelationType.MANY_TO_ONE,
    onDelete: OnDeleteAction.CASCADE,
    joinColumnName: 'postCardId',
  },
});

Cyklické importy: obě relační pole odkazují na universalIdentifier toho druhého. Abyste předešli problémům s cyklickými importy, exportujte ID polí jako pojmenované konstanty z každého souboru a v druhém je importujte. Build systém je vyřeší v době kompilace.

Vazby na standardní objekty

Chcete-li vytvořit relaci s vestavěným objektem Twenty (Person, Company atd.), použijte STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS:

src/fields/person-on-self-hosting-user.field.ts

import {
  defineField,
  FieldType,
  RelationType,
  OnDeleteAction,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
} from 'twenty-sdk/define';
import { SELF_HOSTING_USER_UNIVERSAL_IDENTIFIER } from '../objects/self-hosting-user.object';

export const PERSON_FIELD_ID = 'c3333333-3333-3333-3333-333333333333';
export const SELF_HOSTING_USER_REVERSE_FIELD_ID = 'd4444444-4444-4444-4444-444444444444';

export default defineField({
  universalIdentifier: PERSON_FIELD_ID,
  objectUniversalIdentifier: SELF_HOSTING_USER_UNIVERSAL_IDENTIFIER,
  type: FieldType.RELATION,
  name: 'person',
  label: 'Person',
  description: 'Person matching with the self hosting user',
  isNullable: true,
  relationTargetObjectMetadataUniversalIdentifier:
    STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.person.universalIdentifier,
  relationTargetFieldMetadataUniversalIdentifier: SELF_HOSTING_USER_REVERSE_FIELD_ID,
  universalSettings: {
    relationType: RelationType.MANY_TO_ONE,
    onDelete: OnDeleteAction.SET_NULL,
    joinColumnName: 'personId',
  },
});

Vlastnosti relačních polí

Vlastnost	Povinné	Popis
`type`	Ano	Musí být `FieldType.RELATION`
`relationTargetObjectMetadataUniversalIdentifier`	Ano	`universalIdentifier` cílového objektu
`relationTargetFieldMetadataUniversalIdentifier`	Ano	`universalIdentifier` odpovídajícího pole na cílovém objektu
`universalSettings.relationType`	Ano	`RelationType.MANY_TO_ONE` nebo `RelationType.ONE_TO_MANY`
`universalSettings.onDelete`	Pouze MANY_TO_ONE	Co se stane, když je smazán odkazovaný záznam: `CASCADE`, `SET_NULL`, `RESTRICT` nebo `NO_ACTION`
`universalSettings.joinColumnName`	Pouze MANY_TO_ONE	Název databázového sloupce pro cizí klíč (např. `postCardId`)

Vložená relační pole

Relaci můžete také deklarovat přímo uvnitř defineObject. Pokud je pole vložené, vynechejte objectUniversalIdentifier — dědí se z nadřazeného objektu:

export default defineObject({
  universalIdentifier: '...',
  nameSingular: 'postCardRecipient',
  // ...
  fields: [
    {
      universalIdentifier: POST_CARD_FIELD_ID,
      type: FieldType.RELATION,
      name: 'postCard',
      label: 'Post Card',
      relationTargetObjectMetadataUniversalIdentifier: POST_CARD_UNIVERSAL_IDENTIFIER,
      relationTargetFieldMetadataUniversalIdentifier: POST_CARD_RECIPIENTS_FIELD_ID,
      universalSettings: {
        relationType: RelationType.MANY_TO_ONE,
        onDelete: OnDeleteAction.CASCADE,
        joinColumnName: 'postCardId',
      },
    },
    // … other fields
  ],
});

Přehled

Aplikace

API

Vlastní hosting

Přispět

Jak fungují relace

Příklad: Pohlednice má mnoho příjemců

Vazby na standardní objekty

Vlastnosti relačních polí

Vložená relační pole

​Jak fungují relace

​Příklad: Pohlednice má mnoho příjemců

​Vazby na standardní objekty

​Vlastnosti relačních polí

​Vložená relační pole

Jak fungují relace

Příklad: Pohlednice má mnoho příjemců

Vazby na standardní objekty

Vlastnosti relačních polí

Vložená relační pole