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

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



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

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

ApprovalMax のデータ への接続

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

まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。

ApprovalMax API プロファイル設定

ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
  • OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
  • CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
  • Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

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

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

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

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

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


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

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

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


base = declarative_base()
class UserProfiles(base):
	__tablename__ = "UserProfiles"
	UserId = Column(String,primary_key=True)
	Email = Column(String)
	...

ApprovalMax のデータ のクエリ

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

query メソッドの使用


engine = create_engine("api:///?Profile=C:\profiles\ApprovalMax.apip&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(UserProfiles).filter_by(CompanyId="00000000-0000-0000-0000-000000000000"):
	print("UserId: ", instance.UserId)
	print("Email: ", instance.Email)
	print("---------")

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

execute メソッドの使用


UserProfiles_table = UserProfiles.metadata.tables["UserProfiles"]
for instance in session.execute(UserProfiles_table.select().where(UserProfiles_table.c.CompanyId == "00000000-0000-0000-0000-000000000000")):
	print("UserId: ", instance.UserId)
	print("Email: ", instance.Email)
	print("---------")

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

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

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

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

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

ApprovalMax に接続

この記事の内容

関連記事