Create a connection to GitHub by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the GitHub icon is not available, click the Add More icon to download and install the GitHub connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to GitHub

Web Applications

When connecting via a Web application, you need to register a custom OAuth application with GitHub. You can then use the Sync App to get and manage the OAuth token values. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic Refresh of the OAuth Access Token

To have the Sync App automatically refresh the OAuth access token, set the following on the first data connection.

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the path where you want the Sync App to save the OAuth values, which persist across connections.

On subsequent data connections, set the following:

• InitiateOAuth
• OAuthSettingsLocation
• UserLogin (optional);
• RepositoryName (optional);

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.

API limitations and requirements are documented in this section. You can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Views

Views describes the available views. Views are statically defined to model Repositories, Commits, Projects, and more.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

GitHub Connector for CData Sync Views

Lists information about branches 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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 and RepositoryName support the following operator: =

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

Columns

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

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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 and RepositoryName support the following operator: =

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

Columns

Lists information about commits done 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, BranchName and RepositoryName support the following operator: =
• CommittedDate supports the following operators: =,>=,>,<,<=

SELECT * FROM Commits WHERE RepositoryName = 'MyRepo'

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

SELECT * FROM Commits WHERE BranchName = 'master'

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

Columns

Lists information about forks of 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, and IsLocked support the following operator: =

SELECT * FROM Forks WHERE IsLocked=true

Columns

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

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, and IssueNumber support the following operator: =

SELECT * FROM IssueComments WHERE RepositoryName = 'MyRepo'

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

SELECT * FROM IssueComments WHERE IssueNumber = 5 AND RepositoryName = 'MyRepo'

Columns

Lists all project issues.

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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 and State support the following operator: =
• RepositoryName and Author support the following operators: =,!=
• ClosedAt, CreatedAt, and UpdatedAt support the following operators: =,>,>=,<,<=

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

SELECT * FROM Issues WHERE RepositoryName = 'test' AND UpdatedAt >= '2018-05-10 11:11:38.0'

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

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, and Name support the following operator: =

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

SELECT * FROM Labels WHERE Name = 'duplicate'

Columns

The conditions set by the license.

Table-Specific Information

Select

You must specify the LicenseKey when executing a SELECT query against this table.

• LicenseKey supports the following operator: =

SELECT * FROM LicenseConditions WHERE LicenseKey = 'mit'

Columns

The limitations set by the license.

Table-Specific Information

Select

You must specify the LicenseKey when executing a SELECT query against this table.

• LicenseKey supports the following operator: =

SELECT * FROM LicenseLimitations WHERE LicenseKey = 'mit'

Columns

The permissions set by the license.

Table-Specific Information

Select

You must specify the LicenseKey when executing a SELECT query against this table.

• LicenseKey supports the following operator: =

SELECT * FROM LicensePermissions WHERE LicenseKey = 'mit'

Columns

Lists the open source licenses.

Table-Specific Information

Select

• Key supports the following operator: =

SELECT * FROM Licenses

SELECT * FROM Licenses WHERE Key = 'mit'

Columns

Lists information about milestones 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, Number, and State support the following operator: =

SELECT * FROM Milestones WHERE UserLogin = 'MyUser' AND RepositoryName = 'MyRepo'
   
SELECT * FROM Milestones WHERE State = 'all'

SELECT * FROM Milestones WHERE Number = 1

Columns

Lists information about about the organizations of the logged in user.

View-Specific Information

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

Columns

Lists information about project columns.

Table-Specific Information

Select

• UserLogin, RepositoryName, and ProjectNumber support the following operator: =

You can specify the ProjectNumber column to list all columns for a specific project.

SELECT * FROM ProjectColumns WHERE RepositoryName = 'test' AND ProjectNumber = '108'
  

Columns

Lists information about projects.

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, Number, and State support the following operator: =

SELECT * FROM Projects WHERE UserLogin = 'MyUserLogin' AND RepositoryName = 'MyRepo'

SELECT * FROM Projects WHERE Number=2

SELECT * FROM Projects WHERE State = 'all'

Columns

Lists information about pull request reviews 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, PullRequestNumber, Author, and State support the following operator: =

SELECT * FROM PullRequestReviews WHERE RepositoryName = 'test'

SELECT * FROM PullRequestReviews WHERE RepositoryName = 'test' AND Author = 'testaccount71'

SELECT * FROM PullRequestReviews WHERE RepositoryName='test' AND State IN ('PENDING','DISMISSED')

Columns

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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: =

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

List of releases assets which are dependent on a release.

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, ReleaseTagName, and Name support the following operator: =

SELECT * FROM ReleaseAssets WHERE RepositoryName = 'test'

SELECT * FROM ReleaseAssets WHERE RepositoryName = 'test' AND ReleaseTagName = 'value8888'

SELECT * FROM ReleaseAssets WHERE RepositoryName = 'test' AND Name = 'hola21.zip'

Columns

Lists information about the different releases of 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 Sync App will use the login name of the authenticated user.

Select

The Sync App uses the GitHub API to restrict results to the specified UserLogin value.

The Sync App processes other filters client-side within the Sync App. 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, and TagName support the following operator: =

SELECT * FROM Releases

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

SELECT * FROM Releases WHERE RepositoryName = 'test' AND TagName = 'value8888'

Columns

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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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, IsArchived, IsFork, IsMirror, and IsPrivate support the following operator: =
• Name, LicenseKey, and LanguageName support the following operators: =,!=
• CreatedAt, PushedAt, and ForkCountsupport the following operators: =,>,>=,<,<=

SELECT * FROM Repositories WHERE UserLogin = 'MyUser'

SELECT * FROM Repositories WHERE Name = 'aName'

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.

A list of applied repository-topic associations for this 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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 and RepositoryName support the following operator: =

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

Columns

Lists information about GitHub users.

View-Specific Information

Select

By default view will return information about all the registered users in GitHub. Note: This can be quite slow since GitHub has more than 20 million registered users.

If you specify the Login column, this view will only return information about the specified user.

The Sync App uses the GitHub API to process search criteria that refer to UserLogin. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

• Login and Location support the following operator: =,!=
• CreatedAt supports the following operators: =,>,>=,<,<=

SELECT * FROM Users WHERE Login = 'MyUser'

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.

A list of users watching the 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 Sync App will use the login name of the authenticated user.

Select

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

The Sync App processes other filters client-side within the Sync App. 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 and RepositoryName support the following operator: =

SELECT * FROM Watchers WHERE RepositoryName = 'MyRepo'

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

Columns

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

Connection

OAuth

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Restrict query results by the repository name.

Remarks

Optional when creating a new connection. However, this table is required to query some tables.

Where RepositoryName is required, you must also specify UserLogin.

Restrict query results by UserLogin.

Remarks

You can set this connection property to restrict query results by UserLogin.

This property is optional when creating a connection; you can also specify the UserLogin pseudo column in your query to override the value set in the connection. The driver uses the currently authenticated user's UserLogin if one is not explicitly specified as a connection property or as a criteria.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\GitHub Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Specifies how many points a call will cost.

Remarks

The GraphQL API v4 rate limit is 5,000 points per hour.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Users WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"