f9e5573c1e
## Description Duplicate of https://github.com/payloadcms/plugin-relationship-object-ids/pull/6 for 3.x
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Payload Relationship ObjectID Plugin
|
|
|
|
This plugin automatically enables all Payload `relationship` and `upload` field types to be stored as `ObjectID`s in MongoDB.
|
|
|
|
Minimum required version of Payload: `1.9.5`
|
|
|
|
## What it does
|
|
|
|
It injects a `beforeChange` field hook into each `relationship` and `upload` field, which converts string-based IDs to `ObjectID`s immediately prior to storage.
|
|
|
|
By default, it also injects an `afterRead` field hook into the above fields, which ensures that the values are re-formatted back to strings after having been read from the database.
|
|
|
|
#### Usage
|
|
|
|
Simply import and install the plugin to make it work:
|
|
|
|
```ts
|
|
import { relationshipsAsObjectID } from '@payloadcms/plugin-relationship-object-ids'
|
|
import { buildConfig } from 'payload'
|
|
|
|
export default buildConfig({
|
|
// your config here
|
|
plugins: [
|
|
// Call the plugin within your `plugins` array
|
|
relationshipsAsObjectID({
|
|
// Optionally keep relationship values as ObjectID
|
|
// when they are retrieved from the database.
|
|
keepAfterRead: true,
|
|
}),
|
|
],
|
|
})
|
|
```
|
|
|
|
### Migration
|
|
|
|
Note - this plugin will only store newly created or resaved documents' relations as `ObjectID`s. It will not modify any of your existing data. If you'd like to convert existing data into an `ObjectID` format, you should write a migration script to loop over all documents in your database and then simply resave each one.
|
|
|
|
### Support
|
|
|
|
If you need help with this plugin, [join our Discord](https://t.co/30APlsQUPB) and we'd be happy to give you a hand.
|