Subversion Repositories DevTools

Rev

Rev 1295 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1293 dpurdie 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 
<HTML
3 
><HEAD
4 
><TITLE
5 
>Database Schema</TITLE
6 
><META
7 
NAME="GENERATOR"
8 
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 
REL="HOME"
10 
TITLE="The Codestriker Guide"
11 
HREF="book1.html"><LINK
12 
REL="UP"
13 
TITLE="Hacking"
14 
HREF="c705.html"><LINK
15 
REL="PREVIOUS"
16 
TITLE="Hacking"
17 
HREF="c705.html"><LINK
18 
REL="NEXT"
19 
TITLE="Code Style Guide"
20 
HREF="x830.html"></HEAD
21 
><BODY
22 
CLASS="SECT1"
23 
BGCOLOR="#FFFFFF"
24 
TEXT="#000000"
25 
LINK="#0000FF"
26 
VLINK="#840084"
27 
ALINK="#0000FF"
28 
><DIV
29 
CLASS="NAVHEADER"
30 
><TABLE
31 
SUMMARY="Header navigation table"
32 
WIDTH="100%"
33 
BORDER="0"
34 
CELLPADDING="0"
35 
CELLSPACING="0"
36 
><TR
37 
><TH
38 
COLSPAN="3"
39 
ALIGN="center"
40 
>The Codestriker Guide: Version 1.9.3</TH
41 
></TR
42 
><TR
43 
><TD
44 
WIDTH="10%"
45 
ALIGN="left"
46 
VALIGN="bottom"
47 
><A
48 
HREF="c705.html"
49 
ACCESSKEY="P"
50 
>Prev</A
51 
></TD
52 
><TD
53 
WIDTH="80%"
54 
ALIGN="center"
55 
VALIGN="bottom"
56 
>Chapter 4. Hacking</TD
57 
><TD
58 
WIDTH="10%"
59 
ALIGN="right"
60 
VALIGN="bottom"
61 
><A
62 
HREF="x830.html"
63 
ACCESSKEY="N"
64 
>Next</A
65 
></TD
66 
></TR
67 
></TABLE
68 
><HR
69 
ALIGN="LEFT"
70 
WIDTH="100%"></DIV
71 
><DIV
72 
CLASS="SECT1"
73 
><H1
74 
CLASS="SECT1"
75 
><A
76 
NAME="AEN771"
77 
>4.2. Database Schema</A
78 
></H1
79 
><P
80 
>        The <TT
81 
CLASS="FILENAME"
82 
>bin/install.pl</TT
83 
> script contains the
84 
        <B
85 
CLASS="COMMAND"
86 
>CREATE TABLE</B
87 
> statements that are used when
88 
        the Codestriker database is initialised, in the
89 
        <CODE
90 
CLASS="VARNAME"
91 
>$table</CODE
92 
> hash.  The following tables are
93 
        defined:
94 
	<P
95 
></P
96 
><DIV
97 
CLASS="VARIABLELIST"
98 
><DL
99 
><DT
100 
>project</DT
101 
><DD
102 
><P
103 
>	        A Codestriker database can consist of a number of
104 
	        projects, which have a name, id, description and
105 
	        creation date.  Each code review topic, is linked to a
106 
	        specific project.
107 
	      </P
108 
></DD
109 
><DT
110 
>topic</DT
111 
><DD
112 
><P
113 
>	        A topic represents a code review that has been
114 
	        submitted to Codestriker.  It contains attributes like
115 
	        the author, title, description, creation date,
116 
	        repository, and is linked to a member project.
117 
	      </P
118 
></DD
119 
><DT
120 
>participant</DT
121 
><DD
122 
><P
123 
>	        A participant is associated with a topic, and contains
124 
	        an email address, and the type of participant they
125 
	        are, such as the author, reviewer or observer
126 
	        (somebody was is CC'ed for the review).
127 
	      </P
128 
></DD
129 
><DT
130 
>commentdata</DT
131 
><DD
132 
><P
133 
>	         A comment is made against a specific review, and
134 
	         consists of the author and the comment text itself.
135 
	         It is linked with a specific commentstate object.
136 
	      </P
137 
></DD
138 
><DT
139 
>commentstate</DT
140 
><DD
141 
><P
142 
>	        A commentstate row represents a comment block - a list
143 
		of comments made against a specific file and line
144 
		number.  The comment block has the notion of state,
145 
		whether it is marked "submitted", "complete" or
146 
		"invalid".
147 
	      </P
148 
></DD
149 
><DT
150 
>topicbug</DT
151 
><DD
152 
><P
153 
>	        This table records a many-to-many relationship between
154 
	        topics and bug ids.  A topic may fix more than one bug
155 
	        id, and likewise, a bug id can be fixed by many
156 
	        topics.
157 
	      </P
158 
></DD
159 
><DT
160 
>topicfile</DT
161 
><DD
162 
><P
163 
>	        A topic consists on many file objects, which contain a
164 
	        filename, revision number and an indicator as to
165 
	        whether it is a text or binary file.  A file consists
166 
	        of one or more delta objects.
167 
	      </P
168 
></DD
169 
><DT
170 
>delta</DT
171 
><DD
172 
><P
173 
>	        A delta is associated with a specific file object, and
174 
	        represents a single diff chunk or change.  It
175 
	        represents for file X, at line number Y, the following
176 
	        change is a part of the review.
177 
	      </P
178 
></DD
179 
><DT
180 
>topichistory</DT
181 
><DD
182 
><P
183 
>                Records a trail as to who modified what topic
184 
	        properties and when that occurred.
185 
	      </P
186 
></DD
187 
><DT
188 
>commentstatehistory</DT
189 
><DD
190 
><P
191 
>                Records a trail for the modification of
192 
                comment blocks.
193 
	      </P
194 
></DD
195 
><DT
196 
>topicviewhistory</DT
197 
><DD
198 
><P
199 
>                Records who has viewed a topic and when.
200 
	      </P
201 
></DD
202 
><DT
203 
>topicmetric</DT
204 
><DD
205 
><P
206 
>                Records the value of a metric against a specific topic.
207 
	      </P
208 
></DD
209 
><DT
210 
>topicusermetric</DT
211 
><DD
212 
><P
213 
>                Records the value of a metric against a specific topic
214 
                for a specific user.
215 
	      </P
216 
></DD
217 
></DL
218 
></DIV
219 
>
220 
      </P
221 
></DIV
222 
><DIV
223 
CLASS="NAVFOOTER"
224 
><HR
225 
ALIGN="LEFT"
226 
WIDTH="100%"><TABLE
227 
SUMMARY="Footer navigation table"
228 
WIDTH="100%"
229 
BORDER="0"
230 
CELLPADDING="0"
231 
CELLSPACING="0"
232 
><TR
233 
><TD
234 
WIDTH="33%"
235 
ALIGN="left"
236 
VALIGN="top"
237 
><A
238 
HREF="c705.html"
239 
ACCESSKEY="P"
240 
>Prev</A
241 
></TD
242 
><TD
243 
WIDTH="34%"
244 
ALIGN="center"
245 
VALIGN="top"
246 
><A
247 
HREF="book1.html"
248 
ACCESSKEY="H"
249 
>Home</A
250 
></TD
251 
><TD
252 
WIDTH="33%"
253 
ALIGN="right"
254 
VALIGN="top"
255 
><A
256 
HREF="x830.html"
257 
ACCESSKEY="N"
258 
>Next</A
259 
></TD
260 
></TR
261 
><TR
262 
><TD
263 
WIDTH="33%"
264 
ALIGN="left"
265 
VALIGN="top"
266 
>Hacking</TD
267 
><TD
268 
WIDTH="34%"
269 
ALIGN="center"
270 
VALIGN="top"
271 
><A
272 
HREF="c705.html"
273 
ACCESSKEY="U"
274 
>Up</A
275 
></TD
276 
><TD
277 
WIDTH="33%"
278 
ALIGN="right"
279 
VALIGN="top"
280 
>Code Style Guide</TD
281 
></TR
282 
></TABLE
283 
></DIV
284 
></BODY
285 
></HTML
286 
>