Skip to content

Commit

Permalink
Merge bfb7881 into 2490ae0
Browse files Browse the repository at this point in the history
  • Loading branch information
jamadden committed Mar 9, 2017
2 parents 2490ae0 + bfb7881 commit f392cdc
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions doc/articles/multi-zodb-gc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,24 @@ database of all persistent references.
The second feature allows us to debug and repair PosKeyErrors by finding the
persistent object(s) that point to the lost object.

Note: This documentation applies to ZODB 3.9 and later. Earlier versions of the
ZODB are not supported, as they lack the fast storage iteration API's required
by `zc.zodbdgc`.

This documentation does not apply to
`RelStorage <http://pypi.python.org/pypi/RelStorage>`_ which has the same
features built-in, but accessible in different ways. Look at the options for
the `zodbpack` script. The `--prepack` option creates a table containing the
same information as we are creating in the reference database.
.. note::
This documentation applies to ZODB 3.9 and later. Earlier versions of the
ZODB are not supported, as they lack the fast storage iteration API's required
by ``zc.zodbdgc``.

.. note::
Unless you're using multi-databases, this documentation does not apply to
`RelStorage <http://pypi.python.org/pypi/RelStorage>`_ which has the same
features built-in, but accessible in different ways. Look at the options for
the ``zodbpack`` script. The ``--prepack`` option creates a table containing the
same information as we are creating in the reference database.

If you *are* using multi-databases, be aware that RelStorage 2.0 is needed to
perform packing and garbage collection with ``zc.zodbdgc``, and those features only
work in history-free databases.

It's important to realize that there is currently no way to perform garbage collection
in a history-preserving multi-database RelStorage.

Setup
-----
Expand Down

0 comments on commit f392cdc

Please sign in to comment.