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