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

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

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

Zoho Recruit のデータ への接続

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

ZohoRecruit への認証では、OAuth 標準を使って自分のデータに接続したり、他のユーザーが各自のデータに接続できるようにしたりできます。

OAuth 認証の設定

まず、ZohoRecruit に OAuth アプリケーションを登録する必要があります。登録するには、Zoho Developer Console に移動して、新しい Client（Server-based application）を追加し、有効な OAuth リダイレクト URL を設定します。OAuth アプリケーションには client id と client secret が割り当てられます。さらに、該当する Domain（.com、.eu、.in、.com.cn、または .jp）を設定する必要があります。デフォルトは .com です。

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
• OAuthClientId：アプリ設定で指定された client_id に設定します。
• OAuthClientSecret：アプリ設定で指定された client_secret に設定します。
• CallbackURL：アプリ設定で指定されたリダイレクト URI に設定します。
• Domain：ProfileSettings に設定して、ZohoRecruit アカウントのドメイン（例：.com、.eu、.in、.com.cn、.jp）を指定します。

接続文字列の例：

Profile=C:\profiles\ZohoRecruit.apip;ProfileSettings='Domain=.com';AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

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

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

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

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

engine = create_engine("api:///?Profile=C:\profiles\ZohoRecruit.apip&ProfileSettings='Domain=.com'&AuthScheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url")

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

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

base = declarative_base()
class Attachments(base):
	__tablename__ = "Attachments"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

Zoho Recruit のデータ のクエリ

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

query メソッドの使用

engine = create_engine("api:///?Profile=C:\profiles\ZohoRecruit.apip&ProfileSettings='Domain=.com'&AuthScheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Attachments).filter_by(Module="Candidates"):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

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

execute メソッドの使用

Attachments_table = Attachments.metadata.tables["Attachments"]
for instance in session.execute(Attachments_table.select().where(Attachments_table.c.Module == "Candidates")):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

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

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

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