Connect to Kintone Data in Aqua Data Studio

The CData JDBC Driver for Kintone integrates Kintone data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Kintone data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Kintone data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Kintone.
   • Driver Location: Click the Browse button and select the cdata.jdbc.kintone.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.kintone.KintoneDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:kintone: and is followed by a semicolon-separated list of connection properties.

     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.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Kintone Data

You can now query the tables exposed.