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

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

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

SAP Netweaver Gateway のデータ への接続

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

SAP Gateway 接続プロパティの取得・設定方法

SAP Gateway のテーブルにアクセスするには、次の接続プロパティを設定します。

• URL = お使いの環境のURL、またはサービスの完全URL。例えば、完全URL は次のようになります：https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/。この例では、環境URL は次のようになります：https://sapes5.sapdevcenter.com。CustomUrlParams プロパティを使用して、追加プロパティを追加します。
• Namespace = 適切なService Namespace。先ほどの例では、IWBEP が名前空間です。サービスへの完全URL が指定されている場合は任意です。
• Service = データを取得するサービス。先ほどの例では、サービスはGWSAMPLE_BASIC です。完全URL が指定されている場合は必須ではありません。
• CustomUrlParams = HTTP リクエストに含まれる必要のある追加プロパティ；例えばsap-client=001&sap-language=EN。

SAP Gateway への認証

SAP Gateway はBasic 認証、OAuth 2.0 認証、SAP BTP Destination 認証を許可します。

Basic 認証

Basic 認証を有効にするには、以下のプロパティを設定します。

• AuthScheme = Basic。
• User = SAP Gateway へのログインに使用するユーザー名。
• Password = SAP Gateway へのログインに使用するパスワード。

上記のプロパティを設定したら、接続の準備は完了です。ローカルデータにアクセスするには、個人の認証情報を使用します。

他の認証方法については、ヘルプドキュメントの「接続の確立」セクションを参照してください。

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

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

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

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

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

engine = create_engine("sapgateway:///?User=user&Password=password&URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/")

SAP Netweaver Gateway のデータ のマッピングクラスの宣言

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

base = declarative_base()
class SalesOrderLineItems(base):
	__tablename__ = "SalesOrderLineItems"
	ProductID = Column(String,primary_key=True)
	Quantity = Column(String)
	...

SAP Netweaver Gateway のデータ のクエリ

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

query メソッドの使用

engine = create_engine("sapgateway:///?User=user&Password=password&URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(SalesOrderLineItems).filter_by(Quantity="15"):
	print("ProductID: ", instance.ProductID)
	print("Quantity: ", instance.Quantity)
	print("---------")

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

execute メソッドの使用

SalesOrderLineItems_table = SalesOrderLineItems.metadata.tables["SalesOrderLineItems"]
for instance in session.execute(SalesOrderLineItems_table.select().where(SalesOrderLineItems_table.c.Quantity == "15")):
	print("ProductID: ", instance.ProductID)
	print("Quantity: ", instance.Quantity)
	print("---------")

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

SAP Netweaver Gateway のデータ の挿入

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

new_rec = SalesOrderLineItems(ProductID="placeholder", Quantity="15")
session.add(new_rec)
session.commit()

SAP Netweaver Gateway のデータ の更新

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

updated_rec = session.query(SalesOrderLineItems).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Quantity = "15"
session.commit()

SAP Netweaver Gateway のデータ の削除

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

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

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

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