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