This module provides adapter for the Mongo datasource for integration with Modli.
npm install modli-mongo --save
When defining a property which will utilize the adapter it is required that a
collection
be supplied:
import { model, adapter, Joi, use } from 'modli';
import mongo from 'modli-mongo';
model.add({
name: 'foo',
version: 1,
collection: 'fooCollection'
schema: {
id: Joi.number().integer(),
fname: Joi.string().min(3).max(30),
lname: Joi.string().min(3).max(30),
email: Joi.string().email().min(3).max(254).required()
}
});
Then add the adapter as per usual with the following config object structure:
adapter.add({
name: 'mongoFoo',
source: mongo
config: {
host: {HOST_IP},
port: {HOST_PORT},
username: {USERNAME},
password: {PASSWORD},
database: {DATABASE}
}
});
You can then use the adapter with a model via:
// Use(MODEL, ADAPTER)
const mongoTest = use('foo', 'mongoFoo');
The following methods exist natively on the Mongo adapter:
Allows for executing methods directly on the collection:
mongoTest.execute('insert', { /*...record...*/ })
.then(/*...*/)
.catch(/*...*/);
Ensures (or waits for) established connection:
mongoTest.checkConn()
.then(/*...*/);
Note: the checkConn
method is already utilized by all other methods
and only needs to be added in a case where you're extending
on or using a method of the db
object directly.
Creates the collection based on the model's collection
name:
mongoTest.createCollection()
.then(/*...*/)
.catch(/*...*/);
Creates a new record based on object passed:
mongoTest.create({
fname: 'John',
lname: 'Smith',
email: 'jsmith@gmail.com'
})
.then(/*...*/)
.catch(/*...*/);
Returns records matching a query object (or all if no query specified):
mongoTest.read({ fname: 'John' })
.then(/*...*/)
.catch(/*...*/);
Updates record(s) based on query and body:
mongoTest.update({ fname: 'John' }, {
fname: 'Bob',
email: 'bsmith@gmail.com'
})
.then(/*...*/)
.catch(/*...*/);
Deletes record(s) based on query:
mongoTest.delete({ fname: 'John' })
.then(/*...*/)
.catch(/*...*/);
Extends the adapter to allow for custom methods:
mongoTest.extend('myMethod', () => {
/*...*/
});
The Mongo adapter requires the following environment variables to be set for running the tests. These should be associated with the Mongo instance running locally.
MODLI_MONGO_HOST,
MODLI_MONGO_PORT,
MODLI_MONGO_USERNAME,
MODLI_MONGO_PASSWORD,
MODLI_MONGO_DATABASE
This repository includes a base container config for running locally which is located in the /docker directory.
A Makefile
is included for managing build and install tasks. The commands are
then referenced in the package.json
scripts
if that is the preferred
task method:
all
(default) will run all build tasksstart
will run the main scriptclean
will remove the/node_modules
directoriesbuild
will transpile ES2015 code in/src
to/build
test
will run all spec files in/test/src
test-cover
will run code coverage on all testslint
will lint all files in/src
Running make test
will run the full test suite. Since adapters require a data
source if one is not configured the tests will fail. To counter this tests are
able to be broken up.
Test Inidividual File
An individual spec can be run by specifying the FILE
. This is convenient when
working on an individual adapter.
make test FILE=some.spec.js
The FILE
is relative to the test/src/
directory.
Deploys
For deploying releases, the deploy TAG={VERSION}
can be used where VERSION
can be:
<newversion> | major | minor | patch | premajor
Both make {COMMAND}
and npm run {COMMAND}
work for any of the above commands.
Modli-Mongo is licensed under the MIT license. Please see LICENSE.txt
for full details.
Modli-Mongo was designed and created at TechnologyAdvice.