.. This file is the long-description for PyPI so it can only use plain ReST, no sphinx extensions.
RelStorage is a storage implementation for ZODB that stores pickles in
a relational database (RDBMS
_). PostgreSQL 10 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.
.. _RDBMS: https://en.wikipedia.org/wiki/Relational_database_
It is a drop-in replacement for FileStorage and ZEO, with several enhancements:
Ideal for large, high volume sites.
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)
.. _gevent: http://gevent.org .. _zodbconvert: https://relstorage.readthedocs.io/en/latest/zodbconvert.html .. _zodbpack: https://relstorage.readthedocs.io/en/latest/zodbpack.html .. _zodburi: https://relstorage.readthedocs.io/en/latest/zodburi.html
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.
.. list-table:: Supported Features :widths: auto :header-rows: 1 :stub-columns: 1
Documentation including installation instructions
is hosted on readthedocs
.
The complete changelog
_ is also there.
.. image:: https://readthedocs.org/projects/relstorage/badge/?version=latest :target: http://relstorage.readthedocs.io/en/latest/?badge=latest
.. installation instructions
: http://relstorage.readthedocs.io/en/latest/install.html
.. readthedocs
: http://relstorage.readthedocs.io/en/latest/
.. _changelog
: http://relstorage.readthedocs.io/en/latest/changelog.html
RelStorage is hosted at GitHub:
https://github.com/zodb/relstorage
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.
.. image:: https://github.com/zodb/relstorage/workflows/tests/badge.svg :target: https://github.com/zodb/relstorage/actions
.. image:: https://ci.appveyor.com/api/projects/status/pccddlgujdoqvl83?svg=true :target: https://ci.appveyor.com/project/jamadden/relstorage/branch/master
Builds on CI automatically submit updates to coveralls.io
_ to
monitor test coverage.
.. image:: https://coveralls.io/repos/zodb/relstorage/badge.svg?branch=master&service=github :target: https://coveralls.io/github/zodb/relstorage?branch=master
.. _coveralls.io: https://coveralls.io/github/zodb/relstorage