@mongodb-model/db-query
v0.0.10
Published
db-query
Downloads
3
Readme
db-query
db-query is very simple yet very powerful tool for interacting with mongodb database and making internal or external API calls. Under the hood db-query is a wrapper for the nodejs mongodb driver. It also extracts away the complexities commonly encountered in NodeJs Mongodb driver or Mongoose.js. It is also a duplex stream, specifically a Transform stream. It uses full power of the Nodejs mongodb driver and of the NodeJs Transform Stream API. In other words, everything you can do with mongodb NodeJs driver, Mongoose.js and NodeJs Transform API you can do with db-query! db-query is centrally very highly event driven. Its common use is by extension or by using object destruction to get the instance methods needed or by simply using class instantiation.
Note
The db-query object is an ES6 Class with an unlimited constructor parameters. All of the constructor parameters are optional! However, the most important constructor parameter is the first parameter, because it an object that defines your database connection parameters.
How it works
Simple and easy! On average you need no more than 3 lines of code for each of your queries or CRUD operations, even with the most complex ones. For event base queries, db-query emits two events: a success event and an error event.
Success event: The success event name is the name of db-query method executed in the query minus the string 'Callback'.
Error event: The error event name is the name of db-query method executed in the query minus the string 'Callback' plus the string "-error".
Explanation : If you use the createCallback method in your query, model will emit success event create with the created object or error event create-error with the error object.
Installation
$ yarn add @mongodb-model/db-query
or
$ npm i @mongodb-model/db-query
Simple Usage Examples
constructor parameters: first parameter object
const Model = require('@mongodb-model/db-query');
// Usage
const YourCustomModel = new Model({db: 'your_database_name', collection: 'your_collection_name', url: 'your_database_url'})
// No constructor Parameter provided:
const User = new Model;
// Default collection is 'users'
// Default database name is your .env DATABASE_NAME
// Default database url is your .env DATABASE_URL or 'mongodb://localhost:27017'
// Constructor first parameter object with only collection key
const User = new Model({collection: 'users'});
// Default database name is your .env DATABASE_NAME
// Default database url is your .env DATABASE_URL or 'mongodb://localhost:27017'
// Connecting to multiple databases
const BlogUser = new Model({db: 'blog', collection: 'users'})
const WorkChat = new Model({db: 'work', collection: 'chats'})
const ArticleUser = new Model({db: 'article', collection: 'users'});
const ForumUser = new Model({db: 'forum', collection: 'users'})
// query (create query using ForumUser)
const userData = {firstname: 'John', lastname: 'Doe', email: '[email protected]'};
ForumUser.createCallback(userData);
ForumUser.on('create', user => console.log('new user created', user));
ForumUser.on('create-error', error => console.log('new user creation error', error));
constructor parameters: all other parameter objects
const Model = require('@mongodb-model/db-query');
const User = new Model({},{title: 'Cool Users', age: 25, fullName: () => 'User Full Name', Post: class Post {}});
// The User model now has the following added to its prototype and they are bounded to it: title,age, fullName, post
// So now we can do things like the following:
const title = User.title
const age = User.age
const fullname = User.fullName();
const FirstPost = new User.Post
// Or using object destructuring
const {title, age, fullName, Post} = User
Making api request (http request)
const DbQuery = require('@mongodb-model/db-query');
const db = new DbQuery();
db.apiGet(); //base.apiGet(your api endpoint)
db.on('apiGet', data => console.log(data));
db.on('apiGet-error', error => console.error(error));
By extension
class MyWonderfulClass extends require('@mongodb-model/db-query') {
constructor(...arrayOfObjects) {
super({ objectMode: true, encoding: "utf-8", autoDestroy: true });
arrayOfObjects.forEach(option => {
if(Object.keys(option).length > 0){
Object.keys(option).forEach((key) => { if(!this[key]) this[key] = option[key];})
}
});
this.autobind(MyWonderfulClass);
this.autoinvoker(MyWonderfulClass);
this.setMaxListeners(Infinity);
}
};
common usage example
const DB = require('@mongodb-model/db-query');
const db = new DB();
// db-query emits its method names as success events and its method names plus the string "-error" as error events
// create collection
db.createCollectionCallback('apps')
db.on('createCollection', console.log)
db.on('createCollection-error', console.error)
// create
const userData = {firstname: 'John', lastname: 'Doe',email: '[email protected]', phone: '123-456-4343'}
db.createCallback(userData)
db.on('create', console.log)
db.on('create-error', console.log)
// findByEmail
db.findByEmailCallback('[email protected]')
db.on('findByEmail', console.log)
db.on('findByEmail-error', console.log)
Available instance methods
const DB = require('@mongodb-model/db-query');
const db = new DB();
// The following functions are available on db, the DB instance, as methods.
createCollectionCallback(collectionName = 'users');
dropCollectionCallback(collectionName = 'users');
insertOneCallback(data = {}, collectionName = 'users');
createCallback(data = {}, collectionName = 'users');
insertManyCallback(data = [], collectionName = 'users');
createManyCallback(data = [], collectionName = 'users');
findOneCallback(query = {}, collectionName = 'users');
firstCallback(query = {}, collectionName = 'users');
findCallback(query = {}, projection = {}, collectionName = 'users');
allCallback(query = {}, projection = {}, collectionName = 'users');
sortCallback(query = {},sort = {},projection = {},collectionName = 'users');
deleteOneCallback(query = {}, collectionName = 'users');
deleteManyCallback(query = {}, collectionName = 'users');
dropCollectionCallback(collectionName = 'collectionName', dbName = 'dbName');
collectionDropCallback(dbName = 'dbName', collectionName = 'collectionName');
updateOneCallback(query = {}, data = {}, collectionName = 'users');
updateCallback(query = {}, data = {}, collectionName = 'users');
updateManyCallback(query = {}, data = {}, collectionName = 'users');
limitCallback(query = {},limit = 1,projection = {},collectionName = 'users');
letfJoinCallback(collectionOne = "users", collectionTwo = "contacts", localField = "_id", foreignField = "user_id", as = "usersContacts");
findByIdCallback(id, collectionName = 'users');
findByEmailCallback(email, collectionName = 'users');
firstByEmailCallback(email, collectionName = 'users');
firstByUsernameCallback(username, collectionName = 'users');
firstByPhoneCallback(phone, collectionName = 'users');
firstByFirstNameCallback(firstname, collectionName = 'users');
firstByLastNameCallback(lastname, collectionName = 'users');
findByQueryCallback(query = {}, projection = {}, collectionName = 'users');
firstByQueryCallback(query = {}, collectionName = 'users');
firstByTokenCallback(token, collectionName = 'users')
Author's Info
Website|NPM|Github|Gitlab|Blog|LinkedIn|Facebook|Twitter|Instagram| --- | --- | --- | --- | --- | --- | --- |--- |--- | Website|NPM|Github|Gitlab|Blog|LinkedIn|Facebook|Twitter|Instagram|