Apply constraints before inserting and updating TinyDB records.
Project description
tinydb-constraint
Apply constraints before inserting and updating TinyDB records.
Installation
Method 1:
$ pip install tinydb-constraint
Method 2:
- Clone the project from GitHub
- Get poetry and
poetry install tinydb-constraint --path PATH/TO/TINYDB/CONSTRAINT
Usage
>>> from tinydb import TinyDB
>>> from tinydb_constraint import ConstraintTable
>>> from datetime import datetime
>>> db = TinyDB('db.json')
>>> db.table_class = ConstraintTable
>>> db.set_schema({
... 'record_id': int,
... 'modified': datetime
... })
>>> db.schema
{
'record_id': Constraint(type_=int, unique=False, not_null=False),
'modified': Constraint(type_=datetime.datetime, unique=False, not_null=False)
}
If you want to enable TinyDB-constraint for all databases in a session, run:
>>> from tinydb import TinyDB
>>> from tinydb_constraint import ConstraintTable
>>> TinyDB.table_class = ConstraintTable
Note
I haven't modified the serialization yet, so datetime
type will actually produce datetime.isoformat()
, and to set datetime
, you have to pass a dateutil.parser.parse()
-parsable string.
Advanced usage
Database schema is also settable via Constraint
object.
>>> from tinydb_constraint import Constraint
>>> db.set_schema({
... 'user_id': Constraint(type_=int, unique=True, not_null=True)
... })
If you want to disable certain string sanitization features, like stripping spaces or checking if string can be converted to datetime, this can be done by setting environmental variables.
TINYDB_SANITIZE=0
TINYDB_DATETIME=0
Plan
- Add ForeignKey constraints.
Related projects
- tinydb-viewer - View records generated from TinyDB and alike (e.g. list of dictionaries.)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tinydb_constraint-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b57c524c52eb525bedbfe98de22a6aad09db69bfb0f31cbe8d963bcdf3afe6ba |
|
MD5 | 8084b28d32f70a9e4af4c0411daab082 |
|
BLAKE2b-256 | 605605911d7cddce29848239f37929a4e41aac1af07dc2ae6457d49f00f39116 |