SQLAlchemy ORM を使って、Python でKintone のデータに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Kintone は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Kintone にデータ連携するPython アプリケーションを構築し、Kintone のデータを可視化できます。 本記事では、SQLAlchemy でKintone に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Kintone をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにKintone のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてKintone の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でKintone のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Kintone のデータに連携するEngne を作成します。

engine = create_engine("kintone///?User=myuseraccount&Password=mypassword&URL=http://subdomain.domain.com")

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：証明書のパスワード

Kintone のデータのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Apps テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Apps(base):
	__tablename__ = "Apps"
	Name = Column(String,primary_key=True)
	Description = Column(String)
	...

Kintone のデータをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("kintone///?User=myuseraccount&Password=mypassword&URL=http://subdomain.domain.com")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Apps).filter_by(AppId="1354841"):
	print("Name: ", instance.Name)
	print("Description: ", instance.Description)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Apps_table = Apps.metadata.tables["Apps"]
for instance in session.execute(Apps_table.select().where(Apps_table.c.AppId == "1354841")):
	print("Name: ", instance.Name)
	print("Description: ", instance.Description)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Kintone のデータの挿入（INSERT）

Kintone のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Kintone にすべての追加インスタンスを送ります。

new_rec = Apps(Name="placeholder", AppId="1354841")
session.add(new_rec)
session.commit()

Kintone のデータを更新（UPDATE）

Kintone のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Kintone にレコードを追加します。

updated_rec = session.query(Apps).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.AppId = "1354841"
session.commit()

Kintone のデータを削除（DELETE）

Kintone のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Apps).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Kintone からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。