betajs-mongodb
v1.0.24
Published
BetaJS-MongoDB is a MongoDB wrapper for BetaJS.
Downloads
4
Readme
betajs-mongodb 1.0.24
BetaJS-MongoDB is a MongoDB wrapper for BetaJS.
Getting Started
You can use the library in your NodeJS project and compile it as well.
NodeJS
var BetaJS = require('betajs');
require('betajs-data');
require('betajs-mongodb');
Compile
git clone https://github.com/betajs/betajs-mongodb.git
npm install
grunt
Basic Usage
We provide a simple abstraction for databases and tables, with a concrete implementation for MongoDB.
First, you instantiate a database, e.g. a MongoDB:
var database = new BetaJS.Data.Databases.Mongo.MongoDatabase("mongodb://localhost/database");
The MongoDatabase
class inherits from the abstract Database
class.
Once you have a database
instance, you can access database tables / collections as follows:
var table = database.getTable('my-table-name');
A table
instance allows you to perform the typical (asynchronous) CRUD operations on the table:
table.insertRow({row data}).success(function (inserted) {...}).error(function (error) {...});
table.removeRow({remove query}).success(function () {...}).error(function (error) {...});
table.removeById(id).success(function () {...}).error(function (error) {...});
table.updateRow({update query}, {row data}).success(function (updated) {...}).error(function (error) {...});
table.updateById(id, {row data}).success(function (updated) {...}).error(function (error) {...});
table.find({search query}, {limit, skip, sort}).success(function (rowIterator) {...}).error(function (error) {...});
table.findOne({search query}, {skip, sort}).success(function (row) {...}).error(function (error) {...});
table.findById(id).success(function (row) {...}).error(function (error) {...});
In most cases, you would not access database table instances directly but through the abstraction of a store.
Database Stores allow you to access a database table through the abstract of a Store
, providing all the additional functionality from the BetaJS-Data
module.
Once you have instantiated your database
instance, you can create a corresponding Store
for a table as follows, e.g. for a MongoDB:
var store = new BetaJS.Data.Stores.DatabaseStore(database, "my-database-table");
Links
| Resource | URL | | :--------- | --: | | Homepage | https://betajs.com | | Git | git://github.com/betajs/betajs-mongodb.git | | Repository | https://github.com/betajs/betajs-mongodb | | Blog | https://blog.betajs.com | | Twitter | https://twitter.com/thebetajs |
Compatability
| Target | Versions | | :----- | -------: | | NodeJS | 4.0 - Latest |
CDN
| Resource | URL | | :----- | -------: | | betajs-mongodb.js | http://cdn.rawgit.com/betajs/betajs-mongodb/master/dist/betajs-mongodb.js | | betajs-mongodb.min.js | http://cdn.rawgit.com/betajs/betajs-mongodb/master/dist/betajs-mongodb.min.js | | betajs-mongodb-noscoped.js | http://cdn.rawgit.com/betajs/betajs-mongodb/master/dist/betajs-mongodb-noscoped.js | | betajs-mongodb-noscoped.min.js | http://cdn.rawgit.com/betajs/betajs-mongodb/master/dist/betajs-mongodb-noscoped.min.js |
Dependencies
| Name | URL | | :----- | -------: | | betajs | Open | | betajs-data | Open |
Weak Dependencies
| Name | URL | | :----- | -------: | | betajs-scoped | Open |
Main Contributors
- Oliver Friedmann
- Pablo Iglesias
License
Apache-2.0