Objective:

• Design APIs that we can use to make requests to the DB through a client (also design a query language maybe or we can use REST APIs?)

Functional Requirements:

• #5
• #6
• #7
• #12
• #13
  • For now implement a lazy cleanup service i.e if key is expired on get, return None and expire the key (if not expired already)
• #15
• Add types using enums
  • Add type Integer
  • Add type String
  • Add type List
  • Add type Bytes
  • Add type HashSet
  • Add type HashMap
• #36
  • Add cleanup service that runs periodically to delete cache keys which are expired.
• #37
  • Create a client that can interact with the API
• Add persistence
  • Snapshots for now
  • Take periodic snapshots

• Design a protocol to accept requests in and return a response in. (TCP or HTTP/Rest maybe?)
• Main event loop will also have some period task so maybe add support for that. (https://tokio.rs/tokio/tutorial)

A storage manager basically handles a hashmap of name and KeyValueStore object.

• Can add a store given a name and TTL
• Can remove a store given a name
• Can clone a store given a name
• Update TTL for a store

• Add more based on requirement.

Objective:

• To create documentation with thorough description of all data types, errors, APIs
• To create documentation of the internal functions and utils to help contribution to the project