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.

Connect to GitHub Data in NetBeans



Connect to GitHub data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for GitHub integrates connectivity to live GitHub data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to GitHub data in NetBeans. You will create a connection and edit and save GitHub data in the Table Editor.

Create a JDBC Data Source for GitHub in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.github.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.github.GitHubDriver from the menu.
  • Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for GitHub.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.
    • JDBC URL: Specify 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.

      A typical JDBC URL is the following:

      jdbc:github:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH

Query GitHub Data

To connect to GitHub data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.