https://github.com/zackees/keyvalue_sqlite

Super simple KeyValue store for python, backed by sqlite.
https://github.com/zackees/keyvalue_sqlite

Last synced: 3 months ago
JSON representation

Super simple KeyValue store for python, backed by sqlite.

• Host: GitHub
• URL: https://github.com/zackees/keyvalue_sqlite
• Owner: zackees
• License: mit
• Created: 2021-05-07T20:12:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-18T17:00:57.000Z (7 months ago)
• Last Synced: 2024-07-19T15:49:11.457Z (4 months ago)
• Language: Python
• Size: 47.9 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# KeyValueSqlite

`pip install key-value-db`

Super easy drop in replacement for python dictionary, which stores

it's key-value to an sqlite database. Atomic counters are supported.

[![Win_Tests](https://github.com/zackees/keyvalue_sqlite/actions/workflows/push_win.yml/badge.svg)](https://github.com/zackees/keyvalue_sqlite/actions/workflows/push_win.yml)

[![Ubuntu_Tests](https://github.com/zackees/keyvalue_sqlite/actions/workflows/push_ubuntu.yml/badge.svg)](https://github.com/zackees/keyvalue_sqlite/actions/workflows/push_ubuntu.yml)

[![MacOS_Tests](https://github.com/zackees/keyvalue_sqlite/actions/workflows/push_macos.yml/badge.svg)](https://github.com/zackees/keyvalue_sqlite/actions/workflows/push_macos.yml)

This is great if you have a web app that needs to communicate with other workers or a backend service, but don't want to install Redis.

Keep in mind this library does no connection recycling, so the per-query performance won't be good if the db gets past a certain size.

# API

```python

from keyvalue_sqlite import KeyValueSqlite

DB_PATH = '/path/to/db.sqlite'

db = KeyValueSqlite(DB_PATH, 'table-name')

# Now use standard dictionary operators

db.set_default('0', '1')

actual_value = db.get('0')

assert '1' == actual_value

db.set_default('0', '2')

assert '1' == db.get('0')

```

New in 1.0.4: atomic integers.

```python

from keyvalue_sqlite import KeyValueSqlite

DB_PATH = '/path/to/db.sqlite'

db = KeyValueSqlite(DB_PATH, 'table-name')

# Now use standard dictionary operators

db.set_default('atomic_var', '1')

val = db.get('atomic_var')

assert '3' == actual_value

# also atomic are supported:

db.atomic_add('atomic_var', '2')

```

This datastructure is not going to win any performance races, but it

is super simple to use with just a few lines of code. This is a great

option for one of those small web apps which doesn't have enough load

to justify mysql or postgres or redis or you want to want something

that is simple to use in Windows environment.

When fetching large amounts of data try to use get_many() or dict_range().

# Links

  * https://pypi.org/project/keyvalue-sqlite

  * https://github.com/zackees/keyvalue_sqlite

# Versions

  * 1.0.7: Don't use "default" as the default table name, sqlite doesn't like it.

  * 1.0.6: Allow setting default timeout in the constructor

  * 1.0.5: Makes table name optional.

  * 1.0.4: Adds atomic_add to allow atomic int operations.