TDV Adapter for GitHub

Build 22.0.8462

Repositories

Lists information about a user's 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 adapter will use the login name of the authenticated user.

Select

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

The adapter processes other filters client-side within the adapter.

  • UserLogin, IsArchived, IsFork, IsMirror, and IsPrivate support the following operator: =
  • Name, LicenseKey, and LanguageName support the following operators: =,!=
  • CreatedAt, PushedAt, and ForkCountsupport the following operators: =,>,>=,<,<=
For example, the following queries are processed server side:
SELECT * FROM Repositories WHERE UserLogin = 'MyUser'

SELECT * FROM Repositories WHERE Name = 'aName'

Columns

Name Type OrderBySupport Description
Id [KEY] String The ID of the repository.
UserLogin String The login name of the user.
OwnerLogin String The repository's owner username to login.
OwnerId String The repository's owner ID.
Name String The name of the repository.
Description String The description of the repository.
Url String The HTTP URL for this repository.
CreatedAt Datetime Identifies the date and time when the object was created.
UpdatedAt Datetime True Identifies the date and time when the object was last updated.
PushedAt Datetime Identifies when the repository was last pushed to.
DeleteBranchOnMerge Bool Whether or not branches are automatically deleted when merged in this repository.
DescriptionHTML String The description of the repository rendered to HTML.
DiskUsage Integer The number of kilobytes this repository occupies on disk.
ForkCount Integer Returns how many forks there are of this repository in the whole network.
LicenseKey String The key of the license associated with the repository.
HasIssuesEnabled Bool Indicates if the repository has issues feature enabled.
HasProjectsEnabled Bool Indicates if the repository has the Projects feature enabled.
HasWikiEnabled Bool Indicates if the repository has wiki feature enabled.
HomepageUrl String The repository's URL.
IsArchived Bool Indicates if the repository is unmaintained.
IsDisabled Bool Returns whether or not this repository disabled.
IsFork Bool Identifies if the repository is a fork.
IsLocked Bool Indicates if the repository has been locked or not.
IsMirror Bool Identifies if the repository is a mirror.
IsPrivate Bool Identifies if the repository is private.
IsTemplate Bool Identifies if the repository is a template that can be used to generate new repositories.
MergeCommitAllowed Bool Whether or not PRs are merged with a merge commit on this repository.
ParentId String The repository parent ID, if this is a fork.
TemplateRepositoryId String The ID of the repository from which this repository was generated, if any.
LockReason String The reason the repository has been locked.

The allowed values are BILLING, MIGRATING, MOVING, RENAME.

MirrorUrl String The repository's original mirror URL.
OpenGraphImageUrl String The image used to represent this repository in Open Graph data.
LanguageId String The ID of the current primary language.
LanguageName String The name defined for the current language.
LanguageColor String The color defined for the current language.
ProjectsResourcePath String The HTTP path listing the repository's projects.
ProjectsUrl String The HTTP URL listing the repository's projects.
SSHUrl String The SSH URL to clone this repository.
RebaseMergeAllowed Bool Whether or not rebase-merging is enabled on this repository.
ResourcePath String The HTTP path for this repository.
ShortDescriptionHTML String A description of the repository, rendered to HTML without any links in it.
ViewerPermission String The users permission level on the repository. Will return null if authenticated as an GitHub App.

The allowed values are ADMIN, MAINTAIN, READ, TRIAGE, WRITE.

ViewerSubscription String Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

The allowed values are IGNORED, SUBSCRIBED, UNSUBSCRIBED.

SquashMergeAllowed Bool Whether or not squash-merging is enabled on this repository.
UsesCustomOpenGraphImage Bool Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.
ViewerCanAdminister Bool Indicates whether the viewer has admin permissions on this repository.
ViewerCanCreateProjects Bool Can the current viewer create new projects on this owner.
ViewerCanSubscribe Bool Check if the viewer is able to change their subscription status for the repository.
ViewerCanUpdateTopics Bool Indicates whether the viewer can update the topics of this repository.
ViewerHasStarred Bool Returns a boolean indicating whether the viewing user has starred this starrable.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Topic String You can find all of the repositories that are classified with a particular topic.
Topics Integer You can search repositories by the number of topics that have been applied to them.
Stars Integer You can search repositories based on the number of stars a repository has.
Followers Integer You can filter repositories based on the number of followers that they have.
Size Integer You can filter repositories based on their sizes (in kilobytes).

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462