SQLAlchemy ORM を使って、Python でZoho Books データに連携

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムZoho Books データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Zoho Books に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Zoho Books 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

Zoho Books への接続

Zoho Books データへの連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Zoho Books はOAuth 認証標準を使用します。OAuth を使用して認証するには、アプリを作成して OAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを設定してください。 認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからZoho Books に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でZoho Books データをモデル化

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

engine = create_engine("zohobooks///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret&CallbackURL=https://localhost:33333&OrganizationId=MyOrganizationId&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

base = declarative_base()
class INVOICES(base):
	__tablename__ = "INVOICES"
	InvoiceId = Column(String,primary_key=True)
	InvoiceNumber = Column(String)
	...

Zoho Books データをクエリ

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

query メソッドを使う

engine = create_engine("zohobooks///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret&CallbackURL=https://localhost:33333&OrganizationId=MyOrganizationId&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(INVOICES).filter_by(CustomerName="NewTech Industries"):
	print("InvoiceId: ", instance.InvoiceId)
	print("InvoiceNumber: ", instance.InvoiceNumber)
	print("---------")

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

execute メソッドを使う

INVOICES_table = INVOICES.metadata.tables["INVOICES"]
for instance in session.execute(INVOICES_table.select().where(INVOICES_table.c.CustomerName == "NewTech Industries")):
	print("InvoiceId: ", instance.InvoiceId)
	print("InvoiceNumber: ", instance.InvoiceNumber)
	print("---------")

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

製品の無償トライアル情報

Zoho Books Python Connector の30日の無償トライアル をぜひダウンロードして、Zoho Books データへの接続をPython アプリやスクリプトから簡単に作成しましょう。