Stream GitHub Data into Apache Kafka Topics



Access and stream GitHub data in Apache Kafka using the CData JDBC Driver and the Kafka Connect JDBC connector.

Apache Kafka is an open-source stream processing platform that is primarily used for building real-time data pipelines and event-driven applications. When paired with the CData JDBC Driver for GitHub, Kafka can work with live GitHub data. This article describes how to connect, access and stream GitHub data into Apache Kafka Topics and to start Confluent Control Center to help users secure, manage, and monitor the GitHub data received using Kafka infrastructure in the Confluent Platform.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live GitHub data. When you issue complex SQL queries to GitHub, the driver pushes supported SQL operations, like filters and aggregations, directly to GitHub and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze GitHub data using native data types.

Prerequisites

Before connecting the CData JDBC Driver for streaming GitHub data in Apache Kafka Topics, install and configure the following in the client Linux-based system.

  1. Confluent Platform for Apache Kafka
  2. Confluent Hub CLI Installation
  3. Self-Managed Kafka JDBC Source Connector for Confluent Platform

Define a New JDBC Connection to GitHub data

  1. Download CData JDBC Driver for GitHub on a Linux-based system
  2. Follow the given instructions to create a new directory extract all the driver contents into it:
    1. Create a new directory named GitHub mkdir GitHub
    2. Move the downloaded driver file (.zip) into this new directory mv GitHubJDBCDriver.zip GitHub/
    3. Unzip the CData GitHubJDBCDriver contents into this new directory unzip GitHubJDBCDriver.zip
  3. Open the GitHub directory and navigate to the lib folder ls cd lib/
  4. Copy the contents of the lib folder of GitHub into the lib folder of Kafka Connect JDBC. Check the Kafka Connect JDBC folder contents to confirm that the cdata.jdbc.github.jar file is successfully copied into the lib folder cp * ../../confluent-7.5.0/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/ cd ../../confluent-7.5.0/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
  5. Install the CData GitHub JDBC driver license using the given command, followed by your Name and Email ID java -jar cdata.jdbc.github.jar -l
  6. Enter the product key or "TRIAL" (In the scenarios of license expiry, please contact our CData Support team)
  7. Start the Confluent local services using the command: confluent local services start

    This starts all the Confluent Services like Zookeeper, Kafka, Schema Registry, Kafka REST, Kafka CONNECT, ksqlDB and Control Center. You are now ready to use the CData JDBC driver for GitHub to stream messages using Kafka Connect Driver into Kafka Topics on ksqlDB.

    Start the Confluent local services
  8. Create the Kafka topics manually using a POST HTTP API Request: curl --location 'server_address:8083/connectors' --header 'Content-Type: application/json' --data '{ "name": "jdbc_source_cdata_github_01", "config": { "connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", "connection.url": "jdbc:github:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;; InitiateOAuth=GETANDREFRESH", "topic.prefix": "github-01-", "mode": "bulk" } }'

    Let us understand the fields used in the HTTP POST body (shown above):

    • connector.class: Specifies the Java class of the Kafka Connect connector to be used.
    • connection.url: The JDBC connection URL to connect with GitHub data.

      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.

      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.

      Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    • topic.prefix: A prefix that will be added to the Kafka topics created by the connector. It's set to "github-01-".
    • mode: Specifies the mode in which the connector operates. In this case, it's set to "bulk", which suggests that the connector is configured to perform bulk data transfer.

    This request adds all the tables/contents from GitHub as Kafka Topics.

    Note: The IP Address (server) to POST the request (shown above) is the Linux Network IP Address.

  9. Run ksqlDB and list the topics. Use the commands: ksql list topics; List the Kafka Topics (BigCommerce is shown)
  10. To view the data inside the topics, type the SQL Statement: PRINT topic FROM BEGINNING;

Connecting with the Confluent Control Center

To access the Confluent Control Center user interface, ensure to run the "confluent local services" as described in the above section and type http://<server address>:9021/clusters/ on your local browser.

Connect with Confluent Control Center

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for GitHub and start streaming GitHub data into Apache Kafka. Reach out to our Support Team if you have any questions.

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.