Productdocuments to an
Orderto feature a
placedByrelationship to either an
|To be used as the property name when stored and retrieved from the database. More|
|Provide one or many collection |
|A query to filter which options appear in the UI and validate against. More.|
|Boolean when, if set to |
|A number for the fewest allowed items during validation when a value is present. Used with |
|A number for the most allowed items during validation when a value is present. Used with |
|Sets a number limit on iterations of related documents to populate when queried. Depth|
|Text used as a field label in the Admin panel or an object with keys for each language.|
|Enforce that each entry in the Collection has a unique value for this field.|
|Provide a custom validation function that will be executed on both the Admin panel and the backend. More|
|Build a an index for this field to produce faster queries. Set this field to |
|If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.|
|Provide field-based hooks to control logic for this field. More|
|Provide field-based access control to denote what users can see and do with this field's data. More|
|Restrict 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.|
|Provide data to be used for this field's default value. More|
|Enable localization for this field. Requires localization to be enabled in the Base config.|
|Require this field to have a value.|
|Admin-specific configuration. See the default field admin config for more details.|
|Extension point for adding custom data (e.g. for plugins)|
* An asterisk denotes that a property is required.
In addition to the default field admin config, the Relationship field type also allows for the following admin-specific properties:
true if you'd like this field to be sortable within the Admin UI using drag and drop (only works when
hasMany is set to
false if you'd like to disable the ability to create new documents from within the relationship field (hides the "Add new" button in the admin UI).
sortOptions property allows you to define a default sorting order for the options within a Relationship field's dropdown. This can be particularly useful for ensuring that the most relevant options are presented first to the user.
You can specify
sortOptions in two ways:
As a string:
Provide a string to define a global default sort field for all relationship field dropdowns across different collections. You can prefix the field name with a minus symbol ("-") to sort in descending order.
This configuration will sort all relationship field dropdowns by
"fieldName" in ascending order.
As an object :
Specify an object where keys are collection slugs and values are strings representing the field names to sort by. This allows for different sorting fields for each collection's relationship dropdown.
In this configuration:
pageswill be sorted by
"fieldName1"in ascending order.
"fieldName2"for sorting in descending order (noted by the "-" prefix).
categorieswill sort based on
"fieldName3"in ascending order.
sortOptions is not defined, the default sorting behavior of the Relationship field dropdown will be used.
Options can be dynamically limited by supplying a query constraint, which will be used both for validating input and filtering available relationships in the UI.
filterOptions property can either be a
Where query directly, or a function (synchronous or asynchronous) that returns one. When using a function, it will be called with an argument object containing the following properties:
|An object of the full collection or global document currently being edited|
|An object of the document data limited to fields within the same parent to the field|
|The value of the collection |
|The currently authenticated user object|
You can learn more about writing queries here.
Given the variety of options possible within the
relationship field type, the shape of the data needed for creating and updating these fields can vary. The following sections will describe the variety of data shapes that can arise from this field.
The most simple pattern of a relationship is to use
hasMany: false with a
relationTo that allows for only one type of collection.
The shape of the data to save for a document with the field configured this way would be:
When querying documents in this collection via REST API, you could query as follows:
Also known as dynamic references, in this configuration, the
relationTo field is an array of Collection slugs that tells Payload which Collections are valid to reference.
The shape of the data to save for a document with more than one relationship type would be:
Here is an example for how to query documents by this data (note the difference in referencing the
You can also query for documents where a field has a relationship to a specific Collection:
This query would return only documents that have an owner relationship to organizations.
hasMany tells Payload that there may be more than one collection saved to the field.
To save the to
hasMany relationship field we need to send an array of IDs:
When querying documents, the format does not change for arrays:
Relationship fields with
hasMany set to more than one kind of collections save their data as an array of objects—each containing the Collection
slug as the
relationTo value, and the related document
id for the
Querying is done in the same way as the earlier Polymorphic example:
Polymorphic and non-polymorphic relationships must be queried differently because of how the related data is stored and may be inconsistent across different collections. Because of this, filtering polymorphic relationship fields from the Collection List admin UI is limited to the
For a polymorphic relationship, the response will always be an array of objects. Each object will contain the
The data can be queried by the related document ID:
Or by the related document Collection slug:
However, you cannot query on any field values within the related document. Since we are referencing multiple collections, the field you are querying on may not exist and break the query.