PullRequestReviews
Stores details of reviews conducted on pull requests, including reviewer actions (approved, requested changes, commented) and timestamps.
Table-Specific Information
Select
The driver uses the GitHub API to process WHERE clause conditions that are built with the following columns and operators:
- Author supports the '=' comparison operator.
- PullRequestNumber supports the '=' comparison operator.
- State supports the '=' and 'IN' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestReviews]
SELECT * FROM [PullRequestReviews] WHERE [Author] = 'Val1'
SELECT * FROM [PullRequestReviews] WHERE [PullRequestNumber] = 123
SELECT * FROM [PullRequestReviews] WHERE [State] = 'PENDING'
The driver processes other filters client-side within the driver.
Insert
You can use the following columns to create (insert) a new record:
- Body
- PullRequestId
- CommitOid
You can use the following pseudocolumns to create a new record:
- Event
- Threads (references PullRequestReviewThread)
INSERT INTO [PullRequestReviews] ([PullRequestId], [Body], [CommitOid], [Event], [Threads]) VALUES ('PR_1', 'Example.', '123', 'COMMENT', '[{"body":"Change this.","line":1,"path":".github/test/file.txt","startSide":"LEFT","side":"LEFT","startLine":1},{"body":"Also this.","line":2,"path":".github/test/file.txt","startSide":"LEFT","side":"LEFT","startLine":2}]')
PullRequestReviewThread Temporary Table Columns
| Column Name | Type | Description |
| Path | String | The relative path of the file being commented on. |
| Body | String | The text of the review comment. |
| Line | Int | The line of the file to which the thread refers. For multi-line comments, this is the end of the line range. |
| StartLine | Int | The start line of a multi-line comment. Omit for single-line comments. |
| Side | String | The side of the diff that the end line of the comment thread applies to. |
| StartSide | String | The side of the diff that the start line of a multi-line comment applies to. Defaults to the value of Side. |
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the pull request review, used to distinguish this review from others in the system. | |
| Body | String | False |
The content of the review, written in Markdown format, which typically includes feedback or comments about the pull request. | |
| BodyText | String | True |
The plain text version of the review's body, with all Markdown formatting removed for a simpler, text-only view. | |
| BodyHTML | String | True |
The HTML-rendered version of the review body, designed for displaying the review as formatted text on the web. | |
| Author | String | True |
The GitHub username of the individual who authored the review, indicating the person who provided the feedback. | |
| AuthorType | String | True |
The type of the actor who authored the comment. | |
| AuthorAssociation | String | True |
The association of the author with the pull request subject, such as 'OWNER', 'CONTRIBUTOR', or 'COLLABORATOR', indicating their role in the project. | |
| Editor | String | True |
The GitHub username of the individual who last edited the review comment, showing who made the most recent changes to the review. | |
| IsMinimized | Bool | True |
Indicates whether the review comment has been minimized or collapsed by the viewer, possibly to reduce clutter in the UI. | |
| MinimizedReason | String | True |
Describes the reason why the comment was minimized, such as it being less relevant or flagged by the viewer. | |
| CreatedViaEmail | Bool | True |
Indicates whether the review comment was created through an email reply to the review request, often from email notifications. | |
| IncludesCreatedEdit | Bool | True |
Indicates whether the review comment includes an edit along with its creation data, reflecting that the comment has been modified since it was first posted. | |
| ResourcePath | String | True |
The relative HTTP path for accessing the review comment through the GitHub API, used for programmatically retrieving the review. | |
| Url | String | True |
The full HTTP URL that directs to the review comment directly on GitHub, allowing users to view it in the GitHub interface. | |
| LastEditedAt | Datetime | True |
The timestamp indicating when the review comment was last edited, showing when the comment was last updated. | |
| PublishedAt | Datetime | True |
The timestamp indicating when the review comment was first published and visible to others. | |
| CreatedAt | Datetime | True |
The timestamp indicating when the review comment was created, marking the original moment it was submitted. | |
| UpdatedAt | Datetime | True |
The timestamp indicating when the review comment was last updated, reflecting any edits made since its creation. | |
| ViewerDidAuthor | Bool | True |
Indicates whether the current viewer is the author of the review comment. A value of 'true' means the viewer is the one who wrote the review. | |
| ViewerCanDelete | Bool | True |
Indicates whether the current viewer has permission to delete the review comment, typically based on their role in the repository. | |
| ViewerCanMinimize | Bool | True |
Indicates whether the current viewer can minimize or collapse the review comment in their interface to streamline the view. | |
| ViewerCanReact | Bool | True |
Indicates whether the current viewer has the ability to react to the review comment, such as adding emojis or other reactions. | |
| ViewerCanUpdate | Bool | True |
Indicates whether the current viewer has permission to edit or update the review comment after it has been posted. | |
| ViewerCannotUpdateReasons | String | True |
Lists the reasons why the current viewer is unable to update the review comment, which can include permissions or restrictions. | |
| ReactionGroups | String | True |
A list of reaction types (such as 'thumbs-up' or 'thumbs-down') grouped by the content left on the review comment, showing the reactions the comment has received. | |
| ViewerId | String | True |
The unique identifier of the viewer interacting with the review comment, typically used to track the individual's actions and permissions. | |
| PullRequestId | String | False |
PullRequests.Id |
The unique identifier of the pull request associated with this review, linking the review directly to the specific pull request. |
| PullRequestNumber | Int | True |
The number assigned to the pull request associated with this review, providing a reference for the review within the repository. | |
| CommitId | String | True |
The identifier of the commit that this review is associated with, linking the review to a specific commit in the pull request. | |
| CommitOid | String | False |
Identifies the commit OID associated with this pull request review. | |
| SubmittedAt | Datetime | True |
The timestamp when the pull request review was officially submitted, indicating when the review was completed and submitted to the system. | |
| State | String | True |
The current state of the pull request review, indicating its status (for example, 'APPROVED', 'CHANGES_REQUESTED'). This reflects the reviewer's decision regarding the pull request. The allowed values are PENDING, COMMENTED, APPROVED, CHANGES_REQUESTED, DISMISSED. | |
| AuthorCanPushToRepository | Bool | True |
Indicates whether the author of the review has the necessary permissions to push changes directly to the repository. This can be useful for identifying if the reviewer can make updates themselves. | |
| FullDatabaseId | Long | True |
The primary key identifier for the review comment in the database, represented as a BigInt. This is used internally for database queries and tracking. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| Event | String |
The event to perform on the pull request review, determining the review outcome. The allowed values are APPROVE, COMMENT, REQUEST_CHANGES, DISMISS. |
| Threads | String |
The review line comment threads. |