Skip to content

Commit 8dfecd5

Browse files
author
Richard Jones
committed
rework the backend selection bit
1 parent 579bf46 commit 8dfecd5

File tree

1 file changed

+26
-35
lines changed

1 file changed

+26
-35
lines changed

doc/installation.txt

Lines changed: 26 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Installing Roundup
33
==================
44

5-
:Version: $Revision: 1.70 $
5+
:Version: $Revision: 1.71 $
66

77
.. contents::
88

@@ -259,43 +259,32 @@ Choosing Your Backend
259259
The actual storage of Roundup tracker information is handled by backends.
260260
There's several to choose from, each with benefits and limitations:
261261

262-
**anydbm**
263-
This backend is guaranteed to work on any system that Python runs on. It
264-
will generally choose the best dbm backend that is available on your system
265-
(from the list dbhash, gdbm, dbm, dumbdbm). It is the least scaleable of all
266-
backends, but performs well enough for a smallish tracker (a couple of
267-
thousand issues, under fifty users, ...).
268-
**bsddb**
269-
This effectively the same as anydbm, but uses the bsddb backend. This allows
270-
it to gain some performance and scaling benefits.
271-
**bsddb3**
272-
Again, this effectively the same as anydbm, but uses the bsddb3 backend.
273-
This allows it to gain some performance and scaling benefits.
274-
**sqlite**
275-
This uses the SQLite_ embedded RDBMS to provide a fast, scaleable backend.
276-
There are no limitations, and it's much faster and more scaleable than the
277-
dbm backends.
278-
**mysql**
279-
Backend for popular RDBMS MySQL. According to benchmarks, this backend works
280-
much faster than any of \*dbm ones, but slightly slower than metakit and
281-
sqlite. You must read doc/mysql.txt for additional installation steps and
282-
requirements.
262+
========== =========== ===== ==============================
263+
Name Speed Users Support
264+
========== =========== ===== ==============================
265+
anydbm Slowest Few Always available
266+
bsddb Slow Few Usually available
267+
sqlite Fastest(*) Few Needs install (SQLite_)
268+
metakit Fastest(*) Few Needs install (metakit_)
269+
postgresql Fast Many Needs install/admin (psycopg_)
270+
mysql Fast Many Needs install/admin (MySQLdb_)
271+
========== =========== ===== ==============================
272+
273+
**sqlite** and **metakit**
274+
These use the embedded database engines SQLite_ and metakit_ to provide
275+
very fast backends. They are not suitable for trackers which will have
276+
many simultaneous users.
283277
**postgresql**
284-
Backend for popular RDBMS PostgreSQL. According to benchmarks, this
285-
backend works much faster than any of \*dbm ones and mysql, but slightly
286-
slower than metakit and sqlite. You must read doc/postgresql.txt for
278+
Backend for popular RDBMS PostgreSQL. You must read doc/postgresql.txt for
287279
additional installation steps and requirements.
288-
**metakit**
289-
This backend is implemented over the metakit_ storage system, using Mk4Py as
290-
the interface. It scales much better than the dbm backends.
291-
292-
You should be wary of using all but the mysql backend with high-volume trackers
293-
(requests every second or two) as database locking is done on the whole
294-
database.
280+
**mysql**
281+
Backend for popular RDBMS MySQL. You must read doc/mysql.txt for additional
282+
installation steps and requirements.
295283

296-
You may set your tracker up with the anydbm backend (which is guaranteed to be
297-
available) and switch to one of the other backends at any time using the
298-
instructions in the `administration guide`_.
284+
You may defer your decision by setting your tracker up with the anydbm
285+
backend (which is guaranteed to be available) and switching to one of the
286+
other backends at any time using the instructions in the `administration
287+
guide`_.
299288

300289

301290
Configure a Web Interface
@@ -622,4 +611,6 @@ Next: `User Guide`_
622611
.. _`administration guide`: admin_guide.html
623612
.. _sqlite: http://www.hwaci.com/sw/sqlite/
624613
.. _metakit: http://www.equi4.com/metakit/
614+
.. _Psycopg: http://initd.org/software/initd/psycopg
615+
.. _MySQLdb: http://sourceforge.net/projects/mysql-python
625616

0 commit comments

Comments
 (0)