0.2.5 • Published 1 year ago
@ambassify/key-value-db v0.2.5
key-value-db
Providers persistent key-value storage.
Backends
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 toaws-sdk/clients/dynamodb
table
The table name used in the backing storekeyColumn
The name of the column in which to store the keykeyType
The type of the values in thekeyColumn
(string, binary, number, buffer). Defaults tostring
.valueColumn
The name of the column in which to store the valuevalueType
The type of the values in thekeyColumn
(string, binary, number, buffer). Defaults tostring
.
REDIS
const db = createKeyValueTable(REDIS, options)
options
connectionString
redis:// connection stringioredisOptions
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 toJSON.stringify
deserializer
function used to deserialize stored data, may return a Promise, defaults toJSON.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