sloki

Sloki (WORK IN PROGRESS)

A NodeJS Server for LokiJS

Overview

Sloki make LokiJS scalable.

• It embed LokiJS
• It expose a JSONRPC API, thanks to Jayson
• It WILL support TCP/TLS
• It MAY support HTTP/HTTPS

                                          JSONRPC (jayson)
                                         TCP|TLS|HTTP|HTTPS

        +----------------------------+                         +----------------------------------+
        |                            |                         |          sloki           |
        |       NodeJS Daemon        |<----------------------->|        (Local or Remote)         |
        |                            |                         |                                  |
        +----------------------------+                         |    +------------------------+    |
                                                               |    |                        |    |
        +----------------------------+                         |    |                        |    |
        |                            |                         |    |                        |    |
        |       NodeJS Daemon        |<----------------------->|    |         LokiJS         |    |
        |                            |                         |    |       (database)       |    |
        +----------------------------+                         |    |                        |    |
                                                               |    |                        |    |
        +----------------------------+                         |    +------------------------+    |
        |                            |                         |                                  |
        |           CLI              |<----------------------->|                                  |
        |                            |                         |                                  |
        +----------------------------+                         +----------------------------------+

---

Installation

• npm install -g sloki

Usage

• sloki
• sloki --help

---

Client

See https://github.com/sloki-project/sloki-node-client

Benchmarks

See https://github.com/sloki-project/sloki-benchs

Development status

Legends

Icon	Description
:heavy_check_mark:	implemented
:heavy_plus_sign:	in progress/MUST be implemented
:red_circle:	does NOT make sens in sloki, will NOT be implemented
:question:	MAY be implemented

Transports

Status	Transport	Notes
:heavy_check_mark:	TCP	Persistant connection
:heavy_plus_sign:	TLS	Persistant connection
:question:	HTTP
:question:	HTTPS

Methods: client and server related

Status	Command	Parameter	Description
:heavy_check_mark:	quit		disconnect (TCP/TLS clients only)
:heavy_check_mark:	shutdown		shutdown sloki
:heavy_check_mark:	memory		return sloki memory usage
:heavy_check_mark:	clients		return TCP/TLS connected clients
:heavy_check_mark:	maxClients		return TCP/TLS maxClients
:heavy_check_mark:	maxClients	maxClients	set TCP/TLS maxClients
:heavy_check_mark:	commands		return available commands

Methods: database related

Loki Class (Database) documentation

Status	Command	Parameter(s)	Description
:heavy_check_mark:	loadDatabase	databaseName,[options]	select (and load if needed) a database
:heavy_check_mark:	db		return current database name (sloki specific)
:heavy_check_mark:	listDatabases		return available databases
:heavy_check_mark:	saveDatabase		trigger manual saving of the selected database
:heavy_check_mark:	listCollections		return available collections in selected database
:heavy_check_mark:	addCollection	options	add a collection in selected database
:heavy_check_mark:	getCollection	collectionName	return collection properties in selected database
:heavy_plus_sign:	removeCollection	collectionName	removes a collection from the selected database
:heavy_plus_sign:	renameCollection	oldName, newName	renames an existing collection in the selected database
:question:	clearChanges		clears all the changes in all collections of selected database
:question:	close		close selected database
:question:	configureOptions	options	reconfigure selected database options
:question:	copy	options	copy selected database into a new Loky instance
:question:	deleteDatabase		delete selected database
:question:	getCollection	collectionName	Retrieves reference to a collection by name
:red_circle:	deserializeCollection		see LokiJS Class documentation
:red_circle:	deserializeDestructured		see LokiJS Class documentation
:red_circle:	generateChangesNotification		see LokiJS Class documentation
:red_circle:	loadDatabase		see "use" command
:red_circle:	loadJSON		see LokiJS Class documentation
:red_circle:	loadJSONObject		see LokiJS Class documentation
:red_circle:	serialize		see LokiJS Class documentation
:red_circle:	serializeChanges		see LokiJS Class documentation
:red_circle:	serializeCollection	options	see LokiJS Class documentation
:red_circle:	serializeDestructured	options	see LokiJS Class documentation
:red_circle:	throttledSaveDrain		see LokiJS Class documentation

Methods: collection related

Loki Collection documentation

Status	Command	Parameter(s)	Description
:heavy_check_mark:	get	collectionName, lokiId	return a document by his id
:heavy_check_mark:	insert	collectionName, document	insert a document
:heavy_check_mark:	update	collectionName, document	update a document
:heavy_check_mark:	remove	collectionName, document or id	remove a document
:heavy_check_mark:	find	collectionName, filter	find document(s)

Benchmarks

Status	Transport	Notes
:heavy_plus_sign:	TCP	Persistant connection
:heavy_plus_sign:	TLS	Persistant connection
:question:	HTTP
:question:	HTTPS

Tools

Status	Tool	Notes
:heavy_plus_sign:	CLI	CLI using TCP transport

Improvements on top of LokiJS

Status	Improvement	Notes
:heavy_plus_sign:	Authentication	Optional authentication layer (all transports)

---

Server options

TODO

Changelog

0.0.6 - 2019-02-09

Added

• add method wait for testing purpose (one sec)

Changed

• fix db is not sticked to tcp session if db already exists #17
• improve find filters #18