lx-mongodb

v0.7.0

Published

2 years ago

Litixsoft backend driver for mongoDb.

Downloads

0High
0Medium
0Low

mongodb mongojs mongodb driver data access layer baboon database backend mongodb repository mongodb schema mongodb json schema

lx-mongodb

Litixsoft backend driver for mongoDb based on mongojs.

Install

Documentation

http://www.litixsoft.de/products-lxmongodb.html (german)

Examples

Simple query

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost/blog?w=1&journal=True&fsync=True', ['users']),
    repo = lxDb.BaseRepo(db.users);

// get all users
repo.find(function(error, result) {
	console.log(result);
});

// add user
repo.insert({userName: 'wayne', age: 99}, function(error, result) {
	console.log(result);
});

Simple repository with JSON schema

var lxDb = require('lx-mongodb');

exports.UserRepository = function (collection) {
    var schema = function () {
            return {
                properties: {
                    _id: {
                        type: 'string',
                        required: false,
                        format: 'mongo-id',
                        key: true
                    },
                    email: {
                        type: 'string',
                        required: true,
                        format: 'email'
                    },
                    userName: {
                        type: 'string',
                        required: true,
                        sort: 1
                    }
                }
            };
        },
        baseRepo = lxDb.BaseRepo(collection, schema);

    return baseRepo;
};

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost/blog?w=1&journal=True&fsync=True', ['users']),
    userRepo = require('./userRepo.js').UserRepository(db.users);

// get all users
userRepo.find(function(err, res) {
    console.log(res); // array of users
});

// create new user
userRepo.insert({userName: 'Wayne', age: 99}, function(err, res) {
    console.log(res); // user object
});

Repository with validation

var lxDb = require('lx-mongodb');

exports.UserRepository = function (collection) {
    var schema = function () {
            return {
                properties: {
                    _id: {
                        type: 'string',
                        required: false,
                        format: 'mongo-id',
                        key: true
                    },
                    email: {
                        type: 'string',
                        required: true,
                        format: 'email'
                    },
                    userName: {
                        type: 'string',
                        required: true,
                        sort: 1
                    },
                    birthdate: {
                        type: 'string',
                        format: 'date-time'
                    },
                }
            };
        },
        baseRepo = lxDb.BaseRepo(collection, schema);

    // validation function for the userName
    baseRepo.checkUserName = function (doc, callback) {
        if (!doc) {
            callback(null, {valid: true});
            return;
        }

        var query = {
            userName: doc.userName,
            _id: {
                $ne: typeof doc._id === 'string' ? baseRepo.convertId(doc._id) : doc._id
            }
        };

        baseRepo.findOne(query, function (err, res) {
            if (err) {
                callback(err);
            } else if (res) {
                callback(null,
                    {
                        valid: false,
                        errors: [
                            {
                                attribute: 'checkUserName',
                                property: 'userName',
                                expected: false,
                                actual: true,
                                message: 'already exists'
                            }
                        ]
                    }
                );
            } else {
                callback(null, {valid: true});
            }
        });
    };

    // validation function
    baseRepo.validate = function (doc, isUpdate, schema, callback) {
        var userNameCheck = true;

        // check is update
        if (isUpdate) {
            for (var schemaProp in schema.properties) {
                if (schema.properties.hasOwnProperty(schemaProp)) {
                    if (!doc.hasOwnProperty(schemaProp)) {
                        schema.properties[schemaProp].required = false;
                    }
                }
            }

            if (!doc.hasOwnProperty('userName')) {
                userNameCheck = false;
            }
        }

        // json schema validate
        var valResult = val.validate(doc, schema, baseRepo.getValidationOptions());

        // register async validator
        if (userNameCheck) {
            val.asyncValidate.register(baseRepo.checkUserName, doc.userName);
        }

        // async validate
        val.asyncValidate.exec(valResult, callback);
    };

    return baseRepo;
};

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost/blog?w=1&journal=True&fsync=True', ['users']),
    userRepo = require('./userRepo.js').UserRepository(db.users);

// create new user
userRepo.insert({userName: 'Wayne', age: 99}, function(err, res) {
    console.log(res); // User Objekt
});

// JSON schema validation of the user
userRepo.validate({userName: 'Wayne', age: 99}, function(err, res) {
    res.valid === false // true
    res.errors[0].property === 'email' // true
    res.errors[0].message === 'email is required' // true
});

// async schema validation of the user
userRepo.validate({userName: 'Wayne', age: 99}, function(err, res) {
    res.valid === false // true
    res.errors[0].property === 'userName' // true
    res.errors[0].message === 'userName already exists' // true
});

API

Database connection

getDb

Base repository

Gridfs base repository

Database connection

Note: When querying the metadata of gridFsCollections, you need to add them to the collections array. See examples.

Arguments

connectionString {!string} - The connection string.
collections {!Array.<string>} - The names of the mongo collections.
gridFsCollections {Array.<string>=} - The names of the gridfs collections.

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost:27017/blog?w=0&journal=True&fsync=True', ['posts', 'tags', 'comments']);

// with gridfs collections
var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost:27017/blog?w=0&journal=True&fsync=True', ['posts', 'tags', 'comments'], ['documents']);

// with gridfs collections and collection for querying the gridfs metadata
var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost:27017/blog?w=0&journal=True&fsync=True', ['posts', 'tags', 'comments', 'documents.files', 'pdf.files'], ['documents', 'pdf']);

Base repository

Arguments

collection {!Object} - The mongoDb colllection.
schema {(Object|Function)=} - The JSON schema. Is used to get the id field and the default sorting.

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost:27017/blog?w=0&journal=True&fsync=True', ['posts', 'tags', 'comments']),
    postRepo = lxDb.BaseRepo(db.posts);

Arguments

pipeline {!Array} - The aggregation framework pipeline.
options {Object=} - The additional options.
callback {function(err, res)} - The callback function.

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost:27017/blog?w=0&journal=True&fsync=True', ['users']),
    repo = lxDb.BaseRepo(db.users),
    pipeline = [
        {$project: {age: 1}},
        {$group: {_id: {age: '$age'}, count: { $sum: 1}}},
        {$project: {_id: '$_id', age: '$age', count: '$count'}}
    ];

    repo.aggregate(pipeline, {}, function(error, result) {
        // more logic here
    });

Arguments

id {Object|string} - The id to convert.

var repo = BaseRepo(collection, schema),
    _id = repo.createNewId(),
    idString = repo.convertId(_id);

typeof idString === 'string'; // true

var repo = BaseRepo(collection, schema),
    _id = repo.createNewId();

_id instanceof ObjectID === true; // true

Arguments

query {Object|function(err, res)=} - The query.
options {Object|function(err, res)=} - The options object or the callback.
callback {!function(err, res)} - The callback function.

var repo = BaseRepo(collection, schema);

// count all
repo.count(function(err, res) {
    // more logic here
});

// count with query
repo.count({name: 'wayne'}, function(err, res) {
    // more logic here
});

// count all with options
repo.count({skip: 1, limit: 5}, function(err, res) {
    // more logic here
});

Arguments

query {Object|function(err, res)=} - The query.
options {Object|function(err, res)=} - The mongoDb query options.
options.fields {(Array|Object)=} - The fields which should be returned by the query.
options.limit {Number=} - The number of records which should be returned by the query.
options.skip {Number=}- The number of records which should be skipped by the query.
options.sort {(Array|String|Object)=} - The sorting of the returned records.
callback {!function(err, res)} - The callback function.

var repo = BaseRepo(collection, schema);

// find all
repo.find(function(err, res) {
    // more logic here
});

// find and convert mongo-id
repo.find({_id: '511106fc574d81d815000001'}, function(err, res) {
    // more logic here
});

// find with query
repo.find({name: 'Litixsoft'}, {skip: 0, limit: 10, sort: {name: 1}, fields: ['name', 'city']}, function(err, res) {
    // more logic here
});

// find all with options
repo.find({skip: 0, limit: 10, sort: {name: 1}, fields: ['name', 'city']}, function(err, res) {
    // more logic here
});

Arguments

query {!Object} - The query.
options {Object|function(err, res)=} - The mongoDb query options or the callback.
options.fields {(Array|Object)=} - The fields which should be returned by the query.
options.limit {Number=} - The number of records which should be returned by the query.
options.skip {Number=}- The number of records which should be skipped by the query.
options.sort {(Array|String|Object)=} - The sorting of the returned records.
callback {!function(err, res)} - The callback function.

var repo = BaseRepo(collection, schema);

repo.findOne({name: 'Litixsoft'}, function(err, res) {
    // more logic here
});

repo.findOne({name: 'Litixsoft'}, {skip: 0, limit: 10, sort: {name: 1}, fields: ['name', 'city']}, function(err, res) {
    // more logic here
});

Arguments

id {!Object|string} - The id.
options {Object|function(err, res)} - The mongoDb query options or the callback.
options.fields {(Array|Object)=} - The fields which should be returned by the query.
callback {!function(err, res)} - The callback function.

var repo = BaseRepo(collection, schema),
    myId = repo.convertId('5108e9333cb086801f000035');

repo.findOneById('5108e9333cb086801f000035', function(err, res) {
    // more logic here
});

repo.findOneById(myId, {fields: ['name', 'city']}, function(err, res) {
    // more logic here
});

var repo = BaseRepo(collection, schema),
    myCollection = repo.getCollection();

collection == myCollection; // true

var repo = BaseRepo(collection, schema),
    mySchema = repo.getSchema();

schema == mySchema; // true

var repo = BaseRepo(collection, schema),
    options = repo.getValidationOptions();

options.deleteUnknownProperties === true; // true
typeof options.convert === 'function'; // true

Arguments

doc {!Object|!Array} - The document/s.
options {Object|function(err, res)=} - The options object or the callback.
callback {function(err, res)=} - The callback function.

var repo = BaseRepo(collection, schema);

// insert
repo.insert({name: 'Litixsoft', city: 'Leipzig'});

// insert with callback
repo.insert({name: 'Litixsoft', city: 'Leipzig'}, function(err, res) {
    // more logic here
});

// insert with options and callback
repo.insert({name: 'Litixsoft'}, {w: 1}, function(err, res) {
    // more logic here
})

Arguments

query {Object=} - The query.
options {Object=} - The mongo options.
callback {function(err, res)=} - The callback function.

var repo = BaseRepo(collection, schema);

// remove all
repo.remove();

// remove with callback and coverting of mongo-id
repo.remove({_id: '5108e9333cb086801f000035'}, function(err, res) {
    // more logic here
});

// remove with options
repo.remove({city: 'Berlin'}, {w: 1}, function(err, res) {
    // more logic here
});

Arguments

query {!Object} - The query.
update {!Object} - The data to update.
options {Object=} - The options for multi update.
callback {!function(err, res)} - The callback function.

var repo = BaseRepo(collection, schema);

repo.update({_id: '5108e9333cb086801f000035'}, {name: 'Litixsoft GmbH'}, function(err, res) {
    // more logic here
});

repo.update({_id: '5108e9333cb086801f000035'}, {$set: {name: 'Litixsoft GmbH', city: 'Palo Alto'}}, function(err, res) {
    // more logic here
});

repo.update({}, {$set: {name: 'Litixsoft GmbH', city: 'Palo Alto'}}, {multi: true}, function(err, res) {
    // more logic here
});

GridFs base repository

Arguments

collection {!Object} - The mongoDb gridfs colllection.

var lxDb = require('lx-mongodb'),
    db = lxDb.GetDb('localhost:27017/blog?w=0&journal=True&fsync=True', ['posts', 'tags', 'comments'], ['documents']),
    documentsRepo = lxDb.GridFsBaseRepo(db.documents);

Arguments

id {Object|string} - The id to convert.

var repo = GridFsBaseRepo(collection),
    _id = repo.createNewId(),
    idString = repo.convertId(_id);

typeof idString === 'string'; // true

Arguments

id {Object|string} - The id of the file.
callback {function(err, res)} - The callback function.

var repo = GridFsBaseRepo(collection);

repo.delete('5108e9333cb086801f000035', function(err, res) {
    // more logic here
});

Arguments

id {Object|string} - The id of the file.
callback {function(err, res)} - The callback function.

var repo = GridFsBaseRepo(collection);

repo.get('5108e9333cb086801f000035', function(err, res) {
    // more logic here
});

var repo = GridFsBaseRepo(collection),
    myCollection = repo.getCollection();

collection == myCollection; // true
#### getValidationOptions()
Returns an object with the validation options. This is especially useful in combination with [lx-valid](https://github.com/litixsoft/lx-valid).
The method `convert()` can also be used by other schema validators.

```js
var repo = GridFsBaseRepo(collection),
    options = repo.getValidationOptions();

options.deleteUnknownProperties === true; // true
options.trim === true; // true
options.strictRequired === true; // true
typeof options.convert === 'function'; // true

Arguments

data {Object} - The buffer with the binary data of the file.
options {Object} - The options for the file.
callback {function(err, res)} - The callback function.

var repo = GridFsBaseRepo(collection);

repo.put(new Buffer('Litixsoft'), {metadata: {'type': 'string'}}, function(err, res) {
    // more logic here
});

Contributing

In lieu of a formal styleguide take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Please create descriptive commit messages. We use a git hook to validate the commit messages against these rules. Lint and test your code using grunt.

Author

Litixsoft GmbH

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

lx-mongodb

Install

Documentation

Examples

Simple query

Simple repository with JSON schema

Repository with validation

API

Database connection

Base repository

Gridfs base repository

Database connection

Base repository

GridFs base repository

Contributing

Author

License