Subversion Repositories DevTools

Rev

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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Database Schema</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Codestriker Guide"
HREF="book1.html"><LINK
REL="UP"
TITLE="Hacking"
HREF="c705.html"><LINK
REL="PREVIOUS"
TITLE="Hacking"
HREF="c705.html"><LINK
REL="NEXT"
TITLE="Code Style Guide"
HREF="x830.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Codestriker Guide: Version 1.9.3</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="c705.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 4. Hacking</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x830.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN771"
>4.2. Database Schema</A
></H1
><P
>        The <TT
CLASS="FILENAME"
>bin/install.pl</TT
> script contains the
        <B
CLASS="COMMAND"
>CREATE TABLE</B
> statements that are used when
        the Codestriker database is initialised, in the
        <CODE
CLASS="VARNAME"
>$table</CODE
> hash.  The following tables are
        defined:
        <P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>project</DT
><DD
><P
>               A Codestriker database can consist of a number of
                projects, which have a name, id, description and
                creation date.  Each code review topic, is linked to a
                specific project.
              </P
></DD
><DT
>topic</DT
><DD
><P
>               A topic represents a code review that has been
                submitted to Codestriker.  It contains attributes like
                the author, title, description, creation date,
                repository, and is linked to a member project.
              </P
></DD
><DT
>participant</DT
><DD
><P
>               A participant is associated with a topic, and contains
                an email address, and the type of participant they
                are, such as the author, reviewer or observer
                (somebody was is CC'ed for the review).
              </P
></DD
><DT
>commentdata</DT
><DD
><P
>                A comment is made against a specific review, and
                 consists of the author and the comment text itself.
                 It is linked with a specific commentstate object.
              </P
></DD
><DT
>commentstate</DT
><DD
><P
>               A commentstate row represents a comment block - a list
                of comments made against a specific file and line
                number.  The comment block has the notion of state,
                whether it is marked "submitted", "complete" or
                "invalid".
              </P
></DD
><DT
>topicbug</DT
><DD
><P
>               This table records a many-to-many relationship between
                topics and bug ids.  A topic may fix more than one bug
                id, and likewise, a bug id can be fixed by many
                topics.
              </P
></DD
><DT
>topicfile</DT
><DD
><P
>               A topic consists on many file objects, which contain a
                filename, revision number and an indicator as to
                whether it is a text or binary file.  A file consists
                of one or more delta objects.
              </P
></DD
><DT
>delta</DT
><DD
><P
>               A delta is associated with a specific file object, and
                represents a single diff chunk or change.  It
                represents for file X, at line number Y, the following
                change is a part of the review.
              </P
></DD
><DT
>topichistory</DT
><DD
><P
>                Records a trail as to who modified what topic
                properties and when that occurred.
              </P
></DD
><DT
>commentstatehistory</DT
><DD
><P
>                Records a trail for the modification of
                comment blocks.
              </P
></DD
><DT
>topicviewhistory</DT
><DD
><P
>                Records who has viewed a topic and when.
              </P
></DD
><DT
>topicmetric</DT
><DD
><P
>                Records the value of a metric against a specific topic.
              </P
></DD
><DT
>topicusermetric</DT
><DD
><P
>                Records the value of a metric against a specific topic
                for a specific user.
              </P
></DD
></DL
></DIV
>
      </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="c705.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x830.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Hacking</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c705.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Code Style Guide</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>