Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From GitHub connection/s to launch the CData Query window. To setup a new connection, you will have to click the New GitHub Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to GitHub

To authenticate to GitHub you must connect using OAuth authentication.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

OAuthClientId (custom applications only): The client Id assigned when you registered your application.
OAuthClientSecret (custom applications only): The client secret assigned when you registered your application.
CallbackURL (custom application only): The redirect URI defined when you registered your application.
OwnerLogin (optional): The name of the user or organization whose repository and projects you plan to query. If you do not explicitly specify an OwnerLogin, the driver uses the currently authenticated user.

When you connect, the add-in opens GitHub's OAuth endpoint in your default browser. Log in and grant permissions to the application. The add-in refreshes the access token automatically when it expires.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to GitHub you will be able to customize the data you are importing. To learn more about this, see Managing Connections.