Kintone のデータをPythonのpetlでETL処理する方法｜CData Connect AI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのKintone のデータを抽出・変換・ロードするETLパイプラインの構築方法を解説。読み取りから書き込みまで対応します。

CData Connect AI の Python SDK と petl フレームワークを使うと、Kintone のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、Kintone のデータを抽出・変換して CSV などに出力する Kintone 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってKintone のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

Kintone データの定期抽出パイプライン構築

SQL クエリで取得した Kintone のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで Kintone 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

Kintone への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを Kintone に自動で書き戻す処理を組み込めます。

Connect AI で Kintone に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「Kintone」を選択します
    3. データソースの選択
  3. Kintone に接続するために必要な認証プロパティを入力します。

    Kintone 接続プロパティの設定方法

    それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

    • URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
    • User：アカウントのユーザー名
    • Password：アカウントのパスワード
    • AuthScheme：「Password」を指定

    パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

    Basic 認証の設定

    続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

    • BasicAuthUser：Basic 認証のユーザー名
    • BasicAuthPassword：Basic 認証のパスワード

    クライアント証明書認証の設定

    Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

    • SSLClientCert：クライアント証明書のパス
    • SSLClientCertType：証明書の種類
    • SSLClientCertSubject：証明書のサブジェクト
    • SSLClientCertPassword：証明書のパスワード
    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で Kintone のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

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

Kintone をクエリする SQL ステートメントを作成する方法は？

SQL を使って、Kintone をクエリするステートメントを作成します。この記事では、Apps エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Kintone1）になります。

sql = (
    "SELECT Name, Description "
    "FROM [Kintone1].[Kintone].[Apps] "
    "WHERE AppId = '1354841'"
)

Kintone のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってKintone のデータを抽出・変換・ロードします。この例では、Kintone のデータを抽出し、Description カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

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

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

新しい行を Kintone に書き戻す方法は？

Kintone が書き込みに対応している場合は、バッチ INSERT で行を書き戻せます。SDK の executemany は、@name のプレースホルダーと、1行につき1つのパラメータ辞書のリストを受け取ります。

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Kintone1].[Kintone].[Apps] (Name, Description) "
    "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()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにKintone のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのKintone のデータをパイプライン処理できるようになりました。Kintone（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

import petl as etl
import cdata_connect_ai

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

sql = (
    "SELECT Name, Description "
    "FROM [Kintone1].[Kintone].[Apps] "
    "WHERE AppId = '1354841'"
)

table1 = etl.fromdb(conn, sql)

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

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

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Kintone1].[Kintone].[Apps] (Name, Description) "
    "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()

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事