Load AlloyDB Data to a Database Using Embulk

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

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live AlloyDB data. When you issue complex SQL queries to AlloyDB, the driver pushes supported SQL operations, like filters and aggregations, directly to AlloyDB and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to AlloyDB 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 AlloyDB\lib).

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

The following connection properties are usually required in order to connect to AlloyDB.

• Server: The host name or IP of the server hosting the AlloyDB database.
• User: The user which will be used to authenticate with the AlloyDB server.
• Password: The password which will be used to authenticate with the AlloyDB server.

You can also optionally set the following:

• Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
• Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

Authenticating with Standard Authentication

Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

No further action is required to leverage Standard Authentication to connect.

Authenticating with pg_hba.conf Auth Schemes

There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

Find instructions about authentication setup on the AlloyDB Server here.

Authenticating with MD5 Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

Authenticating with SASL Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

Authenticating with Kerberos

The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

Built-in Connection String Designer

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

java -jar cdata.jdbc.alloydb.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Below is a typical JDBC connection string for AlloyDB:

jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432

Load AlloyDB 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 AlloyDB data into MySQL using Embulk.

Create a Job to Load AlloyDB Data

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

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

Sample Config File (alloydb-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.alloydb.jar
	driver_class: cdata.jdbc.alloydb.AlloyDBDriver
	url: jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432
	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 alloydb-mysql.yml

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

Load Filtered AlloyDB 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.alloydb.jar
	driver_class: cdata.jdbc.alloydb.AlloyDBDriver
	url: jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432
	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 AlloyDB as a connector, Embulk can integrate AlloyDB 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.