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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
SQLAlchemy オブジェクトリレーショナルマッピングを使用して、Factorial のデータ を操作する Python アプリケーションとスクリプトを作成します。



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

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

Factorial のデータ への接続

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

認証

Factorial は認証に OAuth 2.0 を使用し、自分の HR データに接続する場合も、他のユーザーが各自のデータに接続できるようにする場合も、OAuth 2.0 認証を利用できます。

OAuth 認証の設定

OAuth を使って接続するには、以下のステップで進めます：

  1. Factorial の管理パネルに移動して、新しい OAuth アプリケーションを作成します。
  2. アプリケーション設定から Client ID と Client Secret をコピーします。
  3. 以下の接続プロパティを設定します。
  • AuthScheme：OAuth に設定します。
  • OAuthClientId：OAuth Client ID に設定します。
  • OAuthClientSecret：OAuth Client Secret に設定します。
  • Scope：データへのアクセス権限を指定します（デフォルト："read write"）。

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

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

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

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

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


engine = create_engine("api:///?Profile=C:\profiles\Factorial.apip&AuthScheme=OAuth&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url")

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

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


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

Factorial のデータ のクエリ

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

query メソッドの使用


engine = create_engine("api:///?Profile=C:\profiles\Factorial.apip&AuthScheme=OAuth&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Agreements).filter_by(ProcessId="123"):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

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

execute メソッドの使用


Agreements_table = Agreements.metadata.tables["Agreements"]
for instance in session.execute(Agreements_table.select().where(Agreements_table.c.ProcessId == "123")):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

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

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

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

はじめる準備はできましたか？

API Driver で Factorial のライブデータに接続

Factorial に接続

この記事の内容

関連記事