Log in

README.html

File contents

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.8: http://docutils.sourceforge.net/" />
<title>ZODB 3.5</title>
<link rel="stylesheet" href="default.css" type="text/css" />
</head>
<body>
<div class="document" id="zodb-3-5">
<h1 class="title">ZODB 3.5</h1>
<div class="section" id="introduction">
<h1><a name="introduction">Introduction</a></h1>
<p>The ZODB package provides a set of tools for using the Zope Object
Database (ZODB) in Python programs separately from Zope. The tools
you get are identical to the ones provided in Zope, because they come
from the same source repository. They have been packaged for use in
non-Zope stand-alone Python applications.</p>
<p>The components you get with the ZODB release are as follows:</p>
<ul class="simple">
<li>Core ZODB, including the persistence machinery</li>
<li>Standard storages such as FileStorage</li>
<li>The persistent BTrees modules</li>
<li>ZEO</li>
<li>ZConfig -- a Zope configuration language</li>
<li>documentation</li>
</ul>
<p>Our primary development platforms are Linux and Windows XP. The
test suite should pass without error on all of these platforms,
although it can take a long time on Windows -- longer if you use
ZoneAlarm. Many particularly slow tests are skipped unless you pass
--all as an argument to test.py.</p>
</div>
<div class="section" id="compatibility">
<h1><a name="compatibility">Compatibility</a></h1>
<p>ZODB 3.5 requires Python 2.3.4 or later. For best results, we recommend
Python 2.3.5. Python 2.4.1 can also be used.</p>
<p>The Zope 2.8 release, and Zope3 releases, should be compatible with this
version of ZODB. Note that Zope 2.7 and higher includes ZEO, so this package
should only be needed to run a ZEO server.</p>
<p>ZEO servers and clients are wholly compatible among 3.3, 3.3.1, 3.4 and 3.5:
a ZEO client from any of those versions can talk with a ZEO server from any.</p>
<p>Trying to mix ZEO clients and servers from 3.3 or later from ZODB releases
before 3.3 is much harder. ZODB 3.3 introduced multiversion concurrency
control (MVCC), and earlier ZEO servers do not support MVCC: a 3.3+ ZEO
client cannot talk with an older ZEO server as a result.</p>
<p>In the other direction, a 3.3+ ZEO server can talk with older ZEO clients,
but because the names of some basic classes have changed, if any 3.3+ clients
commit modifications to the database it's likely that the database will
contain instances of classes that don't exist in (can't be loaded by) older
ZEO clients. For example, the database root object was an instance of
<tt class="docutils literal"><span class="pre">ZODB.PersistentMapping.PersistentMapping</span></tt> before ZODB 3.3, but is an
instance of <tt class="docutils literal"><span class="pre">persistent.mapping.PersistentMapping</span></tt> in ZODB 3.3. A 3.3.1+
client can still load a <tt class="docutils literal"><span class="pre">ZODB.PersistentMapping.PersistentMapping</span></tt> object,
but this is just an alias for <tt class="docutils literal"><span class="pre">persistent.mapping.PersistentMapping</span></tt>, and
an object of the latter type will be stored if a 3.3 client commits a change
to the root object. An older ZEO client cannot load the root object so
changed.</p>
<p>This limits migration possibilities: a 3.3+ ZEO server can be used with
older (pre-3.3) ZEO clients and serve an older database, so long as no 3.3+
ZEO clients commit changes to the database. The most practical upgrade path
is to bring up both servers and clients using 3.3+, not trying to mix pre-3.3
and post-3.3 ZEO clients and servers.</p>
</div>
<div class="section" id="prerequisites">
<h1><a name="prerequisites">Prerequisites</a></h1>
<p>You must have Python installed. If you've installed Python from RPM,
be sure that you've installed the development RPMs too, since ZODB
builds Python extensions. If you have the source release of ZODB,
you will need a C compiler.</p>
</div>
<div class="section" id="installation">
<h1><a name="installation">Installation</a></h1>
<p>ZODB is released as a distutils package. To build it, run the setup
script:</p>
<pre class="literal-block">
% python setup.py build
</pre>
<p>To test the build, run the test script:</p>
<pre class="literal-block">
% python test.py
</pre>
<p>For more verbose test output, append one or two '-v' arguments to this
command.</p>
<p>If all the tests succeeded, you can install ZODB using the setup
script:</p>
<pre class="literal-block">
% python setup.py install
</pre>
<p>This should now make all of ZODB accessible to your Python programs.</p>
</div>
<div class="section" id="testing">
<h1><a name="testing">Testing</a></h1>
<p>ZODB comes with a large test suite that can be run from the source
directory before ZODB is installed. The simplest way to run the tests
is:</p>
<pre class="literal-block">
% python test.py -v
</pre>
<p>This command will run all the tests, printing a single dot for each
test. When it finishes, it will print a test summary. The exact
number of tests can vary depending on platform and available
third-party libraries.:</p>
<pre class="literal-block">
Ran 1182 tests in 241.269s
OK
</pre>
<p>The test script has many more options. Use the <tt class="docutils literal"><span class="pre">-h</span></tt> or <tt class="docutils literal"><span class="pre">--help</span></tt>
options to see a file list of options. The default test suite omits
several tests that depend on third-party software or that take a long
time to run. To run all the available tests use the <tt class="docutils literal"><span class="pre">--all</span></tt> option.
Running all the tests takes much longer.:</p>
<pre class="literal-block">
Ran 1561 tests in 1461.557s
OK
</pre>
</div>
<div class="section" id="history">
<h1><a name="history">History</a></h1>
<p>The historical version numbering schemes for ZODB and ZEO are complicated.
Starting with ZODB 3.4, the ZODB and ZEO version numbers are the same.</p>
<p>In the ZODB 3.1 through 3.3 lines, the ZEO version number was &quot;one smaller&quot;
than the ZODB version number; e.g., ZODB 3.2.7 included ZEO 2.2.7. ZODB and
ZEO were distinct releases prior to ZODB 3.1, and had independent version
numbers.</p>
<p>Historically, ZODB was distributed as a part of the Zope application
server. Jim Fulton's paper at the Python conference in 2000 described
a version of ZODB he called ZODB 3, based on an earlier persistent
object system called BoboPOS. The earliest versions of ZODB 3 were
released with Zope 2.0.</p>
<p>Andrew Kuchling extracted ZODB from Zope 2.4.1 and packaged it for
use by standalone Python programs. He called this version
&quot;StandaloneZODB&quot;. Andrew's guide to using ZODB is included in the Doc
directory. This version of ZODB was hosted at
<a class="reference" href="http://sf.net/projects/zodb">http://sf.net/projects/zodb</a>. It supported Python 1.5.2, and might
still be of interest to users of this very old Python version.</p>
<p>Zope Corporation released a version of ZODB called &quot;StandaloneZODB
1.0&quot; in Feb. 2002. This release was based on Andrew's packaging, but
built from the same CVS repository as Zope. It is roughly equivalent
to the ZODB in Zope 2.5.</p>
<p>Why not call the current release StandaloneZODB? The name
StandaloneZODB is a bit of a mouthful. The standalone part of the
name suggests that the Zope version is the real version and that this
is an afterthought, which isn't the case. So we're calling this
release &quot;ZODB&quot;.</p>
<p>To make matters worse, we worked on a ZODB4 package for a while and
made a couple of alpha releases. We've now abandoned that effort,
because we didn't have the resources to pursue ot while also maintaining
ZODB(3).</p>
</div>
<div class="section" id="license">
<h1><a name="license">License</a></h1>
<p>ZODB is distributed under the Zope Public License, an OSI-approved
open source license. Please see the LICENSE.txt file for terms and
conditions.</p>
<p>The ZODB/ZEO Programming Guide included in the documentation is a
modified version of Andrew Kuchling's original guide, provided under
the terms of the GNU Free Documentation License.</p>
</div>
<div class="section" id="more-information">
<h1><a name="more-information">More information</a></h1>
<p>We maintain a Wiki page about all things ZODB, including status on
future directions for ZODB. Please see</p>
<blockquote>
<a class="reference" href="http://www.zope.org/Wikis/ZODB">http://www.zope.org/Wikis/ZODB</a></blockquote>
<p>and feel free to contribute your comments. There is a Mailman mailing
list in place to discuss all issues related to ZODB. You can send
questions to</p>
<blockquote>
<a class="reference" href="mailto:zodb-dev&#64;zope.org">zodb-dev&#64;zope.org</a></blockquote>
<p>or subscribe at</p>
<blockquote>
<a class="reference" href="http://lists.zope.org/mailman/listinfo/zodb-dev">http://lists.zope.org/mailman/listinfo/zodb-dev</a></blockquote>
<p>and view its archives at</p>
<blockquote>
<a class="reference" href="http://lists.zope.org/pipermail/zodb-dev">http://lists.zope.org/pipermail/zodb-dev</a></blockquote>
<p>Note that Zope Corp mailing lists have a subscriber-only posting policy.</p>
<p>Andrew's ZODB Programmers Guide is made available in several
forms, including DVI and HTML. To view it online, point your
browser at the file Doc/guide/zodb/index.html</p>
</div>
<div class="section" id="bugs-and-patches">
<h1><a name="bugs-and-patches">Bugs and Patches</a></h1>
<p>Bug reports and patches should be added to the Zope Collector, with
topic &quot;Database&quot;:</p>
<blockquote>
<a class="reference" href="http://collector.zope.org/Zope">http://collector.zope.org/Zope</a></blockquote>
<!-- Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
End: -->
</div>
</div>
</body>
</html>

Copyright (c) 2011 Zope Foundation. All rights reserved.
Legal | Contact
If you can read this text, it means you are not experiencing the Plone design at its best.
Plone makes heavy use of CSS, which means it is accessible to any internet browser,
but the design needs a
standards-compliant browser to look like we intended it.
Just so you know ;)