mongodb

Management and migration tools for MongoDB

Install

$ npm install @trubavuong/mongodb

Usage

Connect & query

const { MongoManager } = require('@trubavuong/mongodb');

const manager = new MongoManager({
  url: 'mongodb://localhost:27017',
  database: 'example',
  collections: {
    UserCollection: 'user',
  },
});

await manager.connect();

const users = await manager.UserCollection.find().toArray();

await manager.close();

Migration

const { MongoMigrator } = require('@trubavuong/mongodb');

const migrator = new MongoMigrator({
  manager,
  migrationCollectionAlias: 'MigrationCollection',
  migrationDirectory: 'migrations',
});

await migrator.createNewMigrationFile('insert-comments');

await migrator.migrate();

await migrator.status();

As above example, all migration files will be stored in migrations directory.

Each file named with format {version}.{description}.js:

• version: integer number
• description: string, accept a-z and - characters only

Each file is a module like this:

module.exports = async (manager, session) => {};

• manager: MongoManager instance
• session: MongoDB session object, supports transaction

Note: you should create your own cli script when interact with migration steps (create a new migration file, check status, and execute migrations).

Access the original MongoDB lib

const { og } = require('@trubavuong/mongodb');

// og.ObjectId

APIs

MongoManager

const { MongoManager } = require('@trubavuong/mongodb');

Constructor

const manager = new MongoManager({
  url: 'mongodb://localhost:27017', // required, endpoint
  options: {},                      // optional
  database: 'example',              // required, database name
  collections: {                    // optional, alias - collection name map
    UserCollection: 'user',
    PostCollection: 'post',
  },
});

manager.connect()

Connects to MongoDB server and populate some properties

await manager.connect();

// after that you can use some properties:
// - manager.client         // MongoDB client object
// - manager.db             // MongoDB database
// - manager.UserCollection // MongoDB collection alias, same as defined in constructor

manager.close()

Closes client

await manager.close();

MongoMigrator

const { MongoMigrator } = require('@trubavuong/mongodb');

Constructor

const migrator = new MongoMigrator({
  manager,                                         // MongoManager instance
  migrationCollectionAlias: 'MigrationCollection', // MongoDB migration collection alias
  migrationDirectory: 'migrations',                // migration directory
});

migrator.createNewMigrationFile(name)

Creates a new migration file

await migrator.createNewMigrationFile('update-users');

// this will create a new file in migration directory
// if the directory is empty, filename should be '1.update-users.js'
// else the latest migration file such as named '8.create-post-indexes.js', filename should be '9.update-users.js'

migrator.status()

Shows migration status

await migrator.status();

migrator.migrate()

Executes migration files each by each automatically

await migrator.migrate();