SQLAlchemy ORM を使用して Python で Zoho Books のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Zoho Books と SQLAlchemy ツールキットを使用して、Zoho Books に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Zoho Books のデータ に接続し、クエリを実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Zoho Books のデータ を操作する際に比類のないパフォーマンスを提供します。Zoho Books に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Zoho Books にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Zoho Books のデータ への接続

Zoho Books のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

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

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

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

Zoho Books への認証

Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Zoho Books にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Zoho Books のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Zoho Books のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("zohobooks:///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret&CallbackURL=https://localhost:33333&OrganizationId=MyOrganizationId")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、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")
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、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

無料トライアルと詳細情報

CData Python Connector for Zoho Books の30日間の無料トライアルをダウンロードして、Zoho Books のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。