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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でZoho Inventory のデータをモデル化

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

engine = create_engine("zohoinventory///?OrganizationId=YourOrganizationId&AccountsServer=YourAccountServerURL&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Zoho Inventory 接続プロパティの取得・設定方法

以下の接続プロパティを使用して、取得されるZoho Inventory データを正確に絞り込むことができます。

• Region：サーバーURL のトップレベルドメイン（TLD）。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
• OrganizationId（オプション）：接続先の特定のZoho Inventory 組織に関連付けられたID。
  • Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。

Zoho Inventory への認証

ドライバーはOAuth を使用して認証を行います。認証方法は、ヘルプドキュメントの「はじめに」セクションを参照してください。

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

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

base = declarative_base()
class Contacts(base):
	__tablename__ = "Contacts"
	Id = Column(String,primary_key=True)
	CustomerName = Column(String)
	...

Zoho Inventory のデータをクエリ

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

query メソッドを使う

engine = create_engine("zohoinventory///?OrganizationId=YourOrganizationId&AccountsServer=YourAccountServerURL&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Contacts).filter_by(FirstName="Katherine"):
	print("Id: ", instance.Id)
	print("CustomerName: ", instance.CustomerName)
	print("---------")

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

execute メソッドを使う

Contacts_table = Contacts.metadata.tables["Contacts"]
for instance in session.execute(Contacts_table.select().where(Contacts_table.c.FirstName == "Katherine")):
	print("Id: ", instance.Id)
	print("CustomerName: ", instance.CustomerName)
	print("---------")

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

Zoho Inventory のデータの挿入（INSERT）

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

new_rec = Contacts(Id="placeholder", FirstName="Katherine")
session.add(new_rec)
session.commit()

Zoho Inventory のデータを更新（UPDATE）

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

updated_rec = session.query(Contacts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.FirstName = "Katherine"
session.commit()

Zoho Inventory のデータを削除（DELETE）

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

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

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

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

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