serverless-mongodb-local

Serverless MongoDB local plugin

Features

• Automatically starts/stops a local MongoDB instance
• Automatically downloads MongoDB binaries on first use
• Can be used as a local equivalent to DocumentDB/CosmosDB

Install

npm i -D serverless-mongodb-local

Usage

In serverless.yaml

plugins:
  - serverless-mongodb-local

custom:
  mongodb:
    stages: # If you only want to use MongoDB Local in particular stages, declare them here as a string or regex
      - dev
      - 'dev-\d+'
    instance: # MongoMemoryServer() options and defaults https://github.com/nodkz/mongodb-memory-server#available-options-for-mongomemoryserver
      port: 1234
      dbName: MyDB
      dbPath: ./db
      storageEngine: wiredTiger # Set with `dbPath` to persists the database between instantiations
    seed:
      auto: true
      dataPath: ./test/data

In your handlers

const { MongoClient } = require('mongodb');

const client = await MongoClient.connect(
  process.env.SLS_MONGODB_URI,  // Provided as a convenience when using the plugin (local only, requires --localEnvironment flag to be set on the command line) 
  { useUnifiedTopology: true }
);

Seeding data

By setting a mongodb.seed.dataPath any .json files in the folder will be imported as collections. The name of file being the name of the collection. The file should be an array of documents to load into the collection.

Using with serverless-offline plugin

plugins:
  - serverless-mongodb-local
  - serverless-offline

Make sure that serverless-mongodb-local is above serverless-offline so it will be loaded earlier.

Now your local MongoDB database will be automatically started before running serverless-offline, when using the command sls offline start.

Usage on the command line

# Start the db
sls mongodb start --localEnvironment 

# Seed the db
sls mongodb seed --localEnvironment

Credit

• Inspired by serverless-dynamodb-local
• MongoDB install/control provided by mongodb-memory-server

Development

Run

npm start

Build

npm test

Publish

npm version patch|minor|major
git push --follow-tags