Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konsultaner/jsonOdm
A JSON ODM (object document mapper) for JavaScript to use on the server or in the browser.
https://github.com/konsultaner/jsonOdm
database document-mapper javascript json odm
Last synced: 3 months ago
JSON representation
A JSON ODM (object document mapper) for JavaScript to use on the server or in the browser.
- Host: GitHub
- URL: https://github.com/konsultaner/jsonOdm
- Owner: konsultaner
- License: mit
- Created: 2015-03-10T21:46:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T13:21:37.000Z (over 1 year ago)
- Last Synced: 2024-03-24T07:02:39.518Z (8 months ago)
- Topics: database, document-mapper, javascript, json, odm
- Language: JavaScript
- Size: 2.24 MB
- Stars: 101
- Watchers: 14
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
- awesome-json - JSON ODM - Object document mapper for JavaScript to use on the server or in the browser. (Javascript) (Databases)
README
[](https://travis-ci.org/konsultaner/jsonOdm)
[](https://codeclimate.com/github/konsultaner/jsonOdm)
[](https://codeclimate.com/github/konsultaner/jsonOdm/coverage)
[](https://www.npmjs.com/package/json-odm)
[](https://www.npmjs.com/package/json-odm)
[](https://www.npmjs.com/package/json-odm)
[](https://github.com/konsultaner/jsonOdm/stargazers)
[](https://github.com/konsultaner/jsonOdm/issues)
JSON ODM
========
by [Konsultaner](http://www.konsultaner.de), Richard Burkhardt
-------------
This Project aims to be provide a json object document mapper.
**Why would I need this?**
There are many cases where you do not want to have the server query your data. You may also see this mapper as a fancy way to filter your data or prepare a view model.
The original use case was an [ionic](http://ionicframework.com) app that was not interactive so providing a server backend was not needed, but structuring my data
into joinable collections seemed very helpful.
And if you can use a server you may consider our new [WebSocket server project "connectanum"](http://www.connectanum.com) for Publish/Subscribe and RPC communication
If you like the project please support it with a star here on [GitHub](https://github.com/konsultaner/jsonOdm)
If commercial support is needed please [contact me](mailto:[email protected]).
Docs
----
You can find the [documentation here](https://rawgit.com/konsultaner/jsonOdm/master/docs/gen/0.2/index.html) or compiled to the folder [/docs/gen/*](https://github.com/konsultaner/jsonOdm/blob/master/docs/gen/index.html).
Road map
----
- [ ] Implement query methods from [mongo db](http://docs.mongodb.org/manual/reference/operator/query/)
- [x] Comparison 100%
- [x] $eq
- [x] $gt
- [x] $gte
- [x] $lt
- [x] $lte
- [x] $ne
- [x] $in
- [x] $nin
- [x] Logical 100%
- [x] $or
- [x] $and
- [x] $not(= $nand as alias)
- [x] $nor
- [x] Element 100% (+ $isNull, for is null or undefined)
- [x] $exists
- [x] $type
- [x] Evaluation 100%
- [x] $mod
- [x] $regex
- [x] $text
- [x] $where
- [x] Geospatial 50% (maybe have a hard and a soft check -> performance)
- [x] $geoWithin
- [x] $geoIntersects
- [ ] $near
- [ ] $nearSphere
- [ ] Array 0% i may not implement the first two
- [ ] $all
- [ ] $elementMatch
- [ ] $size
- [ ] Aggregation
- [ ] Pipeline 30% ($limit and $skip is implemented as $result(skip,limit))
- [x] $project
- [ ] $match
- [ ] $redact
- [x] $limit
- [x] $skip
- [ ] $unwind
- [ ] $sort
- [ ] $geoNear
- [ ] $out
- [ ] Grouping 70% ($count is used to count the results)
- [x] $group
- [x] $count
- [x] $sum
- [x] $avg
- [ ] $first
- [ ] $last
- [x] $min
- [x] $max
- [x] $push
- [ ] $addToSet
- [ ] Operators 20% ($mod is renamed $modulo, because Evaluation has a $mod)
- [ ] Boolean
- [ ] Set
- [ ] Comparison
- [x] Arithmetic
- [x] String
- [ ] Array
- [ ] Date
- [ ] Conditional
- [ ] Variable
- [ ] Grouping
- [ ] Support Promise/A+ sources for the odm.addSource
- [ ] Full CRUD support
- [ ] Aggregation
Install from NPM-Package
---------------------
```bash
npm install json-odm
```
Build and run tests, both minified and unminified
-------------------------------------------------
Since [PhantomJs has been archived](https://github.com/ariya/phantomjs/issues/15344), jsonOdm needed to switch to chrome
headless for its test. To run tests have Chrome installed!
```bash
npm install json-odm
cd npm_modules/json-odm/
npm install
gulp
```
Browser Support
---------------
Unit test ran successfully under Chrome,iOS7+,IE9+,Firefox,Android 4.4.2+
To be tested: Safari on OSX, IE8(test driver does not run in IE < 9 so it will be hard to test)
Example
------
This is only a basic example. Find a lot more in the [docs](https://rawgit.com/konsultaner/jsonOdm/master/docs/gen/index.html), i.e. how to use [$geoWithin](https://rawgit.com/konsultaner/jsonOdm/master/docs/gen/jsonOdm.Query.html#__geoWithin__anchor)
```html
```
```javascript
// initialize The mapper
var odm = new jsonOdm();
// add a source to the mapper
odm.addSource('people',{
"Person" : [
{"id":1,"name":"Richi",jobId:1,hobbyIds:[1,3,4]},
{"id":2,"name":"Dave",jobId:2,hobbyIds:[2,4]},
{"id":3,"name":"Tom",jobId:3,hobbyIds:[3,5]},
{"id":4,"name":"Lisa",jobId:4,hobbyIds:[1,2,3]},
{"id":5,"name":"Hanni",jobId:3,hobbyIds:[1,5]},
{"id":6,"name":"Selma",jobId:3,hobbyIds:[1,4]},
{"id":7,"name":"Ralf",jobId:1,hobbyIds:[4,3]}
],
"Jobs" : [
{"id":1,"name":"plumber"},
{"id":2,"name":"programmer"},
{"id":3,"name":"chef"},
{"id":4,"name":"hairdresser"}
],
"Hobbies" : [
{"id":1,"name":"swimming"},
{"id":2,"name":"cycling"},
{"id":3,"name":"fishing"},
{"id":4,"name":"coding"},
{"id":5,"name":"dancing"}
]
},true);
// instantiate a collection object
var people = new odm.Collection('Person');
people.$hasOne("jobId","id","Jobs","job");
people.$hasMany("hobbyIds","id","Hobbies","hobbies");
var q = people.$query();
// get all hairdresser and plumber
var hairdresser = q.$or(
q.$branch("jobId").$eq(1),
q.$branch("jobId").$eq(4)
).$all();
// get all but hairdressers and plumbers
var hairdresser = q.$and(
q.$branch("jobId").$ne(1),
q.$branch("jobId").$ne(4)
).$all();
// delete all plumbers
q.$branch("job","name").$eq("plumber").$delete();
```