Load Lakebase Data to a Database Using Embulk

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Lakebase, Embulk easily loads data from Lakebase to any supported destination. In this article, we explain how to use the CData JDBC Driver for Lakebase in Embulk to load Lakebase data to a MySQL dtabase.

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).

Configure a JDBC Connection to Lakebase Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Lakebase\lib).

Embulk supports JDBC connectivity, so you can easily connect to Lakebase and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Lakebase.

• 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.

Below is a typical JDBC connection string for Lakebase:

jdbc:lakebase:DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;InitiateOAuth=GETANDREFRESH;

Load Lakebase Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

1. Install the JDBC Input Plugin in Embulk.
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

With the input and output plugins installed, we are ready to load Lakebase data into MySQL using Embulk.

Create a Job to Load Lakebase Data

Start by creating a config file in Embulk, using a name like lakebase-mysql.yml.

1. For the input plugin options, use the CData JDBC Driver for Lakebase, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.lakebase.LakebaseDriver), and the JDBC URL from above
2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (lakebase-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.lakebase.jar
	driver_class: cdata.jdbc.lakebase.LakebaseDriver
	url: jdbc:lakebase:DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;InitiateOAuth=GETANDREFRESH;
	table: "Orders"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Orders"
	mode: insert

After creating the file, run the Embulk job.

embulk run lakebase-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Lakebase Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.lakebase.jar
	driver_class: cdata.jdbc.lakebase.LakebaseDriver
	url: jdbc:lakebase:DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;InitiateOAuth=GETANDREFRESH;
	query: "SELECT ShipName, ShipCity FROM Orders WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Orders"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for Lakebase as a connector, Embulk can integrate Lakebase data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.