MongoDB
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:
1
import { mongooseAdapter } from '@payloadcms/db-mongodb'
2
3
export default buildConfig({
4
// Your config goes here
5
collections: [
6
// Collections go here
7
],
8
// Configure the Mongoose adapter here
9
db: mongooseAdapter({
10
// Mongoose-specific arguments go here.
11
// URL is required.
12
url: process.env.DATABASE_URI,
13
}),
14
})
Options
| Option | Description |
|---|---|
autoPluralization | Tell Mongoose to auto-pluralize any collection names if it encounters any singular words used as collection slugs. |
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. |
collectionsSchemaOptions | Customize Mongoose schema options for collections. |
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. |
transactionOptions | An object with configuration properties used in transactions or false which will disable the use of transactions. |
collation | Enable language-specific string comparison with customizable options. Available on MongoDB 3.4+. Defaults locale to "en". Example: { strength: 3 }. For a full list of collation options and their definitions, see the MongoDB documentation. |
Access to Mongoose models
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:
- Collection models -
payload.db.collections[myCollectionSlug] - Globals model -
payload.db.globals - Versions model (both collections and globals) -
payload.db.versions[myEntitySlug]
Next