Skip to main content

Apply constraints before inserting and updating TinyDB records.

Project description

tinydb-constraint

PyPI version shields.io PyPI license

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
>>> TinyDB.table_class = ConstraintTable
>>> db = TinyDB('db.json')
>>> 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)
}

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


Download files

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

Source Distribution

tinydb-constraint-0.1.7.1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

tinydb_constraint-0.1.7.1-py2.py3-none-any.whl (15.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file tinydb-constraint-0.1.7.1.tar.gz.

File metadata

  • Download URL: tinydb-constraint-0.1.7.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.11.5 CPython/3.7.0 Darwin/17.7.0

File hashes

Hashes for tinydb-constraint-0.1.7.1.tar.gz
Algorithm Hash digest
SHA256 fe9e1457a83ed81709f167d1a4d6cdaa29705d6add53bedae8f7be1477e6ff17
MD5 5afad5d11b3e2ab2fea6dc5a013f634f
BLAKE2b-256 67655b4b662dc10dee76b4d6ad5077e2a10bb8865cee7db1afaa4a911f2f7fd4

See more details on using hashes here.

File details

Details for the file tinydb_constraint-0.1.7.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for tinydb_constraint-0.1.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0579cf0e4c4efe8643323cd01828684ee0089de6a77830d3266b32390497a94a
MD5 b0e3ba344237a7185226369ff6ebbe87
BLAKE2b-256 4bb166d3c01f79948f4194003ffa8e14f21daed320b3b7152f8e37561728fb96

See more details on using hashes here.

Supported by

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