SQLAlchemy ORM を使って、Python でSAP Netweaver Gateway のデータに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for SAPGateway は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで SAP Netweaver Gateway にデータ連携するPython アプリケーションを構築し、SAP Netweaver Gateway のデータを可視化できます。 本記事では、SQLAlchemy でSAP Netweaver Gateway に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. SAP Netweaver Gateway をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSAP Netweaver Gateway のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSAP Netweaver Gateway の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSAP Netweaver Gateway のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、SAP Netweaver Gateway のデータに連携するEngne を作成します。

engine = create_engine("sapgateway///?User=user&Password=password&URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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 へのログインに使用するパスワード。

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

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

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

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、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/&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
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、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

SAP Netweaver Gateway のデータの挿入（INSERT）

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

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

SAP Netweaver Gateway のデータを更新（UPDATE）

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 のデータを削除（DELETE）

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()

SAP Netweaver Gateway からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。