| Table Index | |||
| filecomment | project | projectfile | projectthread |
| fileset | projectcomment | projectstatus | systemuser |
| Sequence Index | |||
| tableids | |||
| Table: fileset | |||
| Represents a set of files that can be used by one or more review projects. Each set can be either uploaded as a tarball, or extracted from source control | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| owner | INTEGER | NOT NULL | The SystemUser who created the file set |
| createdate | TIMESTAMP | NOT NULL | Creation/last modification time of the file set |
| directory | VARCHAR (500) | Directory relative to JCR root containing all files | |
| baseline | VARCHAR (500) | Name of baseline in source control (optional, but recommended) | |
| Primary key | |||
| Name | Columns | Description | |
| pk_fileset | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_fileset_systemuser | owner | systemuser | |
| Incoming foreign keys | |||
| Name | Columns | Referencing table | Description |
| fk_project_originalfileset | originalfileset | project | |
| fk_project_modifiedfileset | modifiedfileset | project | |
| Table: project | |||
| Represents a code review project | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| name | VARCHAR (100) | NOT NULL | Display name for the project |
| owner | INTEGER | NOT NULL | The SystemUser who created (and owns) the project |
| createdate | TIMESTAMP | NOT NULL | Creation time of the project |
| directory | VARCHAR (200) | NOT NULL | Directory (relative to JCR root) containing all project files |
| currentstatus | VARCHAR (10) | NOT NULL | Current status of the project. Values are: SI: Setup - initial SD: Setup - generating diffs SF: Setup - selecting files RP: Review - preparation RM: Review - meeting C: Complete |
| originalfileset | INTEGER | Fileset with original versions of all files in the project, i.e. the before snapshot | |
| modifiedfileset | INTEGER | Fileset with modified versions of all files in the project, i.e. the after snapshot | |
| notes | TEXT | Free-form notes from the project owner, to assist reviewers | |
| Primary key | |||
| Name | Columns | Description | |
| pk_project | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_project_systemuser | owner | systemuser | |
| fk_project_originalfileset | originalfileset | fileset | |
| fk_project_modifiedfileset | modifiedfileset | fileset | |
| Incoming foreign keys | |||
| Name | Columns | Referencing table | Description |
| fk_projectstatus_project | project | projectstatus | |
| fk_projectthread_project | project | projectthread | |
| fk_projectfile_project | project | projectfile | |
| Table: projectstatus | |||
| Records the history of status changes to each project | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| project | INTEGER | NOT NULL | The project whose state was changed |
| changedby | INTEGER | NOT NULL | The SystemUser who changed the status of the project |
| changedate | TIMESTAMP | NOT NULL | Time when the project status was changed |
| newstatus | VARCHAR (2) | NOT NULL | New status of the project. See Project.currentStatus for details |
| Primary key | |||
| Name | Columns | Description | |
| pk_projectstatus | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_projectstatus_project | project | project | |
| fk_projectstatus_changedBy | changedby | systemuser | |
| Table: projectthread | |||
| Groups together project-level comments with a common title, like an email thread | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| project | INTEGER | NOT NULL | The project this thread is against |
| owner | INTEGER | NOT NULL | Foreign key to the user who started this thread |
| threadtitle | VARCHAR (100) | NOT NULL | Title of the thread |
| Primary key | |||
| Name | Columns | Description | |
| pk_projectthread | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_projectthread_project | project | project | |
| fk_projectthread_systemuser | owner | systemuser | |
| Incoming foreign keys | |||
| Name | Columns | Referencing table | Description |
| fk_projectcomment_projectthread | projectthread | projectcomment | |
| Indexes | |||
| Name | Columns | Description | |
| in_projectthread_project | project | ||
| in_projectthread_owner | owner | ||
| Table: projectcomment | |||
| Review comments made against a project thread | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| projectthread | INTEGER | NOT NULL | The project thread this comment is against |
| owner | INTEGER | NOT NULL | Foreign key to the user who made this comment |
| createdate | TIMESTAMP | NOT NULL | Creation time of the comment |
| comment | TEXT | NOT NULL | The comment itself |
| reviewdate | TIMESTAMP | Time when the review comment was added (at the review meeting) | |
| reviewcomment | TEXT | Review comment (from the review meeting) | |
| reviewer | INTEGER | Foreign key to the comment reviewer | |
| reviewdecision | VARCHAR (50) | Action required on this comment, as decided in the review meeting. Values are: NA: No action required CI: Comment incorrect UF: Urgent fix required FR: Fix before release ER: Raise ER DR: Raise DR | |
| reviewactionowner | INTEGER | Foreign key to the user tasked with actioning the review decision | |
| actiondate | TIMESTAMP | Time when any necessary action arising from the review meeting was updated | |
| actioncomment | TEXT | Comment made by the actioner about the actions taken (if any) | |
| actioner | INTEGER | Foreign key to the user who completed the required actions | |
| actionscomplete | CHAR (1) | Y if actioner has signed off on all required action | |
| Primary key | |||
| Name | Columns | Description | |
| pk_projectcomment | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_projectcomment_projectthread | projectthread | projectthread | |
| fk_projectcomment_systemuser_owner | owner | systemuser | |
| fk_projectcom_systemuser_reviewer | reviewer | systemuser | |
| fk_projectcom_systemuser_revaction | reviewactionowner | systemuser | |
| fk_projectcom_systemuser_actioner | actioner | systemuser | |
| Indexes | |||
| Name | Columns | Description | |
| in_projectcomment_projectthread | projectthread | ||
| in_projectcomment_owner | owner | ||
| in_projectcomment_reviewer | reviewer | ||
| in_projectcomment_revaction | reviewactionowner | ||
| in_projectcomment_actioner | actioner | ||
| Table: projectfile | |||
| Represents a file within a project that has been selected for review | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| project | INTEGER | NOT NULL | The project this file belongs to |
| path | VARCHAR (500) | NOT NULL | Relative path to the file within the file set for the project |
| originalpath | VARCHAR (500) | Optional relative path to the original version of the file within the original file set for the project. Used when the file has been renamed or moved | |
| changetype | CHAR (1) | NOT NULL | Type of change made to this file between original and new versions. Values are: C: Changed A: Added R: Removed |
| notes | TEXT | Free-form notes to assist reviewers | |
| reviewpriority | SMALLINT | Priority of this file (1-3, 3 is highest) for reviewing | |
| Primary key | |||
| Name | Columns | Description | |
| pk_projectfile | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_projectfile_project | project | project | |
| Incoming foreign keys | |||
| Name | Columns | Referencing table | Description |
| fk_filecomment_projectfile | projectfile | filecomment | |
| Indexes | |||
| Name | Columns | Description | |
| in_projectfile_project_path | project, path | NOTE: This index should be used on all DB's but MySQL (which requires that a length be specified for the text column) | |
| Table: filecomment | |||
| Review comments made against lines in a file | |||
| Columns | |||
| Name | Type | Constraints | Description |
| systemid | INTEGER | NOT NULL | System-generated primary key |
| projectfile | INTEGER | NOT NULL | The project file this comment is against |
| linenumber | INTEGER | NOT NULL | Line number in the file for this comment (1-based) |
| owner | INTEGER | NOT NULL | Foreign key to the user who made this comment |
| createdate | TIMESTAMP | NOT NULL | Creation time of the comment |
| comment | TEXT | NOT NULL | The comment itself |
| reviewdate | TIMESTAMP | Time when the review comment was added (at the review meeting) | |
| reviewcomment | TEXT | Review comment (from the review meeting) | |
| reviewer | INTEGER | Foreign key to the comment reviewer | |
| reviewdecision | VARCHAR (50) | Action required on this comment, as decided in the review meeting. Values are: NA: No action required CI: Comment incorrect UF: Urgent fix required FR: Fix before release ER: Raise ER DR: Raise DR | |
| reviewactionowner | INTEGER | Foreign key to the user tasked with actioning the review decision | |
| actiondate | TIMESTAMP | Time when any necessary action arising from the review meeting was updated | |
| actioncomment | TEXT | Comment made by the actioner about the actions taken (if any) | |
| actioner | INTEGER | Foreign key to the user who completed the required actions | |
| actionscomplete | CHAR (1) | Y if actioner has signed off on all required action | |
| Primary key | |||
| Name | Columns | Description | |
| pk_filecomment | systemid | ||
| Foreign keys | |||
| Name | Columns | Referenced table | Description |
| fk_filecomment_projectfile | projectfile | projectfile | |
| fk_filecomment_systemuser_owner | owner | systemuser | |
| fk_filecom_systemuser_reviewer | reviewer | systemuser | |
| fk_filecom_systemuser_revaction | reviewactionowner | systemuser | |
| fk_filecom_systemuser_actioner | actioner | systemuser | |
| Indexes | |||
| Name | Columns | Description | |
| in_filecomment_owner | owner | ||
| in_filecomment_reviewer | reviewer | ||
| in_filecomment_revaction | reviewactionowner | ||
| in_filecomment_actioner | actioner | ||
| Sequence: tableids | |
| Sequence used to generate system IDs (primary keys) for all tables | |
| Starts from: 1 |