doc/postgresql.txt

   1 ==========================
   2 PostgreSQL/psycopg Backend
   3 ==========================
   4
   5 This is notes about PostreSQL backend based on the psycopg adapter for
   6 roundup issue tracker.
   7
   8
   9 Prerequisites
  10 =============
  11
  12 To use PostgreSQL as backend for storing roundup data, you should
  13 additionally install:
  14
  15 1. PostgreSQL 7.x - http://www.postgresql.org/
  16
  17 2. The psycopg python interface to PostgreSQL:
  18    http://initd.org/software/initd/psycopg
  19
  20
  21 Running the PostgreSQL unit tests
  22 =================================
  23
  24 The user that you're running the tests as will need to be able to access
  25 the postgresql database on the local machine and create and drop
  26 databases. Edit the ``test/test_postgresql.py`` database connection info if
  27 you wish to test against a different database.
  28
  29 The test database will be called "rounduptest".
  30
  31
  32 Additional configuration
  33 ========================
  34
  35 To initialise and use PostgreSQL database roundup's configuration file
  36 (config.py in the tracker's home directory) should be appended with the
  37 following constants (substituting real values, obviously)::
  38
  39     POSTGRESQL_DATABASE = {'database': 'rounduptest'}
  40
  41 if not local, or a different user is to be used, then more information may
  42 be supplied::
  43
  44     POSTGRESQL_DATABASE = {
  45         'host': 'localhost', 'port': 5432,
  46         'database': 'roundup'
  47         'user': 'roundup', 'password': 'roundup',
  48     }
  49
  50 Also note that you can leave some values out of
  51 ``POSTGRESQL_DATABASE``: 'host' and 'port' are not necessary when
  52 connecting to a local database and 'password'
  53 is optional if postgres trusts local connections. The user specified in
  54 ``user`` must have rights to create a new database and to
  55 connect to the "template1" database, used while initializing roundup.
  56
  57     Have fun with psycopg,
  58     Federico Di Gregorio <fog@initd.org>
  59