Skip to main content

SQLALchemy JSONField implementation for storing dicts at SQL

Project description

SQLAlchemy_JSONField

https://travis-ci.org/penguinolog/sqlalchemy_jsonfield.svg?branch=master https://coveralls.io/repos/github/penguinolog/sqlalchemy_jsonfield/badge.svg?branch=master https://img.shields.io/circleci/project/github/penguinolog/sqlalchemy_jsonfield.svg https://img.shields.io/pypi/v/sqlalchemy_jsonfield.svg https://img.shields.io/pypi/pyversions/sqlalchemy_jsonfield.svg https://img.shields.io/pypi/status/sqlalchemy_jsonfield.svg https://img.shields.io/github/license/penguinolog/sqlalchemy_jsonfield.svg

SQLALchemy JSONField implementation for storing dicts at SQL independently from JSON type support.

Why?

SqlAlchemy provides JSON field support for several database types (PostgreSQL and MySQL for now) and semi-working dict <-> JSON <-> VARCHAR example, but… In real scenarios we have tests on sqlite, production on MySQL/MariaDB/Percona/PostgreSQL and some of them (modern Oracle MySQL & PostgreSQL) support JSON, some of them (SQLite, Percona & MariaDB) requires data conversion to Text (not VARCHAR).

As addition, we have different levels of Unicode support on database and connector side, so we may be interested to switch JSON encoding between deployments.

Solution:

SQLALchemy JSONField has API with suport for automatic switch between native JSON and JSON encoded data, and encoding to JSON string can be enforced.

Pros:

Python 2.7
Python 3.4
Python 3.5
Python 3.6
PyPy
PyPy3

Usage

Direct usage with MariaDB (example extracted from functional tests):

import sqlalchemy_jsonfield

class ExampleTable(Base):
    __tablename__ = table_name
    id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True)
    row_name = sqlalchemy.Column(
        sqlalchemy.Unicode(64),
        unique=True,
    )
    json_record = sqlalchemy.Column(
        sqlalchemy_jsonfield.JSONField(
            # MariaDB does not support JSON for now
            enforce_string=True,
            # MariaDB connector requires additional parameters for correct UTF-8
            enforce_unicode=False
        ),
        nullable=False
    )

Usage on PostgreSQL/Oracle MySQL(modern version)/SQLite(testing) environments allows to set enforce_string=False and use native JSON fields.

Testing

The main test mechanism for the package sqlalchemy_jsonfield is using tox. Test environments available:

pep8
py27
py34
py35
py36
pypy
pypy3
pylint
docs

CI systems

For code checking several CI systems is used in parallel:

  1. Travis CI: is used for checking: PEP8, pylint, bandit, installation possibility and unit tests. Also it’s publishes coverage on coveralls.

  2. coveralls: is used for coverage display.

  3. Circle CI: is used for functional tests at separate docker infrastructure. This CI used for HUGE tests.

CD system

Travis CI: is used for package delivery on PyPI.

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

SQLAlchemy-JSONField-0.6.2.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

SQLAlchemy_JSONField-0.6.2-py2.py3-none-any.whl (7.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file SQLAlchemy-JSONField-0.6.2.tar.gz.

File metadata

File hashes

Hashes for SQLAlchemy-JSONField-0.6.2.tar.gz
Algorithm Hash digest
SHA256 6dfa9b7fc4eb2a1ee7782aff589c72e9e86f23706241ab15a2d65700fd92b986
MD5 e7b6481244dedba55d7a9130e183126d
BLAKE2b-256 b8bbadf670069d63deadcc124ffa8fc14362650820b77fa681faf7538f03203c

See more details on using hashes here.

File details

Details for the file SQLAlchemy_JSONField-0.6.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for SQLAlchemy_JSONField-0.6.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 792591ba7718a7ccace985041afd734bf7527afdafee2d84916cc36bb6c29600
MD5 4972905c00283d2cfe4e9e69601274a1
BLAKE2b-256 108d517e939cb2660430679b44438e1a69668bb75b6a475470cc4d71225d6ab9

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