Initial commit - migration of xonstatdb from MySQL to PostgreSQL.
[xonotic/xonstatdb.git] / README
1 This is the source for xonstatdb, the Xonotic Statistics database.
2 All code herein is intended for the PostgreSQL database management server.
3
4 To build, first create the user that will own all of the objects in the 
5 database. You must run this as an administrator user in your cluster.
6 See your operating system's guidelines for how this is set up on 
7 your system:
8     
9     create user xonstat with password 'xonstat';
10
11     *Note: please change this password
12
13 Next, create the database itself:
14
15     CREATE DATABASE xonstatdb
16       WITH ENCODING='UTF8'
17         OWNER=xonstat
18         CONNECTION LIMIT=-1;
19
20 Create the schema in which all of the xonstat tables will reside:
21
22 CREATE SCHEMA xonstat
23        AUTHORIZATION xonstat;
24
25 Navigate to the 'build' directory. Log into the database as the 
26 admin user created above and issue the following to build the
27 initial tables:
28
29     TODO
30
31 TODO:
32
33 - Define indexes
34 - Audit report SQL to verify index usage 
35 - Review datatypes to ensure no truncation occurs. 
36 - Review plurality in table names
37 - Review for usage of serial datatypes in foreign keys
38 - Review regular serials vs bigserials