mongodb-memory-server-core

What is mongodb-memory-server-core?

The mongodb-memory-server-core package provides an in-memory MongoDB server for testing purposes. It allows developers to spin up a MongoDB server instance that runs entirely in memory, making it ideal for unit tests and integration tests where a real MongoDB server would be overkill or too slow.

What are mongodb-memory-server-core's main functionalities?

Start an In-Memory MongoDB Server

This feature allows you to start an in-memory MongoDB server instance. The code sample demonstrates how to create a new MongoMemoryServer instance and retrieve its URI.

const { MongoMemoryServer } = require('mongodb-memory-server-core');
(async () => {
  const mongod = new MongoMemoryServer();
  const uri = await mongod.getUri();
  console.log(`MongoDB Server started at ${uri}`);
})();

Stop the In-Memory MongoDB Server

This feature allows you to stop the in-memory MongoDB server instance. The code sample demonstrates how to start and then stop the MongoMemoryServer instance.

const { MongoMemoryServer } = require('mongodb-memory-server-core');
(async () => {
  const mongod = new MongoMemoryServer();
  await mongod.start();
  console.log('MongoDB Server started');
  await mongod.stop();
  console.log('MongoDB Server stopped');
})();

Use with Mongoose

This feature allows you to use the in-memory MongoDB server with Mongoose. The code sample demonstrates how to connect Mongoose to the in-memory MongoDB server, perform database operations, and then disconnect and stop the server.

const mongoose = require('mongoose');
const { MongoMemoryServer } = require('mongodb-memory-server-core');
(async () => {
  const mongod = new MongoMemoryServer();
  const uri = await mongod.getUri();
  await mongoose.connect(uri, { useNewUrlParser: true, useUnifiedTopology: true });
  console.log('Mongoose connected to in-memory MongoDB');
  // Perform database operations
  await mongoose.disconnect();
  await mongod.stop();
})();

Other packages similar to mongodb-memory-server-core

mockgoose

Mockgoose is a library that provides a mock to mongoose by using an in-memory database. It is similar to mongodb-memory-server-core in that it allows for in-memory MongoDB instances, but it is specifically designed to work with Mongoose.

mongodb-memory-server

Mongodb-memory-server is a higher-level package that wraps around mongodb-memory-server-core and provides additional features and utilities. It is more user-friendly and includes more out-of-the-box functionality compared to mongodb-memory-server-core.

mongo-unit

Mongo-unit is a library that provides utilities for unit testing with MongoDB. It allows you to start and stop in-memory MongoDB instances and load initial data. It is similar to mongodb-memory-server-core but includes additional utilities for unit testing.

README

mongodb-memory-server-core

Core package which contains main code. Used in all other packages.

Full README with available options and examples

Changelog

10.1.3 (2024-12-30)

Fixes

• DryMongoBinary::getPath: always absoluteize System_Binary path (c0975c3)
• MongoBinary::getPath: check that "stdout" actually exists (613e670), closes #742 #issuecomment-2528284865
• MongoBinary: dont execute systembinary "--version" cmd if version check is false (03c8412)