annotate doc/mysql.txt @ 1780:d2801a2b0a77

Initial implementation (half-baked) at new Tracker instance. Cleaned up caching API / comments in backends. Fixes to docs.
author Richard Jones <richard@users.sourceforge.net>
date Thu, 04 Sep 2003 00:47:01 +0000
parents 5a28eea9a33c
children 06f5b36b201b 5c6f3da9856f
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
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
5 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
6
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
7
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
8 Prerequisites
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
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
11 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
12 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
13
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
14 1. MySQL RDBMS 3.23.34 or higher - http://www.mysql.com. Your MySQL
1705
1fb2e44d02e3 english nits
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1434
diff changeset
15 installation should support Berkeley DB (BDB) tables for transaction
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
16 support.
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
17 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
18
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
19
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
20 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
21 =======================
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
22
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
23 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
24 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
25
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
26 1. If you have root permissions on the MySQL server, you can create
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
27 the necessary database entries using this SQL sequence:
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
28
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
29 CREATE DATABASE rounduptest
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
30 GRANT ALL PRIVILEGES ON rounduptest TO rounduptest@localhost IDENTIFIED BY 'rounduptest'
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
31 FLUSH PRIVILEGES
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
32
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
33 2. If your administrator has provided you with database connection info,
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
34 you can modify MYSQL_* constants in the file test/test_db.py with
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
35 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
36
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
37 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
38 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
39
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
40
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
41 Additional configuration
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
42 ========================
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
43
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
44 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
45 file (config.py in the tracker's home directory) should have the following
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
46 entries:
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
47
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
48 MYSQL_DBHOST = 'localhost'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
49 MYSQL_DBUSER = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
50 MYSQL_DBPASSWORD = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
51 MYSQL_DBNAME = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
52 MYSQL_DATABASE = ( MYSQL_DBHOST, MYSQL_DBUSER, MYSQL_DBPASSWORD, MYSQL_DBNAME )
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
53
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
54 Fill in the first four entries with values for your local MySQL installation
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
55 before running "roundup-admin initialise".
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
1433
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
58 Andrey Lebedev <andrey@micro.lt>
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
59
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
60
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
61 vim: et tw=80

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