Process & Analyze Kintone Data in Databricks (AWS)

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live Kintone data. This article walks through hosting the CData JDBC Driver in AWS, as well as connecting to and processing live Kintone data in Databricks.

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). Its built-in dynamic metadata querying allows you to work with and analyze Kintone data using native data types.

Install the CData JDBC Driver in Databricks

To work with live Kintone data in Databricks, install the driver on your Databricks cluster.

1. Navigate to your Databricks administration screen and select the target cluster.
2. On the Libraries tab, click "Install New."
3. Select "Upload" as the Library Source and "Jar" as the Library Type.
4. Upload the JDBC JAR file (cdata.jdbc.kintone.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

Access Kintone Data in your Notebook: Python

With the JAR file installed, we are ready to work with live Kintone data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query Kintone, and create a basic report.

Configure the Connection to Kintone

Connect to Kintone by referencing the JDBC Driver class and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

Step 1: Connection Information

driver = "cdata.jdbc.kintone.KintoneDriver"
url = "jdbc:kintone:RTK=5246...;User=myuseraccount;Password=mypassword;Url=http://subdomain.domain.com;GuestSpaceId=myspaceid"

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.

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

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.

Load Kintone Data

Once you configure the connection, you can load Kintone data as a dataframe using the CData JDBC Driver and the connection information.

Step 2: Reading the data

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Comments") \
	.load ()

Display Kintone Data

Check the loaded Kintone data by calling the display function.

Step 3: Checking the result

display (remote_table.select ("CreatorName"))

Analyze Kintone Data in Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

Step 4: Create a view or table

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

With the Temp View created, you can use SparkSQL to retrieve the Kintone data for reporting, visualization, and analysis.

% sql

SELECT CreatorName, Text FROM SAMPLE_VIEW ORDER BY Text DESC LIMIT 5

The data from Kintone is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

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