SQLAlchemy ORM を使って、Python でSAP Netweaver Gateway データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

SAP Netweaver Gateway Python Connector

SAP Netweaver Gateway データ連携用Python コネクタライブラリ。SAP Netweaver Gateway データをPandas、SQLAlchemy、Dash、petl などの人気のPython ツールにシームレスに統合。



CData Python Connector for SAP Netweaver Gateway を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でSAP Netweaver Gateway にOR マッピング可能に。

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムSAP Netweaver Gateway data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。SAP Netweaver Gateway に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接SAP Netweaver Gateway 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

SAP Netweaver Gateway Data への接続

SAP Netweaver Gateway data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

SAP Gateway はBasic 認証とOAuth 2.0 認証の両方を許可します。Basic 認証を使用して自分のアカウントに接続するか、OAuth を使用して他のユーザーが彼らのアカウントでサービスからデータを取得できるようにすることができます。基本となる認証情報に加え、SAP Gateway テーブルへのアクセスには以下の追加プロパティが必要です。

  • Url: 環境のURL、またはサービスの完全URL に設定。例えば、完全URL は次のようになります:https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/。この例では、環境URL は次のようになります:https://sapes5.sapdevcenter.com。
  • Namespace: 適切なService Namespace を設定。先ほどの例では、IWBEP が名前空間です。サービスへの完全URL が指定されている場合は任意です。
  • Service: データを取得するサービスに設定。先ほどの例では、サービスはGWSAMPLE_BASIC です。完全URL が指定されている場合は必須ではありません。

Basic 認証での認証

Basic 認証では、自分のログインクレデンシャルを使用して接続します。次のプロパティを設定します。

  • User: これはSAP Gateway へのログインに使用するユーザー名です。
  • Password: これはSAP Gateway へのログインに使用するパスワードです。

OAuth 認証での認証

ユーザー資格情報の接続プロパティを設定せずに接続できます。 接続すると、本製品はデフォルトブラウザでSAP Gateway OAuth エンドポイントを開きます。ログインして、本製品にアクセス許可を与えます。本製品が以下のOAuth プロセスを完了します。 他のOAuth 認証フローについては、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからSAP Netweaver Gateway に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSAP Netweaver Gateway Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、SAP Netweaver Gateway data に連携する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 Netweaver Gateway Data のマッピングクラスの宣言

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Data の挿入(INSERT)

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

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

SAP Netweaver Gateway Data を更新(UPDATE)

SAP Netweaver Gateway data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションで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 Data を削除(DELETE)

SAP Netweaver Gateway data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 Connector の30日の無償トライアル をぜひダウンロードして、SAP Netweaver Gateway data への接続をPython アプリやスクリプトから簡単に作成しましょう。