Skip to content
KeystoneJS LogoKeystoneJSv5

Mongoose Database Adapter

Usage

const { MongooseAdapter } = require('@keystonejs/adapter-mongoose');

const keystone = new Keystone({
  name: 'My Awesome Project',
  adapter: new MongooseAdapter(),
});

API new MongooseAdapter(options)

options.mongoUri (optional)

This is used as the uri parameter for mongoose.connect().

Default: Environmental variable (see below) or 'mongodb://localhost/<DATABASE_NAME>'

If not specified, KeystoneJS will first look for one of the following environmental variables:

  • CONNECT_TO,
  • DATABASE_URL,
  • MONGO_URI,
  • MONGODB_URI,
  • MONGO_URL,
  • MONGODB_URL,
  • MONGOLAB_URI,
  • MONGOLAB_URL

If none of these are found a connection string is derived with a DATABASE_NAME from the KeystoneJS project name.

Mongoose Options (optional)

Additional Mongoose config options are passed directly through to mongoose.connect().

See the Mongoose docs for a detailed list of options.

Have you found a mistake, something that is missing, or could be improved on this page? Please edit the Markdown file on GitHub and submit a PR with your changes.

Edit Page