modokDB
In-memory Database
modokDB is a small high performant in-memory database powered by JavaScript Maps (supports Node, Electron and the browser)
The Problem
You are looking for a database that is simple and without any dependencies to install.
The Solution
modokDB is a high performant and convenient method for storing data without setting up a database server. It is fast and excellent to be used as an embedded database.
Installation
This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies
:
npm install --save modokdb
Alternatively, if you're using yarn
yarn add modokdb
A UMD build is also available on unpkg for testing and quick prototyping:
Usage
Without file storage:
const Modok = ;const db = 'users';
With file storage:
const Modok = ;const db = 'users' filepath: './data/users' filename: 'database' ; dbready;
db.has - Synchronous (returns true / false)
const isAvailable = db;
db.$has - Asynchronous (returns true / false)
db;
db.insert - Synchronous (returns database entry)
const user = db;console
db.insert - Synchronous (returns database entries)
const users = db;console
db.$insert - Asynchronous (returns database entry)
db;
db.$insert - Asynchronous (returns database entries)
db;
db.insertOne - Synchronous (returns database entry / entries)
const user = db;console
db.$insertOne - Asynchronous (returns database entry / entries)
db;
db.insertMany - Synchronous (returns database entry / entries)
const users = db;console
db.$insertMany - Asynchronous (returns database entry / entries)
db;
db.find - Synchronous (_returns database entry / null)
const users = db;console
db.$find - Asynchronous (_returns database entry / null)
db;
db.findOne - Synchronous (_returns database entry / null)
const users = db;console
db.$findOne - Asynchronous (_returns database entry / null)
db;
db.findOneAndDelete - Synchronous (_returns database entry / null)
const users = db;console
db.$findOneAndDelete - Asynchronous (_returns database entry / null)
db;
db.update - Synchronous (_returns database entry / null)
const updatedUsers = db;console
db.$update - Asynchronous (_returns database entry / null)
db;
db.update - upsert : true - Synchronous (_returns database entry / null)
const updatedUsers = db;console
db.$update - upsert : true - Asynchronous (_returns database entry / null)
db;
db.updateOne - Synchronous (_returns database entry / null)
const updatedUser = db;console
db.$updateOne - Asynchronous (_returns database entry / null)
db;
db.updateMany - Synchronous (_returns database entry / null)
const updatedUsers = db;console
db.$updateMany - Asynchronous (_returns database entry / null)
db;
db.count - Synchronous (returns integer)
const count = db;console;
db.$count - Asynchronous (returns integer)
db;
db.drop - Synchronous (returns empty object)
db;
db.$drop - Asynchronous (returns empty object)
db;
db.delete - Synchronous (returns true / false)
db;
db.$delete - Asynchronous (returns true / false)
db;
db.deleteOne - Synchronous (returns true / false)
db;
db.$deleteOne - Asynchronous (returns true / false)
db;
db.deleteOne - Synchronous (returns true / false)
db;
db.$deleteOne - Asynchronous (returns true / false)
db;
db.deleteOneById - Synchronous (returns true / false)
db;
db.$deleteOne - Asynchronous (returns true / false)
db;
db.stats - Synchronous (returns object)
const db = 'users' filepath: './data/users' filename: 'database' ;const stats = db;console;
db.$stats - Asynchronous (returns object)
const db = 'users' filepath: './data/users' filename: 'database' ; db;
Collection Reference
# File: 1const db = 'users' filepath: './data/users' filename: 'database' ; # File: 2const usersRef = ;const results = usersRef;console;
db.renameCollection - Synchronous (returns collection reference)
const db = 'users';const newDB = db;console;
db.$renameCollection - Asynchronous (returns collection reference)
const db = 'users'; db;
Contributors
Kai Wedekind |
Thomas Reinecke |
LICENSE
MIT