[Checkins] SVN: relstorage/trunk/ Fixed reStructuredText formatting (thank you Marius for restview!)

Shane Hathaway shane at hathawaymix.org
Tue Jan 27 00:31:03 EST 2009


Log message for revision 95068:
  Fixed reStructuredText formatting (thank you Marius for restview!)
  

Changed:
  U   relstorage/trunk/CHANGES.txt
  U   relstorage/trunk/README.txt

-=-
Modified: relstorage/trunk/CHANGES.txt
===================================================================
--- relstorage/trunk/CHANGES.txt	2009-01-27 05:00:01 UTC (rev 95067)
+++ relstorage/trunk/CHANGES.txt	2009-01-27 05:31:02 UTC (rev 95068)
@@ -43,6 +43,7 @@
 
 - In MySQL, Use DROP TABLE IF EXISTS instead of TRUNCATE to clear 'temp_store'
   because:
+
   - TRUNCATE has one page of caveats in the MySQL documentation.
   - TEMPORARY TABLEs have half a page of caveats when it comes to
     replication.

Modified: relstorage/trunk/README.txt
===================================================================
--- relstorage/trunk/README.txt	2009-01-27 05:00:01 UTC (rev 95067)
+++ relstorage/trunk/README.txt	2009-01-27 05:31:02 UTC (rev 95068)
@@ -2,45 +2,37 @@
 Overview
 ========
 
-  RelStorage is a storage implementation for ZODB that stores pickles in a
+RelStorage is a storage implementation for ZODB that stores pickles in a
 relational database.  PostgreSQL 8.1 and above (via psycopg2), MySQL 5.0.x (via
 MySQLdb 1.2.2 and above), and Oracle 10g (via cx_Oracle) are currently
-supported.
+supported.  RelStorage replaces the PGStorage project.
 
-  RelStorage replaces the PGStorage project.
 
-  See:
-
-     http://wiki.zope.org/ZODB/RelStorage         (wiki)
-     http://shane.willowrise.com/                 (blog)
-     http://pypi.python.org/pypi/RelStorage       (PyPI entry and downloads)
-
-
 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 and packing.
-  * Free, open source (ZPL 2.1)
+* 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 and packing.
+* Free, open source (ZPL 2.1)
 
 
-Installation in Zope
-====================
+Installation
+============
 
-  You can install RelStorage using easy_install::
+You can install RelStorage using easy_install::
 
     easy_install RelStorage
 
-  If you are not using easy_install (part of the setuptools package), you can
+If you are not using easy_install (part of the setuptools package), you can
 get the latest release at PyPI (http://pypi.python.org/pypi/RelStorage), then
 place the relstorage package in the lib/python directory of either the
 SOFTWARE_HOME or the INSTANCE_HOME.  You can do this with the following
@@ -48,21 +40,21 @@
 
     python2.4 setup.py install --install-lib=${INSTANCE_HOME}/lib/python
 
-  RelStorage requires a version of ZODB with the invalidation polling patch
+RelStorage requires a version of ZODB with the invalidation polling patch
 applied.  You can get versions of ZODB with the patch already applied here:
 
     http://packages.willowrise.org
 
-  The patches are also included in the source distribution of RelStorage.
+The patches are also included in the source distribution of RelStorage.
 
-  You need the Python database adapter that corresponds with your database. 
+You need the Python database adapter that corresponds with your database.
 Install psycopg2, MySQLdb 1.2.2+, or cx_Oracle 4.3+.  Note that Debian Etch
 ships MySQLdb 1.2.1, but that version has a bug in BLOB handling that manifests
 itself only with certain character set configurations.  MySQLdb 1.2.2 fixes the
 bug.  Also, MySQL 5.1.23 has major bugs that lead to loss of data when packing,
 so MySQL 5.1 is not recommended at this time.
 
-  Finally, modify etc/zope.conf of your Zope instance.  Remove the main mount
+Finally, modify etc/zope.conf of your Zope instance.  Remove the main mount
 point and add one of the following blocks.  For PostgreSQL::
 
     %import relstorage
@@ -76,7 +68,7 @@
       </relstorage>
     </zodb_db>
 
-  For MySQL::
+For MySQL::
 
     %import relstorage
     <zodb_db main>
@@ -90,7 +82,7 @@
       </relstorage>
     </zodb_db>
 
-  For Oracle (10g XE in this example)::
+For Oracle (10g XE in this example)::
 
     %import relstorage
     <zodb_db main>
@@ -107,62 +99,64 @@
 Migrating from FileStorage
 ==========================
 
-  You can convert a FileStorage instance to RelStorage and back using a utility
+You can convert a FileStorage instance to RelStorage and back using a utility
 called ZODBConvert.  See http://wiki.zope.org/ZODB/ZODBConvert .
 
 
 Migrating from PGStorage
 ========================
 
-  The following script migrates your database from PGStorage to RelStorage 1.0
+The following script migrates your database from PGStorage to RelStorage 1.0
 beta:
 
     migrate.sql_
 
-    .. _migrate.sql:
-http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate.sql
+    .. _migrate.sql: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate.sql
 
-  After you do this, you still need to migrate from 1.0 beta to the latest
+After you do this, you still need to migrate from 1.0 beta to the latest
 release.
 
 
 Migrating to a new version of RelStorage
 ========================================
 
-  Sometimes RelStorage needs a schema modification along with a software
+Sometimes RelStorage needs a schema modification along with a software
 upgrade.  Hopefully, this will not often be necessary.
 
-  To migrate from version 1.1.1 to version 1.1.2, see:
+To migrate from version 1.1.1 to version 1.1.2, see:
 
-    migrate-to-1.1.2.txt_
+  migrate-to-1.1.2.txt_
 
-    .. _migrate-to-1.1.2.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.1.2.txt
+  .. _migrate-to-1.1.2.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.1.2.txt
 
-  To migrate from version 1.1 to version 1.1.1, see:
+To migrate from version 1.1 to version 1.1.1, see:
 
-    migrate-to-1.1.1.txt_
+  migrate-to-1.1.1.txt_
 
-    .. _migrate-to-1.1.1.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.1.1.txt
+  .. _migrate-to-1.1.1.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.1.1.txt
 
-  To migrate from version 1.0.1 to version 1.1, see:
+To migrate from version 1.0.1 to version 1.1, see:
 
-    migrate-to-1.1.txt_
+  migrate-to-1.1.txt_
 
-    .. _migrate-to-1.1.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.1.txt
+  .. _migrate-to-1.1.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.1.txt
 
-  To migrate from version 1.0 beta to version 1.0c1 through 1.0.1, see:
+To migrate from version 1.0 beta to version 1.0c1 through 1.0.1, see:
 
-    migrate-to-1.0.txt_
+  migrate-to-1.0.txt_
 
-    .. _migrate-to-1.0.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.0.txt
+  .. _migrate-to-1.0.txt: http://svn.zope.org/*checkout*/relstorage/trunk/notes/migrate-to-1.0.txt
 
 
 Optional Features
 =================
 
-    Specify these options in zope.conf.
+Specify these options in zope.conf, as parameters for the RelStorage
+constructor, or as attributes of a relstorage.Options instance.
+In the latter two cases, use underscores instead of dashes in the
+parameter names.
 
-    poll-interval
+poll-interval
 
         Defer polling the database for the specified maximum time interval,
         in seconds.  Set to 0 (the default) to always poll.  Fractional
@@ -185,7 +179,7 @@
         affect database consistency, but does increase the probability
         of conflict errors, leading to low performance.
 
-    pack-gc
+pack-gc
 
         If pack-gc is false, pack operations do not perform
         garbage collection.  Garbage collection is enabled by default.
@@ -199,7 +193,7 @@
         Disabling garbage collection is also a hack that ensures
         inter-database references never break.
 
-    pack-dry-run
+pack-dry-run
 
         If pack-dry-run is true, pack operations perform a full analysis
         of what to pack, but no data is actually removed.  After a dry run,
@@ -207,7 +201,7 @@
         with the list of object states and objects that would have been
         removed.
 
-    pack-batch-timeout
+pack-batch-timeout
 
         Packing occurs in batches of transactions; this specifies the
         timeout in seconds for each batch.  Note that some database
@@ -215,7 +209,7 @@
         and might stall much longer than the timeout.
         The default timeout is 5.0 seconds.
 
-    pack-duty-cycle
+pack-duty-cycle
 
         After each batch, the pack code pauses for a time to
         allow concurrent transactions to commit.  The pack-duty-cycle
@@ -229,14 +223,14 @@
         The default is 0.5.  Raise it to finish packing faster; lower it
         to reduce the effect of packing on transaction commit performance.
 
-    pack-max-delay
+pack-max-delay
 
         This specifies a maximum delay between pack batches.  Sometimes
         the database takes an extra long time to finish a pack batch; at
         those times it is useful to cap the delay imposed by the
         pack-duty-cycle.  The default is 20 seconds.
 
-    cache-servers
+cache-servers
 
         Specifies a list of memcache servers.  Enabling memcache integration
         is useful if the connection to the relational database has high
@@ -249,7 +243,7 @@
         "127.0.0.1:11211" is a common setting.  The default is to disable
         memcache integration.
 
-    cache-module-name
+cache-module-name
 
         Specifies which Python memcache module to use.  The default is
         "memcache", a pure Python module.  There are several alternative
@@ -259,15 +253,15 @@
 Development
 ===========
 
-  You can checkout from Subversion using the following command::
+You can checkout from Subversion using the following command::
 
     svn co svn://svn.zope.org/repos/main/relstorage/trunk RelStorage
 
-  You can also browse the code:
+You can also browse the code:
 
     http://svn.zope.org/relstorage/trunk/
 
-  The best place to discuss development of RelStorage is on the zodb-dev
+The best place to discuss development of RelStorage is on the zodb-dev
 mailing list.
 
 
@@ -275,33 +269,41 @@
 FAQs
 ====
 
-  Q: How can I help improve RelStorage?
+Q: How can I help improve RelStorage?
 
     A: The best way to help is to test and to provide database-specific
-expertise.  Ask questions about RelStorage on the zodb-dev mailing list.
+    expertise.  Ask questions about RelStorage on the zodb-dev mailing list.
 
-  Q: Can I perform SQL queries on the data in the database?
+Q: Can I perform SQL queries on the data in the database?
 
     A: No.  Like FileStorage and DirectoryStorage, RelStorage stores the data
-as pickles, making it hard for anything but ZODB to interpret the data.  An
-earlier project called Ape attempted to store data in a truly relational way,
-but it turned out that Ape worked too much against ZODB principles and
-therefore could not be made reliable enough for production use.  RelStorage, on
-the other hand, is much closer to an ordinary ZODB storage, and is therefore
-much safer for production use.
+    as pickles, making it hard for anything but ZODB to interpret the data.  An
+    earlier project called Ape attempted to store data in a truly relational
+    way, but it turned out that Ape worked too much against ZODB principles and
+    therefore could not be made reliable enough for production use.  RelStorage,
+    on the other hand, is much closer to an ordinary ZODB storage, and is
+    therefore much safer for production use.
 
-  Q: How does RelStorage performance compare with FileStorage?
+Q: How does RelStorage performance compare with FileStorage?
 
     A: According to benchmarks, RelStorage with PostgreSQL is often faster than
-FileStorage, especially under high concurrency.
+    FileStorage, especially under high concurrency.
 
-  Q: Why should I choose RelStorage?
+Q: Why should I choose RelStorage?
 
     A: Because RelStorage is a fairly small layer that builds on world-class
-databases.  These databases have proven reliability and scalability, along with
-numerous support options.
+    databases.  These databases have proven reliability and scalability, along
+    with numerous support options.
 
-  Q: Can RelStorage replace ZRS (Zope Replication Services)?
+Q: Can RelStorage replace ZRS (Zope Replication Services)?
 
     A: In theory, yes.  With RelStorage, you can use the replication features
-native to your database.  However, this capability has not yet been tested.
+    native to your database.  However, this capability has not yet been tested.
+
+
+Project URLs
+============
+
+* http://wiki.zope.org/ZODB/RelStorage         (wiki)
+* http://shane.willowrise.com/                 (blog)
+* http://pypi.python.org/pypi/RelStorage       (PyPI entry and downloads)



More information about the Checkins mailing list