| 1 | # LokiJS
|
| 2 |
|
| 3 | [](https://gitter.im/techfort/LokiJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 4 | 
|
| 5 | [](http://badge.fury.io/js/lokijs)
|
| 6 | [](http://packagequality.com/#?package=lokijs)
|
| 7 |
|
| 8 | ## Overview
|
| 9 |
|
| 10 | LokiJS is a document oriented database written in javascript, published under MIT License.
|
| 11 | Its purpose is to store javascript objects as documents in a nosql fashion and retrieve them with a similar mechanism.
|
| 12 | Runs in node (including cordova/phonegap and node-webkit), [nativescript](http://www.nativescript.org) and the browser.
|
| 13 | LokiJS is ideal for the following scenarios:
|
| 14 |
|
| 15 | 1. client-side in-memory db is ideal (e.g., a session store)
|
| 16 | 2. performance critical applications
|
| 17 | 3. cordova/phonegap mobile apps where you can leverage the power of javascript and avoid interacting with native databases
|
| 18 | 4. data sets loaded into a browser page and synchronised at the end of the work session
|
| 19 | 5. node-webkit desktop apps
|
| 20 | 6. nativescript mobile apps that mix the power and ubiquity of javascript with native performance and ui
|
| 21 |
|
| 22 | LokiJS supports indexing and views and achieves high-performance through maintaining unique and binary indexes (indices) for data.
|
| 23 |
|
| 24 | ## Demo
|
| 25 |
|
| 26 | The following demos are available:
|
| 27 | - [Sandbox / Playground](https://rawgit.com/techfort/LokiJS/master/examples/sandbox/LokiSandbox.htm)
|
| 28 | - a node-webkit small demo in the folder demos/desktop_app. You can launch it by running `/path/to/nw demos/desktop_app/`
|
| 29 |
|
| 30 | ## Wiki
|
| 31 |
|
| 32 | Example usage can be found on the [wiki](https://github.com/techfort/LokiJS/wiki)
|
| 33 |
|
| 34 | ## Main Features
|
| 35 |
|
| 36 | 1. Fast performance NoSQL in-memory database, collections with unique index (1.1M ops/s) and binary-index (500k ops/s)
|
| 37 | 2. Runs in multiple environments (browser, node, nativescript)
|
| 38 | 3. Dynamic Views for fast access of data subsets
|
| 39 | 4. Built-in persistence adapters, and the ability to support user-defined ones
|
| 40 | 5. Changes API
|
| 41 | 6. Joins
|
| 42 |
|
| 43 | ## Current state
|
| 44 |
|
| 45 | LokiJS is at version 1.3 [Eostre].
|
| 46 |
|
| 47 | As LokiJS is written in JavaScript it can be run on any environment supporting JavaScript such as browsers, node.js/node-webkit, nativescript mobile framework and hybrid mobile apps (such as phonegap/cordova).
|
| 48 |
|
| 49 | Made by [@techfort](http://twitter.com/tech_fort), with the precious help of Dave Easterday.
|
| 50 |
|
| 51 | _[Leave a tip](https://gratipay.com/techfort/) or give us a star if you find LokiJS useful!_
|
| 52 |
|
| 53 | ## Installation
|
| 54 |
|
| 55 | For browser environments you simply need the lokijs.js file contained in src/
|
| 56 |
|
| 57 | You can use bower to install lokijs with `bower install lokijs`
|
| 58 |
|
| 59 | For node and nativescript environments you can install through `npm install lokijs`.
|
| 60 |
|
| 61 | ## Roadmap
|
| 62 |
|
| 63 | * exactIndex
|
| 64 | * key-value datastore
|
| 65 | * MRU cache
|
| 66 | * MongoDB API compatibility
|
| 67 | * server standalone (tcp and http servers and clients)
|
| 68 | * replication and horizontal scaling
|
| 69 |
|
| 70 | ## Contact
|
| 71 |
|
| 72 | For help / enquiries contact joe.minichino@gmail.com
|
| 73 |
|
| 74 | ## Commercial Support
|
| 75 |
|
| 76 | For commercial support contact info.techfort@gmail.com
|
| 77 |
|
| 78 | ## License
|
| 79 |
|
| 80 | Copyright (c) 2015 TechFort <joe.minichino@gmail.com>
|
| 81 |
|
| 82 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
| 83 |
|
| 84 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
| 85 |
|
| 86 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
| 87 |
|