RelationshipField

Defined in: packages/core/src/fields/relationship/types.ts:140

Resolved configuration for a relationship() field, after all defaults are applied.

TCollection is the string-literal type of the target collection’s slug, inferred from RelationshipFieldInput.collection.

Type Param

TCollection

The target collection slug (inferred from input).

See

• RelationshipFieldInput for the user-facing input type
• relationship for the config function

Extends

• BaseField<TCollectionSlug, TFieldMeta>

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldMeta

TFieldMeta extends object = { }

TTargetSlug

TTargetSlug extends CollectionSlug = CollectionSlug

TComponent

TComponent extends ComponentHKT = ComponentHKT

Properties

admin

admin: RelationshipFieldAdminConfig<TCollectionSlug, TTargetSlug, TComponent>

Defined in: packages/core/src/fields/relationship/types.ts:158

Resolved admin UI configuration with all defaults applied.

Overrides

BaseField.admin

---

collection

collection: object

Defined in: packages/core/src/fields/relationship/types.ts:148

Target collection reference.

slug

slug: TTargetSlug

The slug of the collection this field links to.

---

defaultValue?

optional defaultValue?: unknown

Defined in: packages/core/src/fields/baseTypes.ts:574

Pre-filled value shown in the admin form when creating a new field. Does not apply to database values

Inherited from

BaseField.defaultValue

---

description?

optional description?: string

Defined in: packages/core/src/fields/baseTypes.ts:585

Semantic description of the field. Used in three places:

1. Helper text rendered below the field input in the admin form UI.
2. As the Zod .meta({ description }) value for form validation.
3. As the JSDoc comment on the generated document interface property.

To write a separate JSDoc comment, use interfaceDescription in addition.

Inherited from

BaseField.description

---

hasMany

hasMany: boolean

Defined in: packages/core/src/fields/relationship/types.ts:153

Whether this field stores multiple document references.

---

index?

optional index?: ResolvedFieldIndexConfigInput

Defined in: packages/core/src/fields/baseTypes.ts:589

Convex index name for this field, or the object form for a compound index.

Inherited from

BaseField.index

---

interfaceDescription?

optional interfaceDescription?: string

Defined in: packages/core/src/fields/baseTypes.ts:587

The JSDoc comment on the generated document interface property

Inherited from

BaseField.interfaceDescription

---

interfaceType

interfaceType: string

Defined in: packages/core/src/fields/baseTypes.ts:591

TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").

Inherited from

BaseField.interfaceType

---

label

label: string

Defined in: packages/core/src/fields/baseTypes.ts:567

Display label shown in the admin form. Always set — inferred from the field key if not provided.

Inherited from

BaseField.label

---

max?

optional max?: FieldLimit

Defined in: packages/core/src/fields/relationship/types.ts:157

Maximum number of related documents allowed, with its resolved error message.

See

FieldLimit

---

meta

meta: TFieldMeta

Defined in: packages/core/src/fields/baseTypes.ts:592

Inherited from

BaseField.meta

---

min?

optional min?: FieldLimit

Defined in: packages/core/src/fields/relationship/types.ts:155

Minimum number of related documents required, once a value is supplied, with its resolved error message.

See

FieldLimit

---

required

required: boolean

Defined in: packages/core/src/fields/baseTypes.ts:569

Whether this field is required in the database schema.

Inherited from

BaseField.required

---

type

readonly type: "relationship"

Defined in: packages/core/src/fields/relationship/types.ts:146

Methods

validate()?

optional validate(props): void | Promise<void>

Defined in: packages/core/src/fields/relationship/types.ts:160

Server-only async validation with value typed as string[].

Parameters

props

FieldValidateProps<TCollectionSlug, string[]>

Returns

void | Promise<void>

See

FieldValidate

Overrides

BaseField.validate