Stream Google Sheets Data into Apache Kafka Topics

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 Google Spreadsheets, Kafka can work with live Google Sheets data. This article describes how to connect, access and stream Google Sheets data into Apache Kafka Topics and to start Confluent Control Center to help users secure, manage, and monitor the Google Sheets 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 Google Sheets data. When you issue complex SQL queries to Google Sheets, the driver pushes supported SQL operations, like filters and aggregations, directly to Google Sheets 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 Google Sheets data using native data types.

Prerequisites

Before connecting the CData JDBC Driver for streaming Google Sheets 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 Google Sheets data

1. Download CData JDBC Driver for Google Spreadsheets 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 Google Sheets

      		mkdir GoogleSheets
      		

   2. Move the downloaded driver file (.zip) into this new directory

      		mv GoogleSheetsJDBCDriver.zip GoogleSheets/
      		

   3. Unzip the CData GoogleSheetsJDBCDriver contents into this new directory

      		unzip GoogleSheetsJDBCDriver.zip
      		

3. Open the Google Sheets directory and navigate to the lib folder

   ls
   cd lib/
   

4. Copy the contents of the lib folder of the CData JDBC Driver for Google Spreadsheets into the lib folder of Kafka Connect JDBC. Check the Kafka Connect JDBC folder contents to confirm that the cdata.jdbc.googlesheets.jar file is successfully copied into the lib folder

   cp -r /path/to/CData JDBC Driver for Google Spreadsheets/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   

5. Install the CData Google Sheets JDBC driver license using the given command, followed by your Name and Email ID

   	java -jar cdata.jdbc.googlesheets.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 Google Sheets 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_googlesheets_01", 
   		"config": { 
   			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", 
   			"connection.url": "jdbc:googlesheets:Spreadsheet=MySheet;InitiateOAuth=GETANDREFRESH;",
   		"topic.prefix": "googlesheets-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 Google Sheets data.

     Built-in Connection String Designer

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

     		java -jar cdata.jdbc.googlesheets.jar
     		

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

     You can connect to a spreadsheet by providing authentication to Google and then setting the Spreadsheet connection property to the name or feed link of the spreadsheet. If you want to view a list of information about the spreadsheets in your Google Drive, execute a query to the Spreadsheets view after you authenticate.

     ClientLogin (username/password authentication) has been officially deprecated since April 20, 2012 and is now no longer available. Instead, use the OAuth 2.0 authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

     OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, register an application to obtain the OAuth JWT values.

     See the Getting Started chapter in the help documentation to connect to Google Sheets from different types of accounts: Google accounts, Google Apps accounts, and accounts using two-step verification. 👁 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 "googlesheets-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 Google Sheets 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.

Get Started Today

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