annotate doc/mysql.txt @ 1901:5c6f3da9856f maint-0.6

Merge back doc changes from HEAD.
author Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
date Thu, 06 Nov 2003 12:33:55 +0000
parents 5a28eea9a33c
children
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
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
5 :version: $Revision: 1.4.2.1 $
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
6
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@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
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
16 1. MySQL RDBMS 4.0 or higher - http://www.mysql.com. Your MySQL
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
17 installation MUST support InnoDB tables (or Berkeley DB (BDB) tables
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
18 if you have no other choice)
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
19 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
20
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
21
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
22 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
23 =======================
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
24
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
25 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
26 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
27
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
28 1. If you have root permissions on the MySQL server, you can create
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
29 the necessary database entries using the follwing SQL sequence. Use
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
30 ``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
31
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
32 CREATE DATABASE rounduptest;
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
33 USE rounduptest;
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
34 GRANT ALL PRIVILEGES ON rounduptest.* TO rounduptest@localhost
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
35 IDENTIFIED BY 'rounduptest';
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
36 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
37
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
38 2. If your administrator has provided you with database connection info,
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
39 you can modify MYSQL_* constants in the file test/test_db.py with
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
40 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
41
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
42 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
43 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
44
8429095241d7 mysql tests will not be run if there is no chance of passing.
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
diff changeset
45
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
46 Additional configuration
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
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
49 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
50 file (config.py in the tracker's home directory) should have the following
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
51 entries::
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
52
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
53 MYSQL_DBHOST = 'localhost'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
54 MYSQL_DBUSER = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
55 MYSQL_DBPASSWORD = 'rounduptest'
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
56 MYSQL_DBNAME = 'rounduptest'
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
57 MYSQL_DATABASE = ( MYSQL_DBHOST, MYSQL_DBUSER, MYSQL_DBPASSWORD,
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
58 MYSQL_DBNAME )
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
59
1706
5a28eea9a33c rewrite to fix english.
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents: 1705
diff changeset
60 Fill in the first four entries with values for your local MySQL installation
1901
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
61 before running "roundup-admin initialise". Use the commands in the `Running the
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
62 MySQL tests` to set up a database if you have privilege, or ask your local
5c6f3da9856f Merge back doc changes from HEAD.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1706
diff changeset
63 administrator if not.
1434
b953750bdc04 trackers on mysql can be initialised
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1433
diff changeset
64

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