Connect to Lakebase Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Lakebase, HULFT Integrate can work with live Lakebase data. This article walks through connecting to Lakebase and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Lakebase data. When you issue complex SQL queries to Lakebase, the driver pushes supported SQL operations, like filters and aggregations, directly to Lakebase 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 Lakebase data using native data types.

Enable Access to Lakebase

To enable access to Lakebase data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.lakebase.jar (and cdata.jdbc.lakebase.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Lakebase Data

Once you copy the JAR files, you can create a project with access to Lakebase data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: LakebasetoCSV)

Once you create the project, add components to the script to copy Lakebase data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Lakebase. Set the following properties:
   • Name: Lakebase Connection Settings
   • Driver class name: cdata.jdbc.lakebase.LakebaseDriver
   • URL: jdbc:lakebase:DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;InitiateOAuth=GETANDREFRESH;
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.

     
2. Write your SQL statement. For example:

   SELECT ShipName, ShipCity FROM Orders

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. Orders.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map Lakebase Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Lakebase data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for Lakebase and start working with your live Lakebase data in HULFT Integrate. Reach out to our Support Team if you have any questions.