To use Payload with MongoDB, install the package @payloadcms/db-mongodb
. It will come with everything you need to store your Payload data in MongoDB.
Then from there, pass it to your Payload config as follows:
Option | Description |
---|---|
autoPluralization | Tell Mongoose to auto-pluralize any collection names if it encounters any singular words used as collection slug s. |
connectOptions | Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the options available to mongoose. |
disableIndexHints | Set to true to disable hinting to MongoDB to use 'id' as index. This is currently done when counting documents for pagination, as it increases the speed of the count function used in that query. Disabling this optimization might fix some problems with AWS DocumentDB. Defaults to false |
migrationDir | Customize the directory that migrations are stored. |
After Payload is initialized, this adapter exposes all of your Mongoose models and they are available for you to work with directly.
You can access Mongoose models as follows:
payload.db.collections[myCollectionSlug]
payload.db.globals
payload.db.versions[myEntitySlug]