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

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

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

SAP SuccessFactors LMS のデータ への接続

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

SAP SuccessFactors LMS は OAuth 認証を使用します。接続する前に、SAP SuccessFactors LMS アカウントに紐づけた OAuth アプリケーションを構成する必要があります。

接続するには、以下のプロパティを設定してください。

• User: SAP SuccessFactors LMS のユーザー名。
• CompanyId: SAP SuccessFactors の会社 ID。
• Url: SAP SuccessFactors API の URL（例: https://api4.successfactors.com）。
• OAuthClientId: カスタム OAuth アプリケーション登録時に割り当てられたクライアント ID。
• OAuthClientSecret: カスタム OAuth アプリケーション登録時に割り当てられたクライアントシークレット。

カスタム OAuth アプリの作成と OAuth の使用方法については、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

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

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

engine = create_engine("sapsuccessfactorslms:///?User=username&CompanyId=CompanyId&Url=https://api4.successfactors.com&InitiateOAuth=GETANDREFRESH")

SAP SuccessFactors LMS のデータ のマッピングクラスの宣言

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

base = declarative_base()
class Items(base):
	__tablename__ = "Items"
	ItemID = Column(String,primary_key=True)
	ItemTitle = Column(String)
	...

SAP SuccessFactors LMS のデータ のクエリ

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

query メソッドの使用

engine = create_engine("sapsuccessfactorslms:///?User=username&CompanyId=CompanyId&Url=https://api4.successfactors.com&InitiateOAuth=GETANDREFRESH")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Items).filter_by(Active="true"):
	print("ItemID: ", instance.ItemID)
	print("ItemTitle: ", instance.ItemTitle)
	print("---------")

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

execute メソッドの使用

Items_table = Items.metadata.tables["Items"]
for instance in session.execute(Items_table.select().where(Items_table.c.Active == "true")):
	print("ItemID: ", instance.ItemID)
	print("ItemTitle: ", instance.ItemTitle)
	print("---------")

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

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

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