Load Kintone Data to a Database Using Embulk

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

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

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

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

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

• Url: The URL of your account.
• GuestSpaceId: Optional. Set this when using a guest space.

Authenticating with Kintone

Kintone supports the following authentication methods.

Using Password Authentication

You must set the following to authenticate:

• User: The username of your account.
• Password: The password of your account.

Using Basic Authentication

If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

Using Client SSL

Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

Built-in Connection String Designer

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

java -jar cdata.jdbc.kintone.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 Kintone:

jdbc:kintone:User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid

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

Create a Job to Load Kintone Data

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

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

Sample Config File (kintone-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.kintone.jar
	driver_class: cdata.jdbc.kintone.KintoneDriver
	url: jdbc:kintone:User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid
	table: "Comments"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Comments"
	mode: insert

After creating the file, run the Embulk job.

embulk run kintone-mysql.yml

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

Load Filtered Kintone 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.kintone.jar
	driver_class: cdata.jdbc.kintone.KintoneDriver
	url: jdbc:kintone:User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid
	query: "SELECT CreatorName, Text FROM Comments WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Comments"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for Kintone as a connector, Embulk can integrate Kintone 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.