Storage

A highly modular storage interface and base class for building custom database storage adapters.

Features

• Standardized API: Offers a consistent way to interact with different storage backends.
• Async/Await Support: Built with native promise support for modern JavaScript workflows.
• Iterator Support: Asynchronous iterator function for traversing through stored keys.
• Sub-storage: Create sub-storages with a specified path.

Installation

Install the package with:

npm install @plaindb/storage

Usage

First, import the Storage library.

import Storage from '@plaindb/storage'

or

const Storage = require('@plaindb/storage')

// create a storage instance:
const storage = new Storage()

// or, extend Storage to create a custom storage adapter:
class MyCustomStorage extends Storage {
  async _connect() {
    // Implement your connect logic here
  }
  async _disconnect() {
    // Implement your disconnect logic here
  }
}

const myStorage = new MyCustomStorage()

Documentation

• API Reference

Interface (IStorage)

The IStorage interface class provides the following methods which need to be implemented:

• connect(): Initialize the storage connection.
• disconnect(): Close the storage connection.
• getNativeConnection(): Retrieve the native client/connection object.
• get(key): Retrieve a value by key.
• put(key, value): Store a value by key.
• del(key): Delete a value by key.
• iterator(opts): Asynchronous iterator for key-value pairs.
• sub(path, opts): Create a sub-storage with a specified path.

Methods

connect()

Connects to the storage backend.

disconnect()

Disconnects from the storage backend.

get(key)

Retrieves a value from the storage by key.

const value = await storage.get('someKey')

put(key, value)

Stores a value in the storage by key.

await storage.put('someKey', 'someValue')

del(key)

Deletes a value from the storage by key.

await storage.del('someKey')

iterator(opts)

Returns an asynchronous iterator for key-value pairs.

for await (const { key, value } of storage.iterator()) {
  console.log(key, value)
}

sub(path, opts)

Creates a sub-storage with a specified path.

const subStorage = storage.sub('some/path')

Events

• error: Emitted when there is an error in connecting or disconnecting.

storage.on('error', (err) => {
  console.error(`Error: ${err}`)
})

Tests

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

git clone https://gitlab.com/frenware/framework/plaindb/storage.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/storage is MIT licensed.