Ready to get started?

Learn more about the CData ODBC Driver for Kintone or download a free trial:

Download Now

Using the CData ODBC Driver for Kintone in PyCharm

Connect to Kintone as an ODBC data source in PyCharm using the CData ODBC Driver for Kintone.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Kintone from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Kintone as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to Kintone

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Authennticating 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.

Below is the syntax for a DSN:

[CData Kintone Source] Driver = CData ODBC Driver for Kintone Description = My Description User = myuseraccount Password = mypassword Url = http://subdomain.domain.com GuestSpaceId = myspaceid

Execute SQL to Kintone

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for Kintone};User = myuseraccount;Password = mypassword;Url = http://subdomain.domain.com;GuestSpaceId = myspaceid') cursor = cnxn.cursor() cursor.execute("SELECT CreatorName, Text FROM Comments WHERE AppId = '1354841'") rows = cursor.fetchall() for row in rows: print(row.CreatorName, row.Text)

After connecting to Kintone in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Kintone data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.