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.
- 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
Install the package with:
npm install @plaindb/leveldb
First, import the LevelDB
library.
import LevelDB from '@plaindb/leveldb'
or
const LevelDB = require('@plaindb/leveldb')
You can initialize a LevelDB instance as follows:
const db = new LevelDB({
dbName: 'myDatabase',
dbPrefix: 'prefix',
reset: true,
separator: '!',
keyEncoding: 'utf8',
valueEncoding: 'msgpack'
})
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) Iftrue
, clears the database on instantiation. Default isfalse
.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'
.
To insert data into the LevelDB database:
await db.put('key', 'value')
To retrieve data from the database:
const value = await db.get('key')
To delete data:
await db.del('key')
For large datasets, you can use streaming:
const readStream = db.createReadStream()
readStream.on('data', data => {
console.log(data)
})
You can create sub-levels for better data organization:
const subDB = db.sub('subPath')
For performing multiple operations atomically:
await db.batch([
{ type: 'put', key: 'key1', value: 'value1' },
{ type: 'del', key: 'key2' }
])
You can also attach event listeners:
db.on('put', (key, value) => {
// Do something
})
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
Thank you! Please see our contributing guidelines for details.
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
@plaindb/leveldb is MIT licensed.