SQLAlchemy ORM を使って、Python でUPS データに連携

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

製品の詳細情報:

UPS 連携ソリューション


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

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

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

UPS Data への接続

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

The driver uses five pieces of information in order to authenticate its actions with the UPS service.

  • Server: This controls the URL where the requests should be sent. Common testing options for this are: https://wwwcie.ups.com/ups.app/xml and https://wwwcie.ups.com/webservices
  • AccessKey: This is an identifier that is required to connect to a UPS Server. This value will be provided to you by UPS after registration.
  • UserId: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • Password: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • AccountNumber: This is a valid 6-digit or 10-digit UPS account number.
  • PrintLabelLocation: This property is required if one intends to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でUPS Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、UPS data に連携するEngne を作成します。

engine = create_engine("ups///?Server=https://wwwcie.ups.com/ups.app/xml&AccessKey=myAccessKey&Password=myPassword&AccountNumber=myAccountNumber&UserId=myUserIdInitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

UPS Data のマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Senders テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。

base = declarative_base()
class Senders(base):
	__tablename__ = "Senders"
	FirstName = Column(String,primary_key=True)
	Phone = Column(String)
	...

UPS Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("ups///?Server=https://wwwcie.ups.com/ups.app/xml&AccessKey=myAccessKey&Password=myPassword&AccountNumber=myAccountNumber&UserId=myUserIdInitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Senders).filter_by(SenderID="25"):
	print("FirstName: ", instance.FirstName)
	print("Phone: ", instance.Phone)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Senders_table = Senders.metadata.tables["Senders"]
for instance in session.execute(Senders_table.select().where(Senders_table.c.SenderID == "25")):
	print("FirstName: ", instance.FirstName)
	print("Phone: ", instance.Phone)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

UPS Data の挿入(INSERT)

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

new_rec = Senders(FirstName="placeholder", SenderID="25")
session.add(new_rec)
session.commit()

UPS Data を更新(UPDATE)

UPS data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、UPS にレコードを追加します。

updated_rec = session.query(Senders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.SenderID = "25"
session.commit()

UPS Data を削除(DELETE)

UPS data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

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

製品の無償トライアル情報

UPS Python Connector の30日の無償トライアル をぜひダウンロードして、UPS data への接続をPython アプリやスクリプトから簡単に作成しましょう。