How to Build an ETL App for Kintone Data in Python with CData Connect AI

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Connect AI Python SDK and the petl framework, you can build Kintone-connected applications and pipelines for extracting, transforming, and loading Kintone data. This article shows how to connect to Connect AI and use petl to extract, transform, and load Kintone data.

The Connect AI Python SDK (cdata-connect-ai) is a DB-API 2.0 (PEP 249) compliant client, so petl can read directly from the SDK connection with etl.fromdb. There is no driver to install per source: connect with a Personal Access Token and build your pipeline.

Connect to Kintone in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Kintone" from the Add Connection panel

3. Enter the necessary authentication properties to connect to 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.

   
4. Click Save & Test
5. Navigate to the Permissions tab and update the user-based permissions.

Generate a Personal Access Token (PAT)

The Python SDK authenticates to Connect AI with your account email and a Personal Access Token (PAT). It is best practice to create a separate PAT for each application to maintain granularity of access.

1. Click the Gear icon () at the top right of the Connect AI app to open the Settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The PAT is only visible at creation, so copy it and store it securely.

Install Required Modules

Install the SDK and the petl framework using the pip utility:

pip install cdata-connect-ai
pip install petl

Build an ETL App for Kintone Data in Python

Once the required modules are installed, you are ready to build the ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, import the modules and connect to Connect AI with your account email and PAT:

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Create a SQL Statement to Query Kintone

Use SQL to create a statement for querying Kintone. In this article, we read data from the Comments entity. Identifiers are three-part: <Connection>.<Schema>.<Table>, where the connection name defaults to the source name (for example, Kintone1).

sql = (
    "SELECT CreatorName, Text "
    "FROM [Kintone1].[Kintone].[Comments] "
    "WHERE AppId = '1354841'"
)

Extract, Transform, and Load the Kintone Data

With a connection and query in hand, use petl to extract, transform, and load the Kintone data. In this example, we extract Kintone data, sort the data by the Text column, and load the data into a CSV file.

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Text')

etl.tocsv(table2, 'comments_data.csv')

Load New Rows Back into Kintone

When Kintone supports writes, load rows back with a batch INSERT. The SDK's executemany takes @name placeholders and a list of parameter dictionaries, one per row.

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Kintone1].[Kintone].[Comments] (CreatorName, Text) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

Note: Even for writable sources, a read-only PAT or connection permission will reject write operations.

With the CData Connect AI Python SDK, you can work with Kintone data just like you would with any database, including direct access to data in ETL packages like petl.

More Information and Free Trial

Now you can pipe live Kintone data through petl using the CData Connect AI Python SDK. For more information on connecting to Kintone (and hundreds of other data sources), visit the Connect AI page. Sign up for a free trial and start building data pipelines for live Kintone data in Python.

Full Source Code

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT CreatorName, Text "
    "FROM [Kintone1].[Kintone].[Comments] "
    "WHERE AppId = '1354841'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Text')

etl.tocsv(table2, 'comments_data.csv')

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Kintone1].[Kintone].[Comments] (CreatorName, Text) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()