Relationship Field

Example uses:

  • To add Product documents to an Order document
  • To allow for an Order to feature a placedBy relationship to either an Organization or User collection
  • To assign Category documents to Post documents

Config

OptionDescription
name *To be used as the property name when stored and retrieved from the database.
*relationTo *Provide one or many collection slugs to be able to assign relationships to.
hasManyBoolean when, if set to true, allows this field to have many relations instead of only one.
labelUsed as a field label in the Admin panel and to name the generated GraphQL type.
uniqueEnforce that each entry in the Collection has a unique value for this field.
validateProvide a custom validation function that will be executed on both the Admin panel and the backend. More
indexBuild a MongoDB index for this field to produce faster queries. Set this field to true if your users will perform queries on this field's data often.
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide field-based hooks to control logic for this field. More
accessProvide field-based access control to denote what users can see and do with this field's data. More
hiddenRestrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.
defaultValueProvide data to be used for this field's default value.
localizedEnable localization for this field. Requires localization to be enabled in the Base config.
requiredRequire this field to have a value.
adminAdmin-specific configuration. See the default field admin config for more details.

* An asterisk denotes that a property is required.

Example

collections/ExampleCollection.js

{
slug: 'example-collection',
fields: [
{
name: 'placedBy', // required
type: 'relationship', // required
relationTo: ['organizations', 'users'], // required
label: 'Placed By',
hasMany: false,
required: true,
}
]
}
Next

Rich Text Field