javascript embeddable / in-memory database
JavaScript HTML
Clone or download
Latest commit cbd8294 May 28, 2018
Permalink
Failed to load latest commit information.
benchmark #663 : optimized batched removes when chaining Mar 23, 2018
build #677: fixed issue where batch removes did not update unique index May 16, 2018
demos/desktop_app reworked demo app Jul 5, 2015
docs changed presentation theme Dec 20, 2014
examples updated changelog, fixes to examples, tutorials, added jsdocs for lis… Feb 1, 2018
jsdoc updated changelog, regenerated jsdocs, rebuilt minified May 10, 2018
spec cleaned up ambiguous unit test May 18, 2018
src #677: fixed issue where batch removes did not update unique index May 16, 2018
tutorials added $jbetween (simplified js comparison) to complete js range op set Feb 16, 2018
.editorconfig basic Object.observe based implementation for auto dirty checks Oct 3, 2015
.gitattributes added jsdoc folder Aug 11, 2017
.gitignore Updated web quickstarts for loki sandbox Jun 7, 2017
.jshintrc linting options, inc-adapter is es6 Jul 13, 2016
.npmignore Update .npmignore May 3, 2017
.travis.yml updating travis Dec 4, 2017
CHANGELOG.md Updated changelog in preparation for 1.5.5 release May 23, 2018
CONTRIBUTING.md Create CONTRIBUTING.md May 22, 2015
LICENSE.txt license Apr 22, 2015
OVERVIEW.md added jsdoc 'tutorials' based off gh wiki pages Apr 5, 2016
README.md Fix / Improve README Dec 27, 2017
benchmark.html Make the tests run in a browser Mar 26, 2015
bower.json Corrections to bower file Jul 30, 2015
jsdoc-conf.json #514 : Standardized collection findAndUpdate, findAndRemove, updateWh… Dec 3, 2016
karma.build.conf.js #663 : fix and optimize binary indices when batch removes are involved Mar 31, 2018
karma.conf.js #663 : fix and optimize binary indices when batch removes are involved Mar 31, 2018
package-lock.json #663 : fix and optimize dynamic views when batch removes are involved Mar 30, 2018
package.json bump May 28, 2018

README.md

LokiJS

Join the chat at https://gitter.im/techfort/LokiJS alt CI-badge npm version alt packagequality

Overview

LokiJS is a document oriented database written in javascript, published under MIT License. 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), nativescript and the browser. LokiJS is ideal for the following scenarios:

  1. client-side in-memory db is ideal (e.g., a session store)
  2. performance critical applications
  3. cordova/phonegap mobile apps where you can leverage the power of javascript and avoid interacting with native databases
  4. data sets loaded into a browser page and synchronised at the end of the work session
  5. node-webkit desktop apps
  6. nativescript mobile apps that mix the power and ubiquity of javascript with native performance and ui

LokiJS supports indexing and views and achieves high-performance through maintaining unique and binary indexes (indices) for data.

Demo

The following demos are available:

  • Sandbox / Playground
  • a node-webkit small demo in the folder demos/desktop_app. You can launch it by running /path/to/nw demos/desktop_app/

Wiki

Example usage can be found on the wiki

Main Features

  1. Fast performance NoSQL in-memory database, collections with unique index (1.1M ops/s) and binary-index (500k ops/s)
  2. Runs in multiple environments (browser, node, nativescript)
  3. Dynamic Views for fast access of data subsets
  4. Built-in persistence adapters, and the ability to support user-defined ones
  5. Changes API
  6. Joins

Current state

LokiJS is at version 1.3 [Eostre].

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).

Made by @techfort, with the precious help of Dave Easterday.

Leave a tip or give us a star if you find LokiJS useful!

Installation

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 and nativescript environments you can install through npm install lokijs.

Roadmap

  • exactIndex
  • key-value datastore
  • MRU cache
  • MongoDB API compatibility
  • server standalone (tcp and http servers and clients)
  • replication and horizontal scaling

Contact

For help / enquiries contact joe.minichino@gmail.com

Commercial Support

For commercial support contact info.techfort@gmail.com

License

Copyright (c) 2015 TechFort joe.minichino@gmail.com

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.