LokiJS is a document oriented database written in javascript. Its purpose is to store javascript objects as documents in a nosql fashion and retrieve them with a similar mechanism. Runs in node (including cordova/phonegap and node-webkit) and the browser. LokiJS is ideal for the following scenarios:
- where a lightweight in-memory db is ideal (e.g., a session store)
- cordova/phonegap mobile apps where you can leverage the power of javascript and avoid interacting with native databases
- data sets loaded into a browser page and synchronised at the end of the work session
- node-webkit desktop apps
LokiJS supports indexing and views and achieves high-performance through maintaining a binary-index for data.
The following demos are available:
- [Sandbox / Playground] (https://rawgit.com/techfort/LokiJS/master/examples/sandbox/LokiSandbox.htm)
- a node-webkit small demo in the folder demos/desktop_app. You can launch it by running `/path/to/nw demos/desktop_app/'
Example usage can be found on the wiki
- Fast performance NoSQL in-memory database, collections with binary-index
- Runs in multiple environments (browser, node)
- Dynamic Views for fast access of data subsets
- Built-in persistence adapters, and the ability to support user-defined ones
- Changes API
LokiJS is at version 1.2 [Schnee]. While the roadmap is exciting, LokiJS is at the moment stable. As LokiJS is written in Javascript it can be run on any environment supporting javascript such as browsers, node.js/node-webkit, and hybrid mobile apps (such as phonegap/cordova).
Made by @techfort, with the precious help of Dave Easterday. Leave a tip or give us a star if you find LokiJS useful!
For browser environments you simply need the lokijs.js file contained in src/
You can use bower to install lokijs with bower install lokijs
For node environments you can install through npm install lokijs.
- key-value datastore
- MRU cache
- MongoDB API compatibility
- server standalone (tcp and http servers and clients)
- replication and horizontal scaling
For help / enquiries contact joe.minichino@gmail.com
Copyright (c) 2015, Joe Minichino joe.minichino@gmail.com All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by TechFort.
- Neither the name of TechFort nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.