Ready to get started?

Download a free trial of the GitHub Driver to get started:

 Download Now

Learn more:

GitHub Icon GitHub JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with GitHub.

Manage GitHub Data in DBArtisan as a JDBC Source



Use wizards in DBArtisan to create a JDBC data source for GitHub.

The CData JDBC Driver for GitHub seamlessly integrates GitHub data into database management tools like DBArtisan by enabling you to access GitHub data as a database. This article shows how to create a JDBC source for GitHub in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate GitHub Data into DBArtisan Projects

Follow the steps below to register GitHub data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    GitHub uses the OAuth 2 authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Getting Started chapter of the CData help documentation for an authentication guide.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the GitHub JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.github.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    Below is a typical connection string:

    jdbc:github:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH
  6. Finish the wizard to connect to GitHub data. GitHub entities are displayed in the Datasource Explorer.

You can now work with GitHub data as you work with any other database. See the driver help documentation for more information on the queries supported by the GitHub API.