관계 - Twenty Documentation

관계는 두 객체를 서로 연결합니다. Twenty에서는 관계가 항상 양방향입니다 — 모든 관계에는 두 개의 측면이 있으며, 각 측면은 서로를 참조하는 필드로 선언됩니다.

관계 유형	설명	외래 키가 있나요?
`MANY_TO_ONE`	이 객체의 여러 레코드가 대상의 한 레코드를 가리킵니다	예 (`joinColumnName`)
`ONE_TO_MANY`	이 객체의 하나의 레코드가 대상의 여러 레코드를 가집니다	아니오 (역방향)

관계 작동 방식

모든 관계에는 서로를 참조하는 두 개의 필드가 필요합니다:

MANY_TO_ONE 측 — 외래 키를 보유한 객체에 존재합니다.
ONE_TO_MANY 측 — 컬렉션을 소유한 객체에 존재합니다.

두 필드 모두 FieldType.RELATION을 사용하며 relationTargetFieldMetadataUniversalIdentifier를 통해 서로를 교차 참조합니다.

예시: Post Card에는 여러 수신자가 있습니다

PostCard는 여러 PostCardRecipient 레코드에 전송될 수 있습니다. 각 수신자는 정확히 하나의 Post Card에 속합니다. 1단계: PostCard에서 ONE_TO_MANY 측을 정의합니다 (“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,
  },
});

2단계: PostCardRecipient에서 MANY_TO_ONE 측을 정의합니다 (“many” 측 — 외래 키를 보유함):

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

순환 임포트: 두 관계 필드는 서로의 universalIdentifier를 참조합니다. 순환 임포트 문제를 피하려면, 각 파일에서 필드 ID를 명명된 상수로 export하고 다른 파일에서 import하세요. 빌드 시스템은 컴파일 시점에 이를 해결합니다.

표준 객체와의 관계 설정

내장 Twenty 객체(Person, Company 등)와 관계를 만들려면 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',
  },
});

관계 필드 속성

속성	필수	설명
`type`	예	`FieldType.RELATION`이어야 함
`relationTargetObjectMetadataUniversalIdentifier`	예	대상 객체의 `universalIdentifier`
`relationTargetFieldMetadataUniversalIdentifier`	예	대상 객체의 일치하는 필드의 `universalIdentifier`
`universalSettings.relationType`	예	`RelationType.MANY_TO_ONE` 또는 `RelationType.ONE_TO_MANY`
`universalSettings.onDelete`	MANY_TO_ONE에만 해당	참조된 레코드가 삭제될 때의 동작: `CASCADE`, `SET_NULL`, `RESTRICT`, 또는 `NO_ACTION`
`universalSettings.joinColumnName`	MANY_TO_ONE에만 해당	외래 키에 대한 데이터베이스 컬럼 이름(예: `postCardId`)

인라인 관계 필드

defineObject 안에서 관계를 직접 선언할 수도 있습니다. 인라인인 경우에는 objectUniversalIdentifier를 생략하세요 — 상위 객체에서 상속됩니다:

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

개요

앱

API

셀프 호스팅

기여

관계

관계 작동 방식

예시: Post Card에는 여러 수신자가 있습니다

표준 객체와의 관계 설정

관계 필드 속성

인라인 관계 필드

​관계 작동 방식

​예시: Post Card에는 여러 수신자가 있습니다

​표준 객체와의 관계 설정

​관계 필드 속성

​인라인 관계 필드

관계 작동 방식

예시: Post Card에는 여러 수신자가 있습니다

표준 객체와의 관계 설정

관계 필드 속성

인라인 관계 필드