Code

trackers on mysql can be initialised
[roundup.git] / doc / mysql.txt
1 =============
2 MySQL Backend
3 =============
5 This is notes about mysql backend for roundup issue tracker.
8 Prerequisites
9 =============
11 To use MySQL as backend for storing roundup data, you should additionally
12 install:
14     1. MySQL RDBMS 3.23.34 or higher - http://www.mysql.com. Your MySQL
15        installation should support Berkeley DB (BDB) tabes for transaction
16        support.
17     2. Python interface to mysql - http://sourceforge.net/projects/mysql-python
20 How to run mysql tests?
21 =======================
23 Roundup tests expect empty database available for use. There are two ways how to
24 provide it:
26     1. If you have root permissions on mysql server, you can create necessary
27        database using this SQL sequence:
29        CREATE DATABASE rounduptest
30        GRANT ALL PRIVILEGES ON rounduptest TO rounduptest@localhost IDENTIFIED BY 'rounduptest'
31        FLUSH PRIVILEGES
33     2. If your administrator has provided you with database connection info, you
34        can modify MYSQL_* constants in test/test_db.py with corresponding
35        values.
37 Note, that mysql database should not contain any tables. Tests will not dare to
38 drop database with data.
41 Additional configuration
42 ========================
44 To initialise and use mysql database roundup' configuration file (config.py in
45 the tracker' home directory) should be appended with the following constants:
47     MYSQL_DBHOST = 'localhost'
48     MYSQL_DBUSER = 'rounduptest'
49     MYSQL_DBPASSWORD = 'rounduptest'
50     MYSQL_DBNAME = 'rounduptest'
51     MYSQL_DATABASE = ( MYSQL_DBHOST, MYSQL_DBUSER, MYSQL_DBPASSWORD, MYSQL_DBNAME )
53 Fill first four constants with real values before running 
54 "roundup-admin initialise". 
58     Andrey Lebedev <andrey@micro.lt>
61  vim: et tw=80