Skip to content

Latest commit

 

History

History
177 lines (123 loc) · 4.42 KB

README.md

File metadata and controls

177 lines (123 loc) · 4.42 KB
Raw

LevelDB

npm pipeline license downloads

Gitlab Github Twitter Discord

Provides a convenient wrapper around LevelDB for both server-side and client-side JavaScript. Extending basic LevelDB functionality, integrating seamlessly with emitted events and enabling a more straightforward and modular approach for database operations.

Features

  • Singleton pattern for database instances
  • Easy-to-use asynchronous APIs
  • Stream support for read and write operations
  • Sub-levels for better data organization
  • Custom encoding/decoding options
  • Event emission and handling
  • Batch operations

Installation

Install the package with:

npm install @plaindb/leveldb

Usage

First, import the LevelDB library.

import LevelDB from '@plaindb/leveldb'

or

const LevelDB = require('@plaindb/leveldb')

Initialization

You can initialize a LevelDB instance as follows:

const db = new LevelDB({
  dbName: 'myDatabase',
  dbPrefix: 'prefix',
  reset: true,
  separator: '!',
  keyEncoding: 'utf8',
  valueEncoding: 'msgpack'
})

Constructor Options

When instantiating a LevelDB object, you can pass an options object as follows:

  • dbName: (string) The name of the LevelDB database. Default is '.db'.
  • dbPrefix: (string) A prefix to be used before the dbName. Default is '' (empty string).
  • client: (object) Custom Level client. If not provided, a new Level client will be created.
  • reset: (boolean) If true, clears the database on instantiation. Default is false.
  • separator: (string) The separator used for key names. Default is '!'.
  • keyEncoding: (string | object) Encoding for keys. Default is 'utf8'.
  • valueEncoding: (string | object) Encoding for values. Default is 'msgpack'.

Putting Data

To insert data into the LevelDB database:

await db.put('key', 'value')

Getting Data

To retrieve data from the database:

const value = await db.get('key')

Deleting Data

To delete data:

await db.del('key')

Stream Operations

For large datasets, you can use streaming:

const readStream = db.createReadStream()
readStream.on('data', data => {
  console.log(data)
})

Sub-levels

You can create sub-levels for better data organization:

const subDB = db.sub('subPath')

Batch Operations

For performing multiple operations atomically:

await db.batch([
  { type: 'put', key: 'key1', value: 'value1' },
  { type: 'del', key: 'key2' }
])

Event Handling

You can also attach event listeners:

db.on('put', (key, value) => {
  // Do something
})

Documentation

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/framework/plaindb/leveldb.git
cd basd
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@plaindb/leveldb is MIT licensed.