Access Lakebase Data in Mule Applications Using the CData JDBC Driver

The CData JDBC Driver for Lakebase connects Lakebase data to Mule applications enabling read , write, update, and delete functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Lakebase data.

This article demonstrates how to use the CData JDBC Driver for Lakebase inside of a Mule project to create a Web interface for Lakebase data. The application created allows you to request Lakebase data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the hundreds of available data sources.

1. Create a new Mule Project in Anypoint Studio.
2. Add an HTTP Connector to the Message Flow.
3. Configure the address for the HTTP Connector. 👁 Add and Configure the HTTP Connector
   
4. Add a Database Select Connector to the same flow, after the HTTP Connector.
5. Create a new Connection (or edit an existing one) and configure the properties.
   • Set Connection to "Generic Connection"
   • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.lakebase.jar). 👁 Adding the JAR file (Salesforce is shown).
     
   • Set the URL to the connection string for Lakebase To connect to Databricks Lakebase, start by setting the following properties:
     • DatabricksInstance: The Databricks instance or server hostname, provided in the format instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com.
     • Server: The host name or IP address of the server hosting the Lakebase database.
     • Port (optional): The port of the server hosting the Lakebase database, set to 5432 by default.
     • Database (optional): The database to connect to after authenticating to the Lakebase Server, set to the authenticating user's default database by default.

     OAuth Client Authentication

     To authenicate using OAuth client credentials, you need to configure an OAuth client in your service principal. In short, you need to do the following:

     1. Create and configure a new service principal
     2. Assign permissions to the service principal
     3. Create an OAuth secret for the service principal

     For more information, refer to the Setting Up OAuthClient Authentication section in the Help documentation.

     OAuth PKCE Authentication

     To authenticate using the OAuth code type with PKCE (Proof Key for Code Exchange), set the following properties:

     • AuthScheme: OAuthPKCE.
     • User: The authenticating user's user ID.

     For more information, refer to the Help documentation.

     Built-in Connection String Designer

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

     		java -jar cdata.jdbc.lakebase.jar
     		

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

   • Set the Driver class name to cdata.jdbc.lakebase.LakebaseDriver. 👁 A configured Database Connection (Salesforce is shown).
     
   • Click Test Connection.
6. Set the SQL Query Text to a SQL query to request Lakebase data. For example:

   SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'

   👁 Configure the Select object (Salesforce is Shown)
   
7. Add a Transform Message Component to the flow.
8. Set the Output script to the following to convert the payload to JSON:

   %dw 2.0
   output application/json
   ---
   payload
    

   👁 Add the Transform Message Component to the Flow
   
9. To view your Lakebase data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Lakebase data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with Lakebase data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for Lakebase and see the CData difference in your Mule Applications today.