A backend for ZODB that stores pickles in a relational database.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for hathawsh from gravatar.com hathawsh Avatar for J1m from gravatar.com J1m Avatar for jamadden from gravatar.com jamadden

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

RelStorage is a storage implementation for ZODB that stores pickles in a relational database (RDBMS). PostgreSQL 9.6 and above, MySQL 5.7.19 / 8.0, Oracle 10g and above, and SQLite 3.8.3 and above are currently supported. RelStorage replaced the PGStorage project.

Features

  • It is a drop-in replacement for FileStorage and ZEO, with several enhancements:

    • Supports undo, packing, and object history preservation just like FileStorage.

    • RelStorage can be configured not to keep object histories for reduced disk space usage and improved performance.

    • Multiple processes on a single machine can read and write a local ZODB database using SQLite without needing to start and manage another process (i.e., ZEO).

    • Blobs can be stored on a shared filesystem, or (recommended) in the relational database and only cached locally.

    • Multiple threads in the same process share a high-performance in-memory pickle cache to reduce the number of queries to the RDBMS. This is similar to ZEO, and the ZEO cache trace tools are supported.

    • The in-memory pickle cache can be saved to disk and read when a process starts up. This can dramatically speed up site warmup time by eliminating a flood of RDBMS queries. Unlike ZEO, this cache is automatically shared by all processes on the machine (no need to configure separate client identifiers.)

  • Ideal for large, high volume sites.

    • Multiple Python processes on multiple machines can read and write the same ZODB database concurrently. This is similar to ZEO, but RelStorage does not require ZEO.

    • Supports ZODB 5’s parallel commit feature: Database writers only block each other when they would conflict (except for a small window at the end of the twophase commit protocol when the transaction ID is allocated; that still requires a global database lock).

    • According to some tests, RelStorage handles concurrency better than the standard combination of ZEO and FileStorage.

    • Whereas FileStorage takes longer to start as the database grows due to an in-memory index of all objects, RelStorage starts quickly regardless of database size.

    • Capable of failover to replicated SQL databases.

  • Tested integration with gevent for PostgreSQL, MySQL, and SQLite.

  • There is a simple way (zodbconvert) to (incrementally) convert FileStorage to RelStorage and back again. You can also convert a RelStorage instance to a different relational database. This is a general tool that can be used to convert between any two ZODB storage implementations.

  • There is a simple way (zodbpack) to pack databases.

  • Supports zodburi .

  • Free, open source (ZPL 2.1)

Features Supported by Databases

Some of RelStorage’s features are only supported on certain versions of certain databases. If the database doesn’t support the feature, RelStorage will still work, but possibly with a performance penalty.

Supported Features

Parallel Commit

Shared readCurrent locks

Non-blocking readCurrent locks

Streaming blobs

Central transaction ID allocation

Atomic lock and commit without Python involvement

PostgreSQL

Yes

Yes

Yes

With psycopg2 driver

Yes

Yes, except with PG8000 driver

MySQL

Yes

Yes

Native on MySQL 8.0, emulated on MySQL 5.7

No, emulated via chunking

Yes

Yes

Oracle

Yes

No

Yes

Yes

No (could probably be implemented)

No (could probably be implemented)

SQLite

No

No

N/A (there is no distinction in lock types)

No, consider using a shared-blob-dir

N/A (essentially yes because it happens on one machine)

No

Documentation

Documentation including installation instructions is hosted on readthedocs.

The complete changelog is also there.

https://readthedocs.org/projects/relstorage/badge/?version=latest

Development

RelStorage is hosted at GitHub:

https://github.com/zodb/relstorage

Continuous integration

A test suite is run for every push and pull request submitted. GitHub Actions is used to test on Linux and macOS, and AppVeyor runs the builds on Windows.

https://github.com/zodb/relstorage/workflows/tests/badge.svg https://ci.appveyor.com/api/projects/status/pccddlgujdoqvl83?svg=true

Builds on CI automatically submit updates to coveralls.io to monitor test coverage.

https://coveralls.io/repos/zodb/relstorage/badge.svg?branch=master&service=github

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for hathawsh from gravatar.com hathawsh Avatar for J1m from gravatar.com J1m Avatar for jamadden from gravatar.com jamadden

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

4.1.0

4.0.0

4.0.0a1 pre-release

3.5.0

3.5.0a6 pre-release

3.5.0a4 pre-release

3.5.0a3 pre-release

This version

3.5.0a2 pre-release

3.5.0a1 pre-release

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.2

3.3.1

3.3.0

3.2.1

3.2.0

3.1.3.dev0 pre-release

3.1.2

3.1.1

3.1.0

3.0.1

3.0.0

3.0rc1 pre-release

3.0b3 pre-release

3.0b2 pre-release

3.0b1 pre-release

3.0a13 pre-release

3.0a12 pre-release

3.0a11 pre-release

3.0a10 pre-release

3.0a9 pre-release

3.0a8 pre-release

3.0a7 pre-release

3.0a6 pre-release

3.0a5 pre-release

3.0a4 pre-release

3.0a3 pre-release

3.0a2 pre-release

3.0a1 pre-release

2.1.1

2.1.0

2.1a2 pre-release

2.1a1 pre-release

2.0.0

2.0.0rc1 pre-release

2.0.0b9 pre-release

2.0.0b8 pre-release

2.0.0b7 pre-release

2.0.0b6 pre-release

2.0.0b5 pre-release

2.0.0b4 pre-release

2.0.0b3 pre-release

2.0.0b2 pre-release

2.0.0b1 pre-release

1.6.3

1.6.2

1.6.1

1.6.0

1.6.0b3 pre-release

1.6.0b2 pre-release

1.6.0b1 pre-release

1.5.1

1.5.0

1.5.0b2 pre-release

1.5.0b1 pre-release

1.5.0a1 pre-release

1.4.2

1.4.1

1.4.0

1.4.0c4 pre-release

1.4.0c3 pre-release

1.4.0c2 pre-release

1.4.0c1 pre-release

1.4.0b3 pre-release

1.4.0b2 pre-release

1.4.0b1 pre-release

1.3.0b1 pre-release

1.2.0

1.2.0b2 pre-release

1.1.3

1.1.2

1.1.1

1.1

1.1c1 pre-release

1.1b2 pre-release

1.1b1 pre-release

1.0.1

1.0

1.0c1 pre-release

1.0-beta1 pre-release

Download files

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

Source Distribution

RelStorage-3.5.0a2.tar.gz (1.5 MB view hashes)

Uploaded Source

Built Distributions

RelStorage-3.5.0a2-cp39-cp39-manylinux2010_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp39-cp39-manylinux1_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.9

RelStorage-3.5.0a2-cp39-cp39-macosx_10_14_x86_64.whl (846.2 kB view hashes)

Uploaded CPython 3.9 macOS 10.14+ x86-64

RelStorage-3.5.0a2-cp38-cp38-win_amd64.whl (833.7 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

RelStorage-3.5.0a2-cp38-cp38-win32.whl (823.6 kB view hashes)

Uploaded CPython 3.8 Windows x86

RelStorage-3.5.0a2-cp38-cp38-manylinux2010_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp38-cp38-manylinux1_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.8

RelStorage-3.5.0a2-cp38-cp38-macosx_10_14_x86_64.whl (843.1 kB view hashes)

Uploaded CPython 3.8 macOS 10.14+ x86-64

RelStorage-3.5.0a2-cp37-cp37m-win_amd64.whl (832.2 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

RelStorage-3.5.0a2-cp37-cp37m-win32.whl (822.7 kB view hashes)

Uploaded CPython 3.7m Windows x86

RelStorage-3.5.0a2-cp37-cp37m-manylinux2010_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp37-cp37m-manylinux1_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.7m

RelStorage-3.5.0a2-cp37-cp37m-macosx_10_14_x86_64.whl (842.8 kB view hashes)

Uploaded CPython 3.7m macOS 10.14+ x86-64

RelStorage-3.5.0a2-cp36-cp36m-win_amd64.whl (830.5 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

RelStorage-3.5.0a2-cp36-cp36m-win32.whl (821.4 kB view hashes)

Uploaded CPython 3.6m Windows x86

RelStorage-3.5.0a2-cp36-cp36m-manylinux2010_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp36-cp36m-manylinux1_x86_64.whl (1.7 MB view hashes)

Uploaded CPython 3.6m

RelStorage-3.5.0a2-cp35-cp35m-manylinux2010_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.5m manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp35-cp35m-manylinux1_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 3.5m

RelStorage-3.5.0a2-cp27-cp27mu-manylinux2010_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 2.7mu manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp27-cp27mu-manylinux1_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 2.7mu

RelStorage-3.5.0a2-cp27-cp27m-win_amd64.whl (832.4 kB view hashes)

Uploaded CPython 2.7m Windows x86-64

RelStorage-3.5.0a2-cp27-cp27m-win32.whl (821.4 kB view hashes)

Uploaded CPython 2.7m Windows x86

RelStorage-3.5.0a2-cp27-cp27m-manylinux2010_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 2.7m manylinux: glibc 2.12+ x86-64

RelStorage-3.5.0a2-cp27-cp27m-manylinux1_x86_64.whl (1.6 MB view hashes)

Uploaded CPython 2.7m

RelStorage-3.5.0a2-cp27-cp27m-macosx_10_14_x86_64.whl (842.2 kB view hashes)

Uploaded CPython 2.7m macOS 10.14+ x86-64

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