annotate doc/mysql.txt @ 2119:cc4667ef3f12

Added the ability to toggle where error messages go. They either go to the user (default, for backwards compatibility), the dispatcher, or both. These are able to be toggled via settings in config.py. Please refer to upgrading.txt for more details. (And Richard, let me know if I've done anything wrong with this checkin. :))
author Eddie Parker <eparker@users.sourceforge.net>
date Thu, 25 Mar 2004 19:27:15 +0000
parents dbb78664e427
children ef226254ef46 096063697f77
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
1 =============
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
2 MySQL Backend
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
3 =============
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
4
2067
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
5 :version: $Revision: 1.8 $
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
6
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
7 This notes detail the MySQL backend for the Roundup issue tracker.
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
8
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
9
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
10 Prerequisites
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
11 =============
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
12
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
13 To use MySQL as the backend for storing roundup data, you also need
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
14 to install:
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
15
1913
d929c31a3620 clarified minimum version required for MySQL backend (4.0.16)
Richard Jones <richard@users.sourceforge.net>
parents: 1912
diff changeset
16 1. MySQL RDBMS 4.0.16 or higher - http://www.mysql.com. Your MySQL
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
17 installation MUST support InnoDB tables (or Berkeley DB (BDB) tables
1913
d929c31a3620 clarified minimum version required for MySQL backend (4.0.16)
Richard Jones <richard@users.sourceforge.net>
parents: 1912
diff changeset
18 if you have no other choice). If you're running < 4.0.16 (but not <4.0)
d929c31a3620 clarified minimum version required for MySQL backend (4.0.16)
Richard Jones <richard@users.sourceforge.net>
parents: 1912
diff changeset
19 then you'll need to use BDB to pass all unit tests. Edit the
d929c31a3620 clarified minimum version required for MySQL backend (4.0.16)
Richard Jones <richard@users.sourceforge.net>
parents: 1912
diff changeset
20 ``roundup/backends/back_mysql.py`` file to enable DBD instead of InnoDB.
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
21 2. Python MySQL interface - http://sourceforge.net/projects/mysql-python
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
22
1912
2b0ab61db194 fixes for [SF#818339]
Richard Jones <richard@users.sourceforge.net>
parents: 1839
diff changeset
23 :Note: the InnoDB implementation has a bug that Roundup tickles. See
2b0ab61db194 fixes for [SF#818339]
Richard Jones <richard@users.sourceforge.net>
parents: 1839
diff changeset
24 http://bugs.mysql.com/bug.php?id=1810
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
25
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
26 Running the MySQL tests
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
27 =======================
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
28
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
29 Roundup tests expect an empty MySQL database. Two alternate ways to provide
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
30 this:
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
31
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
32 1. If you have root permissions on the MySQL server, you can create
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
33 the necessary database entries using the follwing SQL sequence. Use
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
34 ``mysql`` on the command line to enter::
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
35
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
36 CREATE DATABASE rounduptest;
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
37 USE rounduptest;
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
38 GRANT ALL PRIVILEGES ON rounduptest.* TO rounduptest@localhost
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
39 IDENTIFIED BY 'rounduptest';
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
40 FLUSH PRIVILEGES;
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
41
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
42 2. If your administrator has provided you with database connection info,
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
43 you can modify MYSQL_* constants in the file test/test_db.py with
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
44 the correct values.
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
45
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
46 Note that the MySQL database should not contain any tables. Tests will not
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
47 drop the database with existing data.
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
48
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
49
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
50 Additional configuration
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
51 ========================
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
52
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
53 To initialise and use the MySQL database backend, roundup's configuration
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
54 file (config.py in the tracker's home directory) should have the following
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
55 entries::
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
56
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
57 MYSQL_DBHOST = 'localhost'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
58 MYSQL_DBUSER = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
59 MYSQL_DBPASSWORD = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
60 MYSQL_DBNAME = 'rounduptest'
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
61 MYSQL_DATABASE = ( MYSQL_DBHOST, MYSQL_DBUSER, MYSQL_DBPASSWORD,
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
62 MYSQL_DBNAME )
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
63
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
64 Fill in the first four entries with values for your local MySQL installation
1839
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
65 before running "roundup-admin initialise". Use the commands in the `Running the
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
66 MySQL tests` to set up a database if you have privilege, or ask your local
06f5b36b201b Fix a couple of failures in mysql backend unit tests.
Richard Jones <richard@users.sourceforge.net>
parents: 1706
diff changeset
67 administrator if not.
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
68
2067
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
69
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
70 Showing MySQL who's boss
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
71 ========================
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
72
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
73 If things ever get to the point where that test database is totally hosed,
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
74 just::
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
75
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
76 $ su -
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
77 # /etc/init.d/mysql stop
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
78 # rm -rf /var/lib/mysql/rounduptest
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
79 # /etc/init.d/mysql start
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
80
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
81 and all will be better (note that on some systems, ``mysql`` is spelt
dbb78664e427 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1913
diff changeset
82 ``mysqld``).

Roundup Issue Tracker: http://roundup-tracker.org/