RelationshipField
Defined in: packages/core/src/fields/relationship/types.ts:137
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
Section titled “Type Param”TCollection
The target collection slug (inferred from input).
- RelationshipFieldInput for the user-facing input type
- relationship for the config function
Extends
Section titled “Extends”BaseField<TFieldMeta>
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
Properties
Section titled “Properties”admin:
FieldAdminConfig&RelationshipFieldAdminConfig<TCollectionSlug,TComponent>
Defined in: packages/core/src/fields/relationship/types.ts:150
Resolved admin UI configuration with all defaults applied.
Overrides
Section titled “Overrides”collection
Section titled “collection”collection:
object
Defined in: packages/core/src/fields/relationship/types.ts:144
Target collection reference.
slug:
TCollectionSlug
The slug of the collection this field links to.
defaultValue?
Section titled “defaultValue?”
optionaldefaultValue?:unknown
Defined in: packages/core/src/fields/baseTypes.ts:241
Pre-filled value shown in the admin form when creating a new field. Does not apply to database values
Inherited from
Section titled “Inherited from”description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:252
Semantic description of the field. Used in three places:
- Helper text rendered below the field input in the admin form UI.
- As the Zod
.meta({ description })value for form validation. - As the JSDoc comment on the generated document interface property.
To write a separate JSDoc comment, use interfaceDescription in addition.
Inherited from
Section titled “Inherited from”hasMany
Section titled “hasMany”hasMany:
boolean
Defined in: packages/core/src/fields/relationship/types.ts:149
Whether this field stores multiple document references.
index?
Section titled “index?”
optionalindex?:string
Defined in: packages/core/src/fields/baseTypes.ts:256
Convex index name for this field.
Inherited from
Section titled “Inherited from”interfaceDescription?
Section titled “interfaceDescription?”
optionalinterfaceDescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:254
The JSDoc comment on the generated document interface property
Inherited from
Section titled “Inherited from”BaseField.interfaceDescription
interfaceType
Section titled “interfaceType”interfaceType:
string
Defined in: packages/core/src/fields/baseTypes.ts:258
TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").
Inherited from
Section titled “Inherited from”label:
string
Defined in: packages/core/src/fields/baseTypes.ts:234
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Inherited from
Section titled “Inherited from”meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:259
Inherited from
Section titled “Inherited from”required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:236
Whether this field is required in the database schema.
Inherited from
Section titled “Inherited from”
readonlytype:"relationship"
Defined in: packages/core/src/fields/relationship/types.ts:142