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

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

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

SAP Ariba Source のデータ への接続

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

それでは、SAP Ariba Source に接続していきましょう。接続するには、以下のプロパティを設定します。

• API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します（可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です）
• DataCenter：アカウントのデータがホストされているデータセンター
• Realm：アクセスしたいサイト名
• Environment：テスト環境、または本番環境のいずれかを指定してください。（可能な値は、TEST またはPRODUCTION）

Supplier Data API またはContract API に接続する場合は、さらに以下のプロパティも設定してください。

• User：API 呼び出しを行うユーザーのId
• PasswordAdapter：認証するUser に関連付けられたパスワード

Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定してください。

OAuth 認証

続いて、接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。

• AuthScheme をOAuthClient に設定します
• サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります

OAuth アプリケーションの作成について、詳しくはヘルプドキュメントをご確認ください。

OAuth の自動リフレッシュ

以下のプロパティを設定して、接続してみましょう。

• APIKey：アプリケーション設定のApplication key
• OAuthClientId：アプリケーション設定のOAuth Client Id
• OAuthClientSecret：アプリケーション設定のOAuth Secret

接続すると、CData 製品が自動でOAuth プロセスを完了します。

1. CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
2. CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
3. OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます

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

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

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

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

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

engine = create_engine("saparibasource:///?API=SupplierDataAPIWithPagination-V4&APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU&Environment=SANDBOX&Realm=testRealm&AuthScheme=OAuthClient")

SAP Ariba Source のデータ のマッピングクラスの宣言

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

base = declarative_base()
class Vendors(base):
	__tablename__ = "Vendors"
	SMVendorID = Column(String,primary_key=True)
	Category = Column(String)
	...

SAP Ariba Source のデータ のクエリ

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

query メソッドの使用

engine = create_engine("saparibasource:///?API=SupplierDataAPIWithPagination-V4&APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU&Environment=SANDBOX&Realm=testRealm&AuthScheme=OAuthClient")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Vendors).filter_by(Region="USA"):
	print("SMVendorID: ", instance.SMVendorID)
	print("Category: ", instance.Category)
	print("---------")

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

execute メソッドの使用

Vendors_table = Vendors.metadata.tables["Vendors"]
for instance in session.execute(Vendors_table.select().where(Vendors_table.c.Region == "USA")):
	print("SMVendorID: ", instance.SMVendorID)
	print("Category: ", instance.Category)
	print("---------")

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

SAP Ariba Source のデータ の挿入

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

new_rec = Vendors(SMVendorID="placeholder", Region="USA")
session.add(new_rec)
session.commit()

SAP Ariba Source のデータ の更新

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

updated_rec = session.query(Vendors).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Region = "USA"
session.commit()

SAP Ariba Source のデータ の削除

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

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

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

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