ZincDB

Note: this library is frozen at an alpha stage, and its development has been discontinued.

ZincDB is a database and synchronization library for Javascript applications. Together with ZincServer, it aims to provide a comprehensive solution for the storage and management of in-application data. It can also be used on its own: as an in-browser, offline, or as a standalone embedded Node.js database.

Some of its features:

• Real-time synchronization and multi-user collaboration through a WebSocket or COMET connection with a ZincServer instance.
• Subscribe for updates for specific objects or values.
• Operates in a web-worker (browser) or child process (Node.js). Optimized for short loading times and minimal impact over the responsiveness of the hosting application.
• Pluggable storage engines. Currently supported: IndexedDB, WebSQL, Local Storage, Session Storage, In-memory, SQLite (in Node.js through node-sqlite3), LevelDB (in Node.js through LevelUP, which can also wrap RocksDB).

Learn more about the ZincBase framework's client and server design, capabilities and target use cases at the technical overview.

Status

The library and its API remain at an experimental stage, though there is an extensive (passing) test suite embedded in the code. Note that development has been discontinued due to time constraints and not expected to be resumed any time soon. However it's possible some of the code would be reused in the future for a simpler, less ambitious reboot of the library, but currently there is no schedule for when that might happen.

Note: the bundled test suite only runs correctly on Node.js v4.0 to v6.0.

Platform compatibility

Supports Chrome, Firefox, Edge, IE 10+, Opera, Android 4+, Safari 5.1+, Node.js 4+, Apache Cordova (not yet tested), nw.js (not yet tested), electron (not yet tested).

Installation

Node.js:

npm install zincdb

Browser (download):

<script id="zincdb" src="https://unpkg.com/zincdb"></script>

Minified version (download)

<script id="zincdb" src="https://unpkg.com/zincdb/production/zincdb.min.js"></script>

(To reference a specific library version use the pattern https://unpkg.com/zincdb@<version>)

Documentation

• Getting started
• API Reference
• Client API Reference
• Technical overview
• Contribution guide

For instructions on installing and configuring a server see the ZincServer getting started guide.

License

MIT