Skip to content

File-based key-value data store that supports the basic CRD

Notifications You must be signed in to change notification settings

nithinleo14/keyvalue-db

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

keyvalue-db

File-based key-value data store that supports the basic CRD (create, read, and delete) operations. This data store is meant to be used as a local storage for one single process on one laptop. The data store is exposed as a library to clients.

The data store will support the following functional requirements.

  1. It can be initialized using an optional file path. If one is not provided, it will reliably create itself in a reasonable location on the laptop.
  2. A new key-value pair can be added to the data store using the Create operation. The key is always a string - capped at 32chars. The value is always a JSON object - capped at 16KB.
  3. If Create is invoked for an existing key, an appropriate error must be returned.
  4. A Read operation on a key can be performed by providing the key, and receiving the value in response, as a JSON object.
  5. A Delete operation can be performed by providing the key.
  6. Every key supports setting a Time-To-Live property when it is created. This property is optional. If provided, it will be evaluated as an integer defining the number of seconds the key must be retained in the data store. Once the Time-To-Live for a key has expired, the key will no longer be available for Read or Delete operations.
  7. Appropriate error responses are returned to a client.

The data store will also support the following non-functional requirements.

  1. The size of the file storing data must never exceed 1GB.
  2. More than one client process cannot be allowed to use the same file as a data store at any given time.

library js is in ./lib/keyvalue-db.js

Releases

No releases published

Packages

No packages published