Work in progress creating a repo
[timetracker.git] / mysql.sql
1 # Usage: 
2 # 1) Create a database using the "CREATE DATABASE" mysql command.
3 # 2) Then, execute this script from command prompt with a command like this:
4 # mysql -h host -u user -p -D db_name < mysql.sql
5
6 # create database timetracker character set = 'utf8';
7
8 # use timetracker;
9
10
11 #
12 # Structure for table tt_teams. A team is a group of users for whom we are tracking work time.
13 # This table stores settings common to all team members such as language, week start day, etc.
14 #
15 CREATE TABLE `tt_teams` (
16   `id` int(11) NOT NULL auto_increment,                  # team id
17   `timestamp` timestamp NOT NULL,                        # modification timestamp
18   `name` varchar(80) default NULL,                       # team name
19   `address` varchar(255) default NULL,                   # team address, used in invoices
20   `currency` varchar(7) default NULL,                    # team currency symbol
21   `decimal_mark` char(1) NOT NULL default '.',           # separator in decimals
22   `locktime` int(4) default '0',                         # lock interval in days
23   `lang` varchar(10) NOT NULL default 'en',              # language
24   `date_format` varchar(20) NOT NULL default '%Y-%m-%d', # date format
25   `time_format` varchar(20) NOT NULL default '%H:%M',    # time format
26   `week_start` smallint(2) NOT NULL DEFAULT '0',         # Week start day, 0 == Sunday.
27   `tracking_mode` smallint(2) NOT NULL DEFAULT '1',      # tracking mode ("projects" or "projects and tasks")
28   `record_type` smallint(2) NOT NULL DEFAULT '0',        # time record type ("start and finish", "duration", or both)
29   `plugins` varchar(255) default NULL,                   # a list of enabled plugins for team
30   `custom_logo` tinyint(4) default '0',                  # whether to use a custom logo or not
31   `status` tinyint(4) default '1',                       # team status
32   PRIMARY KEY (`id`)
33 );
34
35
36 #
37 # Structure for table tt_users. This table is used to store user properties.
38 #
39 CREATE TABLE `tt_users` (
40   `id` int(11) NOT NULL auto_increment,          # user id
41   `timestamp` timestamp NOT NULL,                # modification timestamp
42   `login` varchar(50) COLLATE utf8_bin NOT NULL, # user login
43   `password` varchar(50) default NULL,           # password hash
44   `name` varchar(100) default NULL,              # user name
45   `team_id` int(11) NOT NULL,                    # team id
46   `role` int(11) default '4',                    # user role ("manager", "co-manager", "client", or "user")
47   `client_id` int(11) default NULL,              # client id for "client" user role
48   `rate` float(6,2) NOT NULL default '0.00',     # default hourly rate
49   `email` varchar(100) default NULL,             # user email
50   `status` tinyint(4) default '1',               # user status
51   PRIMARY KEY (`id`)
52 );
53
54 # Create an index that guarantees unique active and inactive logins.
55 create unique index login_idx on tt_users(login, status);
56
57 # Create admin account with password 'secret'. Admin is a superuser, who can create teams.
58 DELETE from `tt_users` WHERE login = 'admin';
59 INSERT INTO `tt_users` (`login`, `password`, `name`, `team_id`, `role`) VALUES ('admin', md5('secret'), 'Admin', '0', '1024');
60
61
62 #
63 # Structure for table tt_projects.
64 #
65 CREATE TABLE `tt_projects` (
66   `id` int(11) NOT NULL auto_increment,         # project id
67   `team_id` int(11) NOT NULL,                   # team id
68   `name` varchar(80) COLLATE utf8_bin NOT NULL, # project name
69   `description` varchar(255) default NULL,      # project description
70   `tasks` text default NULL,                    # comma-separated list of task ids associated with this project
71   `status` tinyint(4) default '1',                              # project status
72   PRIMARY KEY (`id`)
73 );
74
75 # Create an index that guarantees unique active and inactive projects per team.
76 create unique index project_idx on tt_projects(team_id, name, status);
77
78
79 #
80 # Structure for table tt_tasks.
81 #
82 CREATE TABLE `tt_tasks` (
83   `id` int(11) NOT NULL auto_increment,         # task id
84   `team_id` int(11) NOT NULL,                   # team id
85   `name` varchar(80) COLLATE utf8_bin NOT NULL, # task name
86   `description` varchar(255) default NULL,      # task description
87   `status` tinyint(4) default '1',              # task status
88   PRIMARY KEY (`id`)
89 );
90
91 # Create an index that guarantees unique active and inactive tasks per team.
92 create unique index task_idx on tt_tasks(team_id, name, status);
93
94
95 #
96 # Structure for table tt_user_project_binds. This table maps users to assigned projects.
97 #
98 CREATE TABLE `tt_user_project_binds` (
99   `id` int(11) NOT NULL auto_increment, # bind id
100   `user_id` int(11) NOT NULL,           # user id
101   `project_id` int(11) NOT NULL,        # project id
102   `rate` float(6,2) default '0.00',     # rate for this user when working on this project
103   `status` tinyint(4) default '1',      # bind status
104   PRIMARY KEY (`id`)
105 );
106
107 # Create an index that guarantees unique user to project binds.
108 create unique index bind_idx on tt_user_project_binds(user_id, project_id);
109
110
111 #
112 # Structure for table tt_project_task_binds. This table maps projects to assigned tasks.
113 #
114 CREATE TABLE `tt_project_task_binds` (
115   `project_id` int(11) NOT NULL, # project id    
116   `task_id` int(11) NOT NULL     # task id
117 );
118
119 # Indexes for tt_project_task_binds.
120 create index project_idx on tt_project_task_binds(project_id);
121 create index task_idx on tt_project_task_binds(task_id);
122
123
124 #
125 # Structure for table tt_log. This is the table where time entries for users are stored.
126 # If you use custom fields, additional info for each record may exist in tt_custom_field_log.
127 #
128 CREATE TABLE `tt_log` (
129   `id` bigint NOT NULL auto_increment, # time record id
130   `timestamp` timestamp NOT NULL,      # modification timestamp
131   `user_id` int(11) NOT NULL,          # user id
132   `date` date NOT NULL,                # date the record is for
133   `start` time default NULL,           # record start time (for example, 09:00)
134   `duration` time default NULL,        # record duration (for example, 1 hour)
135   `client_id` int(11) default NULL,    # client id
136   `project_id` int(11) default NULL,   # project id
137   `task_id` int(11) default NULL,      # task id
138   `invoice_id` int(11) default NULL,   # invoice id
139   `comment` blob,                      # user provided comment for time record
140   `billable` tinyint(4) default '0',   # whether the record is billable or not
141   `status` tinyint(4) default '1',     # time record status
142   PRIMARY KEY (`id`)
143 );
144
145 # Create indexes on tt_log for performance.
146 create index date_idx on tt_log(date);
147 create index user_idx on tt_log(user_id);
148 create index client_idx on tt_log(client_id);
149 create index invoice_idx on tt_log(invoice_id);
150 create index project_idx on tt_log(project_id);
151 create index task_idx on tt_log(task_id);
152
153
154 #
155 # Structure for table tt_invoices. Invoices are issued to clients for billable work.
156 #
157 CREATE TABLE `tt_invoices` (
158   `id` int(11) NOT NULL auto_increment,         # invoice id
159   `team_id` int(11) NOT NULL,                   # team id
160   `name` varchar(80) COLLATE utf8_bin NOT NULL, # invoice name
161   `date` date NOT NULL,                         # invoice date
162   `client_id` int(11) NOT NULL,                 # client id
163   `status` tinyint(4) default '1',              # invoice status
164   PRIMARY KEY (`id`)
165 );
166
167 # Create an index that guarantees unique invoice names per team.
168 create unique index name_idx on tt_invoices(team_id, name, status);
169
170
171 #
172 # Structure for table tt_tmp_refs. Used for reset password mechanism.
173 #
174 CREATE TABLE `tt_tmp_refs` (
175   `timestamp` timestamp NOT NULL,     # creation timestamp
176   `ref` char(32) NOT NULL default '', # unique reference for user, used in urls
177   `user_id` int(11) NOT NULL          # user id
178 );
179
180
181 #
182 # Structure for table tt_fav_reports. Favorite reports are pre-configured report configurations.
183 #
184 CREATE TABLE `tt_fav_reports` (
185   `id` int(11) NOT NULL auto_increment,                  # favorite report id
186   `name` varchar(200) NOT NULL,                          # favorite report name
187   `user_id` int(11) NOT NULL,                            # user id favorite report belongs to
188   `client_id` int(11) default NULL,                      # client id (if selected)
189   `cf_1_option_id` int(11) default NULL,                 # custom field 1 option id (if selected)
190   `project_id` int(11) default NULL,                     # project id (if selected)
191   `task_id` int(11) default NULL,                        # task id (if selected)
192   `billable` tinyint(4) default NULL,                    # whether to include billable, not billable, or all records
193   `invoice` tinyint(4) default NULL,                     # whether to include invoiced, not invoiced, or all records
194   `users` text default NULL,                             # Comma-separated list of user ids. Nothing here means "all" users. 
195   `period` tinyint(4) default NULL,                      # selected period type for report
196   `period_start` date default NULL,                      # period start
197   `period_end` date default NULL,                        # period end
198   `show_client` tinyint(4) NOT NULL default '0',         # whether to show client column
199   `show_invoice` tinyint(4) NOT NULL default '0',        # whether to show invoice column  
200   `show_project` tinyint(4) NOT NULL default '0',        # whether to show project column
201   `show_start` tinyint(4) NOT NULL default '0',          # whether to show start field
202   `show_duration` tinyint(4) NOT NULL default '0',       # whether to show duration field
203   `show_cost` tinyint(4) NOT NULL default '0',           # whether to show cost field  
204   `show_task` tinyint(4) NOT NULL default '0',           # whether to show task column
205   `show_end` tinyint(4) NOT NULL default '0',            # whether to show end field
206   `show_note` tinyint(4) NOT NULL default '0',           # whether to show note column
207   `show_custom_field_1` tinyint(4) NOT NULL default '0', # whether to show custom field 1
208   `show_totals_only` tinyint(4) NOT NULL default '0',    # whether to show totals only
209   `group_by` varchar(20) default NULL,                   # group by field
210   PRIMARY KEY (`id`)
211 );
212
213
214 #
215 # Structure for table tt_cron. It is used to email favorite reports on schedule.
216 #
217 CREATE TABLE `tt_cron` (
218   `id` int(11) NOT NULL auto_increment,         # entry id
219   `team_id` int(11) NOT NULL,                   # team id
220   `cron_spec` varchar(255) NOT NULL,            # cron specification, "0 1 * * *" for "daily at 01:00"
221   `last` int(11) default NULL,                  # UNIX timestamp of when job was last run
222   `next` int(11) default NULL,                  # UNIX timestamp of when to run next job
223   `report_id` int(11) default NULL,             # report id from tt_fav_reports, a report to mail on schedule
224   `email` varchar(100) default NULL,            # email to send results to
225   `status` tinyint(4) default '1',              # entry status
226   PRIMARY KEY (`id`)
227 );
228
229
230 #
231 # Structure for table tt_clients. A client is an entity for whom work is performed and who may be invoiced.
232 #
233 CREATE TABLE `tt_clients` (
234   `id` int(11) NOT NULL AUTO_INCREMENT,         # client id
235   `team_id` int(11) NOT NULL,                   # team id
236   `name` varchar(80) COLLATE utf8_bin NOT NULL, # client name
237   `address` varchar(255) default NULL,          # client address
238   `tax` float(6,2) default '0.00',              # applicable tax for this client
239   `projects` text default NULL,                 # comma-separated list of project ids assigned to this client
240   `status` tinyint(4) default '1',              # client status
241   PRIMARY KEY (`id`)
242 );
243
244 # Create an index that guarantees unique active and inactive clients per team.
245 create unique index client_name_idx on tt_clients(team_id, name, status);
246
247
248 #
249 # Structure for table tt_client_project_binds. This table maps clients to assigned projects.
250 #
251 CREATE TABLE `tt_client_project_binds` (
252   `client_id` int(11) NOT NULL, # client id
253   `project_id` int(11) NOT NULL # project id
254 );
255
256 # Indexes for tt_client_project_binds.
257 create index client_idx on tt_client_project_binds(client_id);
258 create index project_idx on tt_client_project_binds(project_id);
259
260
261 #
262 # Structure for table tt_config. This table is used to store configuration info for users.
263 # For example, last_report_email parameter stores an email for user last report was emailed to.
264 #
265 CREATE TABLE `tt_config` (
266   `user_id` int(11) NOT NULL,            # user id
267   `param_name` varchar(32) NOT NULL,     # parameter name
268   `param_value` varchar(80) default NULL # parameter value
269 );
270
271 # Create an index that guarantees unique parameter names per user.
272 create unique index param_idx on tt_config(user_id, param_name);
273
274
275 # Below are the tables used by CustomFields plugin.
276
277 #
278 # Structure for table tt_custom_fields. This table contains definitions of custom fields.
279 #
280 CREATE TABLE `tt_custom_fields` (
281   `id` int(11) NOT NULL auto_increment,    # custom field id
282   `team_id` int(11) NOT NULL,              # team id
283   `type` tinyint(4) NOT NULL default '0',  # custom field type (text or dropdown)
284   `label` varchar(32) NOT NULL default '', # custom field label
285   `required` tinyint(4) default '0',       # whether this custom field is mandatory for time records
286   `status` tinyint(4) default '1',         # custom field status
287   PRIMARY KEY  (`id`)
288 );
289
290
291 #
292 # Structure for table tt_custom_field_options. This table defines options for dropdown custom fields.
293 #
294 CREATE TABLE `tt_custom_field_options` (
295   `id` int(11) NOT NULL auto_increment,    # option id
296   `field_id` int(11) NOT NULL,             # custom field id              
297   `value` varchar(32) NOT NULL default '', # option value
298   PRIMARY KEY  (`id`)
299 );
300
301
302 #
303 # Structure for table tt_custom_field_log.
304 # This table supplements tt_log and contains custom field values for records.
305 #
306 CREATE TABLE `tt_custom_field_log` (
307   `id` bigint NOT NULL auto_increment, # cutom field log id
308   `log_id` bigint NOT NULL,            # id of a record in tt_log this record corresponds to
309   `field_id` int(11) NOT NULL,         # custom field id
310   `option_id` int(11) default NULL,    # Option id. Used for dropdown custom fields.
311   `value` varchar(255) default NULL,   # Text value. Used for text custom fields.
312   `status` tinyint(4) default '1',     # custom field log entry status
313   PRIMARY KEY  (`id`)
314 );
315
316
317 #
318 # Structure for table tt_expense_items.
319 # This table lists expense items.
320 #
321 CREATE TABLE `tt_expense_items` (
322   `id` bigint NOT NULL auto_increment, # expense item id
323   `date` date NOT NULL,                # date the record is for
324   `user_id` int(11) NOT NULL,          # user id the expense item is reported by
325   `client_id` int(11) default NULL,    # client id
326   `project_id` int(11) default NULL,   # project id
327   `name` varchar(255) NOT NULL,        # expense item name (what is an expense for)
328   `cost` decimal(10,2) default '0.00', # item cost (including taxes, etc.)
329   `invoice_id` int(11) default NULL,   # invoice id
330   `status` tinyint(4) default '1',     # item status
331   PRIMARY KEY  (`id`)
332 );
333
334 # Create indexes on tt_expense_items for performance.
335 create index date_idx on tt_expense_items(date);
336 create index user_idx on tt_expense_items(user_id);
337 create index client_idx on tt_expense_items(client_id);
338 create index project_idx on tt_expense_items(project_id);
339 create index invoice_idx on tt_expense_items(invoice_id);