How to Query Kintone Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Kintone to query Kintone data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Kintone data in MySQL Workbench.

Connect to Kintone Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Kintone data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Kintone from MySQL Workbench

The steps below outline connecting to the virtual Kintone database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Kintone data.

Connect to Kintone through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Kintone).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

👁 Image

Query Kintone Data

1. Open the connection you just created (CData SQL Gateway for Kintone).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Kintone data, like SELECT * FROM `CData Kintone Sys`.Comments;

👁 Image

With access to live Kintone data from MySQL Workbench, you can easily work with Kintone, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Kintone and the CData SQL Gateway.