Description
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 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" for Publish/Subscribe and RPC communication
If you like the project please support it with a star here on GitHub
If commercial support is needed please contact me.
JSON ODM alternatives and similar libraries
Based on the "Storage" category.
Alternatively, view jsonOdm alternatives based on common mentions on social networks and blogs.
-
localForage
๐พ Offline storage, improved. Wraps IndexedDB, WebSQL, or localStorage using a simple but powerful API. -
js-cookie
A simple, lightweight JavaScript API for handling browser cookies -
jquery-cookie
A simple, lightweight jQuery plugin for reading, writing and deleting cookies. -
store.js
Cross-browser storage for all use cases, used across the web. -
NeDB
The JavaScript Database, for Node.js, nw.js, electron and the browser -
WatermelonDB
๐ Reactive & asynchronous database for powerful React and React Native apps โก๏ธ -
Lovefield
Lovefield is a relational database for web apps. Written in JavaScript, works cross-browser. Provides SQL-like APIs that are fast, safe, and easy to use. -
basket.js
A script and resource loader for caching & loading files with localStorage -
cookies.js
๐ซ Tastier cookies, local, session, and db storage in a tiny package. Includes subscribe() events for changes. -
jStorage
jStorage is a simple key/value database to store data on browser side -
DB.js
db.js is a wrapper for IndexedDB to make it easier to work against -
awesome-web-storage
:sunglasses: Everything you need to know about Client-side Storage. -
Hadmean
Generate powerful admin apps in seconds with just `npx hadmean`. Stop building and maintaining admin apps that you can auto-generate. -
datavore
A small, fast, in-browser database engine written in JavaScript. -
crumbsjs
A lightweight vanilla ES6 cookies and local storage JavaScript library -
proxy-web-storage
Keep the type of storage value unchanged and change array and object directly. Supports listening to the changes and setting expires.
Appwrite - The Open Source Firebase alternative introduces iOS support
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of JSON ODM or a related project?
Popular Comparisons
README
JSON ODM
by Konsultaner, 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 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" for Publish/Subscribe and RPC communication
If you like the project please support it with a star here on GitHub
If commercial support is needed please contact me.
Docs
You can find the documentation here or compiled to the folder /docs/gen/*.
Road map
- [ ] Implement query methods from mongo db
- [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
- [ ] Pipeline 30% ($limit and $skip is implemented as $result(skip,limit))
- [x] Comparison 100%
- [ ] Support Promise/A+ sources for the odm.addSource
- [ ] Full CRUD support
- [ ] Aggregation
Install from NPM-Package
npm install json-odm
Build and run tests, both minified and unminified
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, i.e. how to use $geoWithin
<!-- add minified version from https://github.com/konsultaner/jsonOdm/tree/master/bin to the html head -->
<script type="text/javascript" src="js/json.odm.min.js"></script>
// 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();