8.1.3-alpha.1 • Published 4 years ago

@davidsemakula/keystone-adapter-mongoose v8.1.3-alpha.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

Mongoose database adapter

View changelog

Usage

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

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

Config

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().

Default:

{
  useNewUrlParser: true,
  useFindAndModify: false,
  useUnifiedTopology: true,
}

See the Mongoose docs for a detailed list of options.