Mongo Seeding

The ultimate solution for populating your MongoDB database 🚀

Define MongoDB documents in JSON, JavaScript or even TypeScript files. Use JS library, install CLI or run Docker image to import them!

Introduction

Mongo Seeding is a flexible set of tools for importing data into MongoDB database.

It's great for:

testing database queries, automatically or manually
preparing ready-to-go development environment for your application
setting initial state for your application

How does it work?

Define documents for MongoDB import in JSON, JavaScript or TypeScript file(s). To learn, how to do that, read the import data definition guide. To see some examples, navigate to the examples directory.
Use one of the Mongo Seeding tools, depending on your needs:
???
Profit!

Motivation

There are many tools for MongoDB data import out there, including the official one - mongoimport. Why should you choose Mongo Seeding?

Problem #1: JSON used for import data definition

Every tool I found before creating Mongo Seeding support only JSON files. In my opinion, that is not the most convenient way of data definition. The biggest problems are data redundancy and lack of ability to write logic.

Imagine that you want to import 10 very similar documents into authors collection. Every document is identical - except the name:

{
  "name": "{NAME_HERE}",
  "email": "[email protected]",
  "avatar": "https://placekitten.com/300/300"
}

With every tool I've ever found, you would need to create 5 separate JSON files, or one file with array of objects. Of course, the latter option is better, but anyway you end up with a file looking like this:

[
  {
    "name": "John",
    "email": "[email protected]",
    "avatar": "https://placekitten.com/300/300"
  },
  {
    "name": "Joanne",
    "email": "[email protected]",
    "avatar": "https://placekitten.com/300/300"
  },
  {
    "name": "Bob",
    "email": "[email protected]",
    "avatar": "https://placekitten.com/300/300"
  },
  {
    "name": "Will",
    "email": "[email protected]",
    "avatar": "https://placekitten.com/300/300"
  },
  {
    "name": "Chris",
    "email": "[email protected]",
    "avatar": "https://placekitten.com/300/300"
  }
]

It doesn't look good - you did probably hear about DRY principle.

Imagine that now you have to change authors' email. You would probably use search and replace. But what if you would need change the data shape completely? This time you can also use IDE features like multiple cursors etc., but hey - it's a waste of time. What if you had a much more complicated data shape?

If you could use JavaScript to define the authors documents, it would be much easier and faster to write something like this:

const names = ['John', 'Joanne', 'Bob', 'Will', 'Chris'];

module.exports = names.map((name) => ({
  name,
  email: '[email protected]',
  avatar: 'https://placekitten.com/300/300',
}));

Obviously, in JavaScript files you can also import other files - external libraries, helper methods etc. It's easy to write some data randomization rules - which are mostly essential for creating development sample data. Consider the following example of people collection import:

const { getObjectId } = require('../../helpers/index');

const names = ['John', 'Joanne', 'Bob', 'Will', 'Chris'];

const min = 18;
const max = 100;

module.exports = names.map((name) => ({
  firstName: name,
  age: Math.floor(Math.random() * (max - min + 1)) + min,
  _id: getObjectId(name),
}));

The difference should be noticeable. This way of defining import data feels just right. And yes, you can do that in Mongo Seeding. But, JSON files are supported as well.

Problem #2: No data model validation

In multiple JSON files which contains MongoDB documents definition, it's easy to make a mistake, especially in complex data structure. Sometimes a typo results in invalid data. See the example below for people collection definition:

[
  {
    "name": "John",
    "email": "[email protected]",
    "age": 18
  },
  {
    "name": "Bob",
    "email": "[email protected]",
    "age": "none"
  }
]

Because of a typo, Bob has email field empty. Also, there is a non-number value for age key. The same problem would exist in JavaScript data definition. But, if you were able to use TypeScript, the situation slightly changes:

export interface Person {
  name: string;
  email: string;
  age: number;
}

// import interface defined above
import { Person } from '../../models/index';

const people: Person[] = [
  {
    name: 'John',
    email: '[email protected]',
    age: 18,
  },
  {
    name: 'Bob',
    emial: '[email protected]', // <-- error underlined in IDE
    age: 'none', //  <-- error underlined in IDE
  },
];

export = people;

If you used types, you would instantly see that you made mistakes - not only during import, but much earlier, in your IDE.

At this point some can say: “We had this for years — this is the purpose of mongoose!”. The problem is that importing a bigger amount of data with mongoose is painfully slow — because of the model validation. You can decide to use a faster approach, Model.collection.insert() method, but in this case you disable model validation completely!

Also, starting from version 3.6, MongoDB supports JSON Schema validation. Even if you are OK with writing validation rules in JSON, you still have to try inserting a document into collection to see if the object is valid. It is too slow and cumbersome, isn’t it? How to solve this problem?

It’s simple. Use TypeScript. Compile time model validation will be much faster. And IDE plugins (or built-in support like in Visual Studio Code) will ensure that you won’t make any mistake during sample data file modification. Oh, and the last thing: If you have an existing TypeScript application which uses MongoDB, then you can just reuse all models for data import.

The Mongo Seeding CLI and Mongo Seeding Docker Image have TypeScript runtime built-in. It means that you can take advantage of static type checking in TypeScript data definition files (.ts extension).

Problem #3: No ultimate solution

Tools like this should be as flexible as possible. Some developers need just CLI tool, and some want to import data programmatically. Before writing Mongo Seeding, I needed a ready-to-use Docker image and found none. Dockerizing an application is easy, but it takes time.

That's why Mongo Seeding consists of:

TypeScript/JavaScript library - it can be installed straight from NPM and used in any JavaScript/TypeScript project,
Command line interface (CLI) - it can be installed globally and used from command line in any location,
Docker image - it is good for containerized applications.

All tools you'll ever need for seeding your MongoDB database.

Contribution

Before you contribute to this project, read CONTRIBUTING.md file.

pkosiec/mongo-seeding

pkosiec

Reviews

Repository Details