Skip to main content

A key value datastore which stores data locally in a memory-mapped file.

Project description

key-value-ds

File based Key-Value datastore

Supports basic CRD (Create, Read, Delete)

Functionalities:

  1. It can be initialized using an optional file path. If one is not provided, it will reliably create itself using uuid.
  2. Key string capped at 32 characters and Value must be a JSON object capped at 16KB. (These values can be changed in config.py)
  3. 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. Once the Time-To-Live for a key has expired, the key will no longer be available for Read or Delete operations.
  4. Only one process can access the datastore (local file) at a time.
  5. Thread safe.

Usage:

Creating an instance
import key_value_ds
ds_instance = key_value_ds.get_instance()

Note: If file_path is provided in the get_instance() call, it will obtain lock on that file using fcntl. If object is created for the same file path twice, BlockingIOError is thrown.

Creating an data
data_key = 'test_key'
data_value = {"value": 1}  # must be a JSON
time_to_live = 5*1000  # in milliseconds
ds_instance.create(data_key, data_value, ttl=time_to_live)
Retrieving data
retrieve_key = 'test_key'
ds_instance.get(retrieve_key)   # returns {"value": 1} if retrieved within 5 seconds else ValueError
Deleting data
key_to_delete = 'test_key'
ds_instance.delete(key_to_delete)  # key-value is removed from the datastore
Delete all data
ds_instance.delete_all()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

key_value_ds-1.0.3.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

key_value_ds-1.0.3-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file key_value_ds-1.0.3.tar.gz.

File metadata

  • Download URL: key_value_ds-1.0.3.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for key_value_ds-1.0.3.tar.gz
Algorithm Hash digest
SHA256 b5dfd4f5ebbf2c8f0fbde8556ca7d75f2366a08363fb2816b804b8e7cc1e8f3c
MD5 8cc49ef773fc5317dd7af959aa28994e
BLAKE2b-256 f1679e86eb8f5fecfb06e6654256e4e2b0ae2d18fc0ac08e1a32f18cf92490b1

See more details on using hashes here.

File details

Details for the file key_value_ds-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: key_value_ds-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for key_value_ds-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ab2a852dfff0fc269c473360cf255a172e95fc00677cfa0ceec110cf801c454c
MD5 b0fb98aaf80e2a3a6c1e8428d3d98d4b
BLAKE2b-256 483b9bec56506828cce1196692d8f1350e3da842e3c7dc53e204466f94e2c934

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page