Relações

As relações conectam dois objetos entre si. No Twenty, as relações são sempre bidirecionais — cada relação tem dois lados, e cada lado é declarado como um campo que faz referência ao outro.

Tipo de relação	Descrição	Tem chave estrangeira?
`MANY_TO_ONE`	Muitos registros deste objeto apontam para um registro do destino	Sim (`joinColumnName`)
`ONE_TO_MANY`	Um registro deste objeto possui muitos registros do destino	Não (o lado inverso)

Como as relações funcionam

Toda relação requer dois campos que façam referência um ao outro:

O lado MANY_TO_ONE — fica no objeto que contém a chave estrangeira.
O lado ONE_TO_MANY — fica no objeto que possui a coleção.

Ambos os campos usam FieldType.RELATION e fazem referência cruzada um ao outro via relationTargetFieldMetadataUniversalIdentifier.

Exemplo: Um cartão postal tem muitos destinatários

Um PostCard pode ser enviado para muitos registros PostCardRecipient. Cada destinatário pertence a exatamente um cartão postal. Etapa 1: Defina o lado ONE_TO_MANY em PostCard (o lado “um”):

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

Etapa 2: Defina o lado MANY_TO_ONE em PostCardRecipient (o lado “muitos” — contém a chave estrangeira):

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

Importações circulares: ambos os campos de relação fazem referência ao universalIdentifier um do outro. Para evitar problemas de importação circular, exporte os IDs dos seus campos como constantes nomeadas de cada arquivo e importe-os no outro. O sistema de build resolve isso em tempo de compilação.

Relações de junção

Um objeto de junção conecta um registro de origem a um ou mais registros de destino. Por exemplo, PostCardRecipient pode conter tanto uma relação postCard quanto uma relação recipient. No campo ONE_TO_MANY do objeto de origem, defina junctionTargetFieldUniversalIdentifier como o campo de relação no objeto de junção que aponta para o destino:

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

RECIPIENT_FIELD_ID deve identificar uma relação MANY_TO_ONE ou morph no objeto de junção. Isso informa ao Twenty qual registro relacionado é o destino quando um recurso como distribuição de atividade da linha do tempo percorre a junção.

Relacionando a objetos padrão

Para criar uma relação com um objeto integrado do Twenty (Person, Company, etc.), use 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',
  },
});

Propriedades de campos de relação

Propriedade	Obrigatório	Descrição
`type`	Sim	Deve ser `FieldType.RELATION`
`relationTargetObjectMetadataUniversalIdentifier`	Sim	O `universalIdentifier` do objeto de destino
`relationTargetFieldMetadataUniversalIdentifier`	Sim	O `universalIdentifier` do campo correspondente no objeto de destino
`universalSettings.relationType`	Sim	`RelationType.MANY_TO_ONE` ou `RelationType.ONE_TO_MANY`
`universalSettings.onDelete`	Apenas para MANY_TO_ONE	O que acontece quando o registro referenciado é excluído: `CASCADE`, `SET_NULL`, `RESTRICT` ou `NO_ACTION`
`universalSettings.joinColumnName`	Apenas para MANY_TO_ONE	Nome da coluna no banco de dados para a chave estrangeira (por exemplo, `postCardId`)
`universalSettings.junctionTargetFieldUniversalIdentifier`	Somente ONE_TO_MANY de junção	Campo de relação no objeto de junção que aponta para o destino da distribuição

Campos de relação inline

Você também pode declarar uma relação diretamente dentro de defineObject. Quando estiver inline, omita objectUniversalIdentifier — ele é herdado do objeto pai:

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

Visão Geral

Aplicativos

API

Auto-Anfitrião

Contribuir

Como as relações funcionam

Exemplo: Um cartão postal tem muitos destinatários

Relações de junção

Relacionando a objetos padrão

Propriedades de campos de relação

Campos de relação inline

​Como as relações funcionam

​Exemplo: Um cartão postal tem muitos destinatários

​Relações de junção

​Relacionando a objetos padrão

​Propriedades de campos de relação

​Campos de relação inline

Como as relações funcionam

Exemplo: Um cartão postal tem muitos destinatários

Relações de junção

Relacionando a objetos padrão

Propriedades de campos de relação

Campos de relação inline