mongobrz v1.0.0

mongobrz

Fast way to start with mongodb. Mongoose schema, model and functions ready to manage database, collection and document.

Mongobrz is a helper to manage MongoDB database. It can connect/disconnect to the mongo server, create schema and model and save, list, update and delete documents. Also it can delete database and collection and list db collections.

Installation

$ npm install --save mongobrz

Example

/*** NodeJS script ***/
const Mongobrz = require('../index.js');

const main = async () => {
  // connection
  const mo_uri = 'mongodb://user:pass@5.185.161.70:27017/dex8-freepool03';
  const mongobrz = new Mongobrz();
  await mongobrz.connect(mo_uri);

  const collectionName = 'mongo-test';

  // compile 'mongo-testMD'
  await mongobrz.compileModel(collectionName); // model compiled with the generic schema

  // take a model
  mongobrz.useModel(collectionName);

  // create new doc
  const doc = {
    url: 'http://saved.com',
    text: 'Lorem ipsum SAVED',
    depth: 55
  };
  await mongobrz.save(doc)
    .then(docNew => {
      console.log(`New doc saved to dex8-freepool03/${collectionName} collection:`);
      console.log(docNew);
      mongobrz.disconnect();
    });

  // disconnection
  await mongobrz.disconnect();
};


main().catch(console.log);

Other examples are in /tests/ folder.

Generic Schema

The library is using generic (empty & not strict) mongoose schema but user can define any schema.

const collection = 'generic';

// options
const opts = {
  collection, // default collection
  _id: true, // disable _id
  id: false, // set virtual id property
  autoIndex: true, // auto-create indexes in mognodb collection on mongoose restart
  minimize: true, // remove empty objects
  // safe: true, // pass errors to callback
  strict: false, // values not defined in schema will not be saved in db
  validateBeforeSave: true, // validate doc before saving. prevent saving false docs
  timestamps: { // create timestamps for each doc 'created_at' & 'updated_at'
    createdAt: 'created_at',
    updatedAt: 'updated_at'
  },
  new: true,
  // skipVersioning: { myProp: true }, // prevent changing version __v when 'myProp' is updated
  // versionKey: '_myV', // replace __v with _myV (not needed in most cases)
};


// mongoose schema
const moSchema = new Schema({}, opts);

API

constructor()

async connect(mo_uri) :Promise

Connects to the mongoDB server via mongo URI. Used database is also defined. mongo.connect('mongodb+srv://user:pass@cluster0-n4qix.mongodb.net/dex8-dev-pool-free01?retryWrites=true&w=majority')

async disconnect() :Promise

Disconnect from already connected mongoDB server via mongo URI. mongo.disconnect()

deleteDatabase() :Promiseboolean

Remove whole database. mongo.deleteDatabase()

showCollections() : Promisearray

Lists all collections in the database. mongo.showCollections()

deleteCollection(collectionName) :Promiseboolean

Removes collection from the database. mongo.deleteCollection('companies')

async compileModel(moSchema) :Promisevoid

Compiles mongoose model. Parameter must be valid mongoose schema. The model object is pushed into the "this.compiledModels" array. mongo.compileModel(moSchema)

useModel(collectionName) :void

Takes model on which operations will be performed. It defines on which collection documents will be added, listed, updated, removed ... mongo.useModel(collectionName)

save(doc) :Promiseobject

Adds document in collection. Mongoose save function is used. mongo.save({x: 23, y: 'something'})

add(doc | docs) :Promiseobject

Adds document in collection. Parameter can be a single object or array of objects. Mongoose create function is used. mongo.add({x: 23, y: 'something'}) mongo.add({x: 23, y: 'something'}, {x: 25, y: 'aaa'}) - database called two times

insertMulti(docs, insOpts) :Promiseobject

Bulk insertions. While add() will send multiple db requests for every doc, this method will call database only once. Mongoose create function is used.

const insOpts = {
  ordered: false, // (true) if true, will fail fast on the first error encountered and don't execute the remaining writes
  rawResult: true, // (false) will return inserted docs
  lean: false, // (false) if true skip schema validation
  limit: null // (null) limits the number of documents being processed
};

mongo.insertMulti([{x: 23, y: 'something'}, {x: 25, y: 'aaa'}], insOpts) // database called once

list(moQuery, limit, skip, sort, select) :Promiseobject

List and count documents from collection by using mongo search query criteria. Mongoose find function is used. mongo.list({x: {$gt3: 3}}, 5, 0, '-x', '-_id')

listFast(moQuery, limit, skip, sort, select) :Promiseobject

List documents from collection by using mongo search query criteria. This is useful for big collections because list() method is using count and is much slower. Mongoose find function is used. mongo.listFast({x: {$gt3: 3}}, 5, 0, '-x', '-_id')

getOne(moQuery, sort, select) :Promiseobject

Fetch one document from collection. Mongoose findOne function is used. mongo.getOne({x: 3})

deleteOne(moQuery) :Promiseobject

Delete just one document. Mongoose findOneAndDelete function is used. mongo.deleteOne({x: 3})

deleteMulti(moQuery) :Promiseobject

Delete multiple documents. Mongoose deleteMany function is used. mongo.deleteMulti({x: {$lt: 5}})

editOne(moQuery, docNew, updOpts) :Promiseobject

Update one document. Mongoose findOneAndUpdate function is used.

const updOpts = {
  new: true, // return updated document as 'result'
  upsert: false, // whether to create the doc if it doesn't match (false)
  runValidators: false, // validators validate the update operation against the model's schema
  strict: false, // values not defined in schema will not be saved in db (default is defined in schema options, and can be overwritten here)
  // sort: {created_at: -1} // if multiple results are found, sets the sort order to choose which doc to update
}
mongo.editOne({x: 3}, {x: 5, y: 'some thing'}, updOpts)

countDocs(moQuery) :Promisenumber

Count documents according to the given mongo query. Returned value is a number. Mongoose countDocuments function is used. mongo.count({x: {$gt: 10}})

License

The software licensed under AGPL-3.