Adding a Connection to GitHub

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the GitHub icon is not available, click the Add More icon to download and install the GitHub connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to GitHub

This section details a selection of advanced features of the GitHub Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to GitHub and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models entities in the GitHub API as views and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

The Sync App exposes three kinds of schemas:

Information Schema

The Information schema contains tables that expose licensing information and high-level overviews of the projects and repositories associated with the authenticated account. There is only one Information schema.

See Information Data Model for the available entities.

Repository Schemas

The Sync App exposes a schema for each repository in the authenticated user or organization's account.

See Repository Data Model for the available entities.

Project Schemas

The Sync App exposes a schema for each project in the authenticated user or organization's account.

See Project Data Model for the available entities.

Note: The Sync App does not read from classic projects, due their deprecation in the GitHub API.

Overview

In this schema, the Sync App models licensing information and high-level overviews of the organizations, projects, and repositories associated with the authenticated account as read-only views.

Key Features

• The Sync App models GitHub entities as relational views, allowing you to write SQL to query GitHub data.
• Stored procedures allow you to execute operations to GitHub.
• Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Views

Views are read-only tables that expose GitHub entities like licenses, organizations, and organization teams, as well as high-level information about projects and repositories tied to the authenticated account.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They are used to perform functions such as getting the currently authenticated user or retrieving and refreshing OAuth access tokens.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

GitHub Connector for CData Sync Views

A list of enterprises that the user belongs to.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Slug supports the '=' comparison operator.
• MembershipType supports the '=' comparison operator.
• Login supports the '=' comparison operator.

SELECT * FROM [Information].[Enterprises] WHERE [Information].[Enterprises].[Slug] = 'test-enterprise'
SELECT * FROM [Information].[Enterprises] WHERE [Information].[Enterprises].[MembershipType] = 'ADMIN'
SELECT * FROM [Information].[Enterprises] WHERE [Information].[Enterprises].[Login] = 'test'

Columns

The conditions set by the specified license.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• LicenseKey supports the '=' comparison operator.

SELECT * FROM [Information].[LicenseConditions] WHERE [Information].[LicenseConditions].[LicenseKey] = 'EXAMPLE'

Columns

The limitations set by the specified license.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• LicenseKey supports the '=' comparison operator.

SELECT * FROM [Information].[LicenseLimitations] WHERE [Information].[LicenseLimitations].[LicenseKey] = 'EXAMPLE'

Columns

The permissions set by the specified license.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• LicenseKey supports the '=' comparison operator.

SELECT * FROM [Information].[LicensePermissions] WHERE [Information].[LicensePermissions].[LicenseKey] = 'EXAMPLE'

Columns

Lists known open source licenses in GitHub.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Key supports the '=' comparison operator.

SELECT * FROM [Information].[Licenses] WHERE [Information].[Licenses].[Key] = 'EXAMPLE'

Columns

Lists information about the mannequins of the logged in user's organizations or the mannequins of the specified organization.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• OrganizationLogin supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• Login
• CreatedAt

SELECT * FROM [Information].[OrganizationMannequins] WHERE [Information].[OrganizationMannequins].[OrganizationLogin] = 'EXAMPLE'

Columns

Lists information about the users of the logged in user's organizations or the teams of the specified organization.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• OrganizationLogin supports the '=' comparison operator.

SELECT * FROM [Information].[OrganizationMembers] WHERE [Information].[OrganizationMembers].[OrganizationLogin] = 'EXAMPLE'

Columns

Lists information about the organizations of the logged in user, the specified user, or the specified organization.

View-Specific Information

By default this view will only return information about the organizations of the logged in user.

Specific columns require the authenticated user to be an owner of the organization to retrieve data. These columns include WebCommitSignoffRequired, IpAllowListEnabledSetting, RequiresTwoFactorAuthentication, MembersCanForkPrivateRepositories, NotificationDeliveryRestrictionEnabledSetting and IpAllowListForInstalledAppsEnabledSetting.

Data access to third-parties is limited if an organization has enabled OAuth App access restrictions.

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Login supports the '=' comparison operator.
• MemberLogin supports the '=' comparison operator.

SELECT * FROM [Information].[Organizations] WHERE [Information].[Organizations].[Login] = 'OrganizationLogin'
SELECT * FROM [Information].[Organizations] WHERE [Information].[Organizations].[MemberLogin] = 'UserLogin'

Columns

Lists information about the teams of the logged in user's organizations or the teams of the specified organization.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• OrganizationLogin supports the '=' comparison operator.
• Privacy supports the '=' comparison operator.
• Slug supports the '=' comparison operator.
• NotificationSetting supports the '=' comparison operator.
• LdapMapped supports the '=' comparison operator.
• Role supports the '=' comparison operator.
• RootTeamsOnly supports the '=' comparison operator.
• UserLogins supports the '=, IN' comparison operators.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• Name

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[OrganizationLogin] = 'EXAMPLE'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[Privacy] = 'EXAMPLE'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[Slug] = 'EXAMPLE'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[NotificationSetting] = 'EXAMPLE'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[LdapMapped] = 'true'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[Role] = 'EXAMPLE'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[RootTeamsOnly] = 'true'

SELECT * FROM [Information].[OrganizationTeams] WHERE [Information].[OrganizationTeams].[UserLogins] = 'EXAMPLE'

Columns

Lists information about the projects of the logged in user, a specific user or a specific organization.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• OwnerLogin supports the '=' comparison operator.
• Number supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• Number
• Title
• UpdatedAt
• CreatedAt

SELECT * FROM [Information].[Projects] WHERE [Information].[Projects].[OwnerLogin] = 'EXAMPLE'

SELECT * FROM [Information].[Projects] WHERE [Information].[Projects].[Number] = '100'

Columns

Lists information about a user's or organization's repositories.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Name supports the '=, !=' comparison operators.
• OwnerLogin supports the '=' comparison operator.
• DiskUsage supports the '=, >, >=, <, <=' comparison operators.
• ForkCount supports the '=, >, >=, <, <=' comparison operators.
• StargazerCount supports the '=, >, >=, <, <=' comparison operators.
• TopicCount supports the '=, >, >=, <, <=' comparison operators.
• IsArchived supports the '=' comparison operator.
• IsFork supports the '=' comparison operator.
• IsMirror supports the '=' comparison operator.
• IsPrivate supports the '=' comparison operator.
• LicenseKey supports the '=, !=' comparison operators.
• LanguageName supports the '=, !=' comparison operators.
• PushedAt supports the '=, >, >=, <, <=' comparison operators.
• CreatedAt supports the '=, >, >=, <, <=' comparison operators.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• UpdatedAt

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[Name] = 'EXAMPLE'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[OwnerLogin] = 'EXAMPLE'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[DiskUsage] = '100'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[ForkCount] = '100'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[StargazerCount] = '100'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[TopicCount] = '100'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsArchived] = 'true'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsFork] = 'true'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsMirror] = 'true'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[IsPrivate] = 'true'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[LicenseKey] = 'EXAMPLE'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[LanguageName] = 'EXAMPLE'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[PushedAt] = '2000-01-01 01:00:00.0'

SELECT * FROM [Information].[Repositories] WHERE [Information].[Repositories].[CreatedAt] = '2000-01-01 01:00:00.0'

Columns

Overview

The Sync App models each repository associated with the authenticated account as a schema.

Key Features

• The Sync App models GitHub entities as relational views, allowing you to write SQL to query GitHub data.
• Stored procedures allow you to execute operations to GitHub.
• Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Views

Views are read-only tables that expose GitHub entities like pull requests, issues, and commits.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They are used to perform functions such as retrieving and refreshing OAuth access tokens.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

GitHub Connector for CData Sync Views

Lists information about the users that can be assigned to issues in this repository.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns

Lists information about branches in a repository.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns

A list of collaborators associated with the repository.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns

Lists information about comments which were made on a specific commit.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns

Lists information about commits done in a repository .

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• BranchName supports the '=' comparison operator.
• CommittedDate supports the '=, >=, >, <, <=' comparison operators.

SELECT * FROM [Repository].[Commits] WHERE [Repository].[Commits].[BranchName] = 'EXAMPLE'

SELECT * FROM [Repository].[Commits] WHERE [Repository].[Commits].[CommittedDate] >= '2017-12-18 09:02:22.0' AND [Repository].[Commits].[CommittedDate] <= '2018-01-11 15:00:08.0'

Columns

Lists information about forks of a repository.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• IsLocked supports the '=' comparison operator.
• HasIssuesEnabled supports the '=' comparison operator.
• IsPrivate supports the '=' comparison operator.
• Visibility supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• Name
• CreatedAt
• UpdatedAt
• PushedAt

SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[IsLocked] = 'true'
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[HasIssuesEnabled] = 'false'
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[Visibility] = 'PUBLIC'
SELECT * FROM [Repository].[Forks] WHERE [Repository].[Forks].[IsPrivate] = 'false'

Columns

Lists information about the users assigned to the repository's issues.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• IssueNumber supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• UpdatedAt

SELECT * FROM [Repository].[IssueAssignees] WHERE [Repository].[IssueAssignees].[IssueNumber] = '100'

Columns

Lists information about comments which were made on a specific issue.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• IssueNumber supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• UpdatedAt

SELECT * FROM [Repository].[IssueComments] WHERE [Repository].[IssueComments].[IssueNumber] = '100'

Columns

Lists all project issues.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Author supports the '=, !=' comparison operators.
• State supports the '=' comparison operator.
• ClosedAt supports the '=, >, >=, <, <=' comparison operators.
• UpdatedAt supports the '=, >, >=, <, <=' comparison operators.
• CreatedAt supports the '=, >, >=, <, <=' comparison operators.
• CommentCount supports the '=, >, >=, <, <=' comparison operators.
• ReactionCount supports the '=, >, >=, <, <=' comparison operators.
• Mentions supports the '=' comparison operator.
• Assignee supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• UpdatedAt
• CreatedAt

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[Author] = 'EXAMPLE'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[State] = 'EXAMPLE'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[ClosedAt] = '2018-05-10 11:11:38.0'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[UpdatedAt] = '2018-05-10 11:11:38.0'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[CreatedAt] = '2018-05-10 11:11:38.0'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[CommentCount] = '100'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[ReactionCount] = '100'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[Mentions] = 'User'

SELECT * FROM [Repository].[Issues] WHERE [Repository].[Issues].[Assignee] = 'User'

Columns

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.

Lists information about the different labels you can apply on an issue.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Name supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• Name
• CreatedAt

SELECT * FROM [Repository].[Labels] WHERE [Repository].[Labels].[Name] = 'EXAMPLE'

Columns

Lists information about the users that can be mentioned in the context of the repository.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns

Lists information about the different entries on an merge queue.

View-Specific Information

Select

The Sync App processes filters client-side within the Sync App.

Columns

Lists information about the different labels you can apply on an issue.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Branch supports the '=' comparison operator.

SELECT * FROM [Repository].[MergeQueues] WHERE [Repository].[MergeQueues].[Branch] = 'test'

Columns

Lists information about milestones in a repository.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• Number supports the '=' comparison operator.
• State supports the '=' comparison operator.

The Sync App uses the GitHub API to process ORDER BY clause conditions built with the following column. The Sync App processes ordering by other columns client-side within the Sync App.

• Number
• DueOn
• UpdatedAt
• CreatedAt

SELECT * FROM [Repository].[Milestones] WHERE [Repository].[Milestones].[Number] = '100'

SELECT * FROM [Repository].[Milestones] WHERE [Repository].[Milestones].[State] = 'all'

Columns

Lists information about comments which were made on a specific pull request.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• PullRequestId supports the '=' comparison operator.

SELECT * FROM [Repository].[PullRequestComments] WHERE [Repository].[PullRequestComments].[PullRequestId] = 'PR_kwDO00RTuc5l2kMj'

Columns

Lists information about comments which were made on a pull request review.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• PullRequestReviewId supports the '=' comparison operator.

SELECT * FROM [Repository].[PullRequestReviewComments] WHERE [Repository].[PullRequestReviewComments].[PullRequestReviewId] = 'PRR_kwDO000Tuc5yOHvY'

Columns

Lists information about pull request reviews in a repository.

View-Specific Information

Select

The Sync App uses the GitHub API to process WHERE clause conditions built with the below columns and operators. The Sync App processes other filters client-side within the Sync App.

• PullRequestNumber supports the '=' comparison operator.
• State supports the '=, IN' comparison operators.
• Author supports the '=' comparison operator.

SELECT * FROM [Repository].[PullRequestReviews] WHERE [Repository].[PullRequestReviews].[PullRequestNumber] = '100'

SELECT * FROM [Repository].[PullRequestReviews] WHERE [Repository].[PullRequestReviews].[State] = 'PENDING'

SELECT * FROM [Repository].[PullRequestReviews] WHERE [Repository].[PullRequestReviews].[Author] = 'EXAMPLE'

Columns