Lists information about pull requests in a repository.

View-Specific Information

You must specify the UserLogin when executing a SELECT query against this view. You can specify the values in the WHERE clause or as connection properties. A value specified in the WHERE clause takes precedence over the connection property.

If you do not specify a UserLogin value, the driver will use the login name of the authenticated user.

Select

The driver uses the GitHub API to restrict results to the specified UserLogin and RepositoryName values.

The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

• UserLogin, RepositoryName, BaseRefName, HeadRefName, Number, and State support the following operator: =

For example, the following queries are processed server side:

SELECT * FROM PullRequests WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'

SELECT * FROM PullRequests WHERE Number = 8
  
SELECT * FROM PullRequests WHERE State = 'all'

SELECT * FROM PullRequests WHERE BaseRefName = 'newbranch'

SELECT * FROM PullRequests WHERE HeadRefName = 'master'

SELECT * FROM PullRequests WHERE RepositoryName='MyRepo' AND State IN ('OPEN','MERGED')

Columns

Name	Type	OrderBySupport	Description
Id [KEY]	String		The ID of the pull request.
UserLogin	String		The login name of the user.
RepositoryName	String		The name of the repository.
ActiveLockReason	String		Reason that the conversation was locked.
Additions	Int		The number of additions in this pull request.
Author	String		The actor's login name who authored the comment.
AuthorAssociation	String		Author's association with the subject of the comment.
BaseRefPrefix	String		Identifies the prefix of the base Ref associated with the pull request.
BaseRefName	String		Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
BaseRefOid	String		Identifies the OID of the base ref associated with the pull request, even if the ref has been deleted.
Body	String		The body as Markdown.
BodyHTML	String		The body rendered to HTML.
BodyText	String		The body rendered to text.
ChangedFiles	Int		The number of changed files in this pull request.
ChecksResourcePath	String		The HTTP path for the checks of this pull request.
ChecksUrl	String		The HTTP URL for the checks of this pull request.
Closed	Boolean		true if the pull request is closed.
ClosedAt	Datetime		Identifies the date and time when the object was closed.
CreatedAt	Datetime	True	Identifies the date and time when the object was created.
CreatedViaEmail	Boolean		Check if this comment was created via an email reply.
DatabaseId	Int		Identifies the primary key from the database.
Deletions	Int		The number of deletions in this pull request.
Editor	String		The actor's login name who edited this pull request's body.
HeadRefPrefix	String		Identifies the prefix of the head Ref associated with the pull request.
HeadRefName	String		Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
HeadRefOid	String		Identifies the OID of the head ref associated with the pull request, even if the ref has been deleted.
HeadRepositoryOwner	String		The owner's login name of the repository associated with this pull request's head Ref.
IncludesCreatedEdit	Boolean		Check if this comment was edited and includes an edit with the creation data.
IsCrossRepository	Boolean		The head and base repositories are different.
IsDraft	Boolean		Identifies if the pull request is a draft.
LastEditedAt	Datetime		The moment the editor made the last edit.
Locked	Boolean		true if the pull request is locked.
MaintainerCanModify	Boolean		Indicates whether maintainers can modify the pull request.
MergeCommitId	String		The commit ID that was created when this pull request was merged.
Mergeable	String		Whether or not the pull request can be merged based on the existence of merge conflicts.
Merged	Boolean		Whether or not the pull request was merged.
MergedAt	Datetime		The date and time that the pull request was merged.
MergedBy	String		The actor's login name who merged the pull request.
MilestoneId	String		Identifies the milestone's ID associated with the pull request.
Number	Integer		Identifies the pull request number.
Permalink	String		The permalink to the pull request.
PotentialMergeCommitId	String		The commit ID that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request.
PublishedAt	Datetime		Identifies when the comment was published at.
ResourcePath	String		The HTTP path for this pull request.
RevertResourcePath	String		The HTTP path for reverting this pull request.
RevertUrl	String		The HTTP URL for reverting this pull request.
ReviewDecision	String		The current status of this pull request with respect to code review.
State	String		Identifies the state of the pull request. The allowed values are OPEN, CLOSED, MERGED.
Title	String		Identifies the pull request title.
UpdatedAt	Datetime	True	Identifies the date and time when the object was last updated.
Url	String		The HTTP URL for this pull request.
ViewerCanApplySuggestion	Boolean		Whether or not the viewer can apply suggestion.
ViewerCanReact	Boolean		Can user react to this subject.
ViewerCanSubscribe	Boolean		Check if the viewer is able to change their subscription status for the repository.
ViewerCanUpdate	Boolean		Check if the current viewer can update this object.
ViewerDidAuthor	Boolean		Did the viewer author this comment.
ViewerSubscription	String		Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.