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

Prerequisites

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

1. Download CData JDBC Driver for Bitbucket 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 Bitbucket

      		mkdir Bitbucket
      		

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

      		mv BitbucketJDBCDriver.zip Bitbucket/
      		

   3. Unzip the CData BitbucketJDBCDriver contents into this new directory

      		unzip BitbucketJDBCDriver.zip
      		

3. Open the Bitbucket directory and navigate to the lib folder

   ls
   cd lib/
   

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

   cp -r /path/to/CData JDBC Driver for Bitbucket/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 Bitbucket JDBC driver license using the given command, followed by your Name and Email ID

   	java -jar cdata.jdbc.bitbucket.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 Bitbucket 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_bitbucket_01", 
   		"config": { 
   			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", 
   			"connection.url": "jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;",
   		"topic.prefix": "bitbucket-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 Bitbucket 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 Bitbucket. Either double-click the JAR file or execute the jar file from the command-line.

     		java -jar cdata.jdbc.bitbucket.jar
     		

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

     For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

     Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

     • Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
     • Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

     Authenticating to Bitbucket

     Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

     Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

     Creating a custom OAuth application

     From your Bitbucket account:

     1. Go to Settings (the gear icon) and select Workspace Settings.
     2. In the Apps and Features section, select OAuth Consumers.
     3. Click Add Consumer.
     4. Enter a name and description for your custom application.
     5. Set the callback URL:
        • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
        • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
     6. If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
     7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
     8. To save the new custom application, click Save.
     9. After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.
     👁 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 "bitbucket-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 Bitbucket 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 Bitbucket and start streaming Bitbucket data into Apache Kafka. Reach out to our Support Team if you have any questions.