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