A NodeJS Server for LokiJS
Sloki make LokiJS scalable.
JSONRPC (jayson)
TCP|TLS|HTTP|HTTPS
+----------------------------+ +----------------------------------+
| | | sloki |
| NodeJS Daemon |<----------------------->| (Local or Remote) |
| | | |
+----------------------------+ | +------------------------+ |
| | | |
+----------------------------+ | | | |
| | | | | |
| NodeJS Daemon |<----------------------->| | LokiJS | |
| | | | (database) | |
+----------------------------+ | | | |
| | | |
+----------------------------+ | +------------------------+ |
| | | |
| CLI |<----------------------->| |
| | | |
+----------------------------+ +----------------------------------+
npm install -g slokislokisloki --helpSee https://github.com/sloki-project/sloki-node-client
See https://github.com/sloki-project/sloki-benchs
| 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 |
| Status | Transport | Notes |
|---|---|---|
| :heavy_check_mark: | TCP | Persistant connection |
| :heavy_plus_sign: | TLS | Persistant connection |
| :question: | HTTP | |
| :question: | HTTPS |
| 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 |
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 |
| 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) |
| Status | Transport | Notes |
|---|---|---|
| :heavy_plus_sign: | TCP | Persistant connection |
| :heavy_plus_sign: | TLS | Persistant connection |
| :question: | HTTP | |
| :question: | HTTPS |
| Status | Tool | Notes |
|---|---|---|
| :heavy_plus_sign: | CLI | CLI using TCP transport |
| Status | Improvement | Notes |
|---|---|---|
| :heavy_plus_sign: | Authentication | Optional authentication layer (all transports) |
TODO
FAQs
A NodeJS server for LokiJS
The npm package sloki receives a total of 1 weekly downloads. As such, sloki popularity was classified as not popular.
We found that sloki demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.