Skip to content
MongoDB adapter for Sails.js / Waterline ORM.
Branch: master
Clone or download
mikermcneil Merge pull request #478 from luislobo/docker-enhancements
Add docker-test to ease tests in one single run
Latest commit 3c0388c Nov 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Fix issue with aggregation with MongoDB version >=3.4. Now the cursor… Nov 4, 2018
test Bump etcs May 6, 2018
.editorconfig Add boilerplate and set package.json back to current version so we ca… Dec 10, 2016
.eslintrc Bump etcs May 6, 2018
.gitignore Update boilerplate Oct 1, 2017
.jshintrc Update boilerplate Oct 1, 2017
.npmignore Add boilerplate and set package.json back to current version so we ca… Dec 10, 2016
.travis.yml Removed Node 4 as it is EOL (https://github.com/nodejs/Release) Nov 4, 2018
CHANGELOG.md Fix issue with aggregation with MongoDB version >=3.4. Now the cursor… Nov 4, 2018
Dockerfile setup docker file for running tests Feb 7, 2016
README.md Add docker-test to ease tests in one single run Nov 4, 2018
appveyor.yml
docker-compose.yml Fix issue with aggregation with MongoDB version >=3.4. Now the cursor… Nov 4, 2018
package.json Add docker-test to ease tests in one single run Nov 4, 2018

README.md

Node.js and MongoDB on Sails.js/Waterline

sails-mongo

Sails.js/Waterline adapter for MongoDB.

Provides easy access to MongoDB from Sails.js & Waterline. This module is a Sails/Waterline adapter maintained by the core team. Its goal is to provide robust, easy-to-use access to MongoDB from Sails.js and Waterline.

As an adapter, this module implements a set of declarative interfaces, conventions, and best-practices for integrating with Mongo databases. Strict adherence to an adapter specification enables the (re)use of built-in generic test suites, standardized documentation, reasonable expectations around the API for your users, and overall, a more pleasant development experience for everyone.

Installation

To install this adapter, run:

$ npm install sails-mongo

Then connect the adapter to one or more of your app's datastores.

Usage

Visit Models & ORM in the docs for more information about using models, datastores, and adapters in your app/microservice.

Compatibility

This adapter implements the following methods:

Method Status Layer
registerDatastore Implemented N/A
teardown Implemented N/A
validateModelDef Implemented Modeled
createRecord Implemented Modeled (DML)
createEachRecord Implemented Modeled (DML)
updateRecords Implemented Modeled (DML)
destroyRecords Implemented Modeled (DML)
findRecords Implemented Modeled (DQL)
join not supported Modeled (DQL)
countRecords Implemented Modeled (DQL)
sumRecords Implemented Modeled (DQL)
avgRecords Implemented Modeled (DQL)
definePhysicalModel Implemented Migratable
dropPhysicalModel Implemented Migratable
setPhysicalSequence not supported Migratable

Questions?

See Extending Sails > Adapters > Custom Adapters in the Sails documentation, or check out recommended support options.

Contributing   Build Status   Build status on Windows

Please observe the guidelines and conventions laid out in the Sails project contribution guide when opening issues or submitting pull requests.

NPM

This repository includes a Docker Compose file that helps setting up the environment needed to run the test.

The npm run docker-test command runs the tests on a single run under the supported MongoDB version (at this time, up to 3.4). For more information, check MongoDB's Support Policy.

To run tests while developing, you can run npm run docker. This command opens a docker instance and opens a shell. From there you can run npm test to run the tests as many times as you need.

Special thanks

Thanks so much to Ted Kulp (@tedkulp) and Robin Persson (@prssn) for building the first version of this adapter back in 2013. Since then, it has evolved into a core adapter within the framework.

Bugs   NPM version

To report a bug, click here.

License

This core adapter is available under the MIT license.

As for Waterline and the Sails framework? They're free and open-source under the MIT License.

© The Sails Co.

image_squidhome@2x.png

You can’t perform that action at this time.