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

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

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

Zoho Creator のデータ への接続

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

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

Zoho Creator に接続するには、Region をサーバーURL のトップレベルドメイン（TLD）に設定します。

Zoho Creator への認証

Zoho Creator は、データに接続する2つの方法を提供します。

• デスクトップ経由で自分のローカルデータに接続する場合（非ブラウザ接続）は、CData が提供する組み込みOAuth アプリケーションを使用します。
• ネットワーク経由で共有データに接続する場合（ブラウザ接続）は、カスタムOAuth アプリケーションを使用します。

すべてのOAuth フロー（埋め込みまたはカスタム）で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。 ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Creator への認証について詳しく説明します。

• デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
• Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
• ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

認証方法の詳細は、ヘルプドキュメントを参照してください。

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

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

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 Creator のデータ のモデリング

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

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

engine = create_engine("zohocreator:///?AccountsServer=AccountsServer")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、Leave_Types テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

base = declarative_base()
class Leave_Types(base):
	__tablename__ = "Leave_Types"
	ID = Column(String,primary_key=True)
	Leave_Type = Column(String)
	...

Zoho Creator のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("zohocreator:///?AccountsServer=AccountsServer")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Leave_Types).filter_by(Leave_Type="Sick"):
	print("ID: ", instance.ID)
	print("Leave_Type: ", instance.Leave_Type)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

Leave_Types_table = Leave_Types.metadata.tables["Leave_Types"]
for instance in session.execute(Leave_Types_table.select().where(Leave_Types_table.c.Leave_Type == "Sick")):
	print("ID: ", instance.ID)
	print("Leave_Type: ", instance.Leave_Type)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

Zoho Creator のデータ の挿入

Zoho Creator のデータ を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを Zoho Creator にプッシュします。

new_rec = Leave_Types(ID="placeholder", Leave_Type="Sick")
session.add(new_rec)
session.commit()

Zoho Creator のデータ の更新

Zoho Creator のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを Zoho Creator にプッシュします。

updated_rec = session.query(Leave_Types).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Leave_Type = "Sick"
session.commit()

Zoho Creator のデータ の削除

Zoho Creator のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

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

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

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