RelStorage, but only InnoDB for mysql
Go to file
2019-04-14 16:56:23 -07:00
.travis Bump the tested version of MySQL Connector. 2018-02-02 08:56:08 -06:00
doc Clean up the configuring-your-application document. 2018-04-10 10:39:11 -05:00
relstorage make tables under innodb 2019-04-14 16:56:23 -07:00
repltest sync manifest.in [skip ci] 2016-06-28 15:08:20 -05:00
scripts/releases release scripts 2018-02-07 09:18:05 -06:00
.coveragerc Move and rename LocalClientBucket to something more fitting. 2016-09-20 06:15:45 -05:00
.gitignore tweak manifest 2016-12-23 05:39:25 -06:00
.landscape.yml Cleanup all the lint (#143) 2016-12-10 11:27:11 -06:00
.pylintrc Avoid deleting attributes of DB driver modules. 2019-01-07 08:20:53 -06:00
.travis.yml Document that PyPy does not work with mysqlconnector and remove it from the matrix. 2018-02-02 09:29:42 -06:00
appveyor.yml Tweak appveyor config. [skip travis] 2019-01-07 09:45:46 -06:00
bootstrap.py Update to latest bootstrap 2016-06-14 13:54:01 -04:00
buildout-oracle.cfg Prep for 1.4.0: 2010-09-30 10:17:16 +00:00
buildout.cfg Added interface declaration and explanation for why afterCompletion only rolls back the load connection. 2017-02-09 11:43:30 -05:00
BUILDOUT.rst Updated the buildout configuration to just run relstorage tests and 2016-06-14 13:43:36 -04:00
CHANGES.rst Back to development: 2.1.2 2019-01-07 13:17:35 -06:00
COPYRIGHT.txt Compy with repository policy 2010-04-12 19:26:36 +00:00
doc-requirements.txt Pin older versions of ZEO/ZODB for RTD [skip ci] 2016-08-23 10:41:38 -05:00
LICENSE.txt More policy compliance. 2010-04-12 19:36:44 +00:00
MANIFEST.in release scripts 2018-02-07 09:18:05 -06:00
README.rst Version notes. [skip ci] 2017-01-27 11:11:53 -06:00
setup.cfg Wheels are not universal anymore. 2016-09-22 16:18:22 -05:00
setup.py Attempt to fix Python 3.6 build on Travis. 2017-06-22 10:40:50 -05:00
tox.ini Test on ZODB 4.4 2017-04-11 09:27:46 -05:00
version.txt Back to development: 2.1.2 2019-01-07 13:17:35 -06:00

RelStorage is a storage implementation for ZODB that stores pickles in
a relational database. PostgreSQL 9.0 and above (performance is best
with 9.5 and above), MySQL 5.0.32+ / 5.1.34+, and Oracle 10g and 11g
are currently supported. RelStorage replaced the PGStorage project.


==========
 Features
==========

* It is a drop-in replacement for FileStorage and ZEO.
* There is a simple way to convert FileStorage to RelStorage and back again.
  You can also convert a RelStorage instance to a different relational database.
* Designed for high volume sites: multiple ZODB instances can share the same
  database. This is similar to ZEO, but RelStorage does not require ZEO.
* According to some tests, RelStorage handles high 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.
* Supports undo, packing, and filesystem-based ZODB blobs.
* Both history-preserving and history-free storage are available.
* Capable of failover to replicated SQL databases.
* ``zodbconvert`` utility to copy databases.
* Free, open source (ZPL 2.1)


===============
 Documentation
===============

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


=============
 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. Travis
CI is used to test on Linux, and AppVeyor runs the builds on
Windows.

.. image:: https://travis-ci.org/zodb/relstorage.svg?branch=master
    :target: https://travis-ci.org/zodb/relstorage

.. image:: https://ci.appveyor.com/api/projects/status/pccddlgujdoqvl83?svg=true
   :target: https://ci.appveyor.com/project/jamadden/relstorage/branch/master

Builds on Travis 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

Likewise, builds on Travis CI will automatically submit updates to
`landscape.io`_ to monitor code health (adherence to PEP8, absence of
common code smells, etc).

.. image:: https://landscape.io/github/zodb/relstorage/master/landscape.svg?style=flat
   :target: https://landscape.io/github/zodb/relstorage/master
   :alt: Code Health

.. _coveralls.io: https://coveralls.io/github/zodb/relstorage
.. _landscape.io: https://landscape.io/github/zodb/relstorage