@ambassify/key-value-db

key-value-db

Providers persistent key-value storage.

Backends

• AWS DynamoDB
• Redis

Usage

npm install --save @ambassify/key-value-db

const {
    DYNAMODB, REDIS, MEMORY,
    createKeyValueTable
} = require('@ambassify/key-value-db');

const dynamodb = createKeyValueTable(DYNAMODB, {
    providerConfig: { region: 'eu-west-1' },
    table: 'my-key-value-table-name'
});

const redis = createKeyValueTable(REDIS, {
    connectionString: 'redis://127.0.0.1:6379',
    ioredisOptions: { connectTimeout: 1000 }
});

const memory = createKeyValueTable(MEMORY);

Options

All backends support these options:

• ttl: Default time-to-live in milliseconds for every operation that supports it

DYNAMODB

const db = createKeyValueTable(DYNAMODB, options)

• options
  • providerConfig Object to pass along to aws-sdk/clients/dynamodb
  • table The table name used in the backing store
  • keyColumn The name of the column in which to store the key
  • keyType The type of the values in the keyColumn (string, binary, number, buffer). Defaults to string.
  • valueColumn The name of the column in which to store the value
  • valueType The type of the values in the keyColumn (string, binary, number, buffer). Defaults to string.

REDIS

const db = createKeyValueTable(REDIS, options)

• options
  • connectionString redis:// connection string
  • ioredisOptions Options to pass along to ioredis

MEMORY

const db = createKeyValueTable(MEMORY, options)

• options
  • serializer function used to serialize data before storing, may return a Promise, defaults to JSON.stringify
  • deserializer function used to deserialize stored data, may return a Promise, defaults to JSON.parse

API

.set()

db.set(key, value, [ttl])

Sets the specified value at the specified key, overwriting any existing data at key.

.incr()

db.incr(key, amount, [ttl])

Increments the value at the specified key with amount in a single operation. Depending on the used backend this operation is atomic.

• amount can be any positive or negative number.

.remove()

db.remove(key)

Removes the record with key from the database.

.get()

db.get(key)

Returns the value at key or null if the key does not exist.

Contribute

We really appreciate any contribution you would like to make, so don't hesitate to report issues or submit pull requests.

License

This project is released under a MIT license.

About us

If you would like to know more about us, be sure to have a look at our website, or our Twitter accounts Ambassify, Sitebase, JorgenEvens