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

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

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

PCA Sales Python Connector

PCA Sales データ連携用のPython Connector ライブラリ。pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにAutify をシームレスに統合。



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

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

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

PCA Sales Data への接続

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

PCA クラウド商魂・商管DX では、OAuth 2 認証標準を使います。

ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、次のとおりです。

  • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動での接続文字列のアクセストークン設定の繰り返しを避けられます。
  • OAuthClientId:アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • CallbackURL:アプリケーション設定のリダイレクトURL に設定。
  • ApiVersion:接続するPCA API Server バージョンを設定。
  • DefaultDataArea:接続するデータ領域を設定。
  • DataCenter:接続するサーバーのDataCenter 名を設定。
  • ProductCode:PCA 製品コード名を設定。

接続すると、本製品はデフォルトブラウザでPCA Accounting OAuth エンドポイントを開きます。ログインして、本製品にアクセス許可を与えます。本製品がOAuth プロセスを完了します。

ヘッドレスマシンの認証など、他のOAuth 認証フローについては、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でPCA Sales Data をモデル化します

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

engine = create_engine("pcasales///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&ProductCode=MyProductCode&ApiVersion=V1&DataCenter=DataCenterName&DefaultDataArea=MyDefaultDataArea&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

base = declarative_base()
class MasterSms(base):
	__tablename__ = "MasterSms"
	SyohinCode = Column(String,primary_key=True)
	SyohinMei = Column(String)
	...

PCA Sales Data をクエリ

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

query メソッドを使う

engine = create_engine("pcasales///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&ProductCode=MyProductCode&ApiVersion=V1&DataCenter=DataCenterName&DefaultDataArea=MyDefaultDataArea&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(MasterSms).filter_by(SyohinMei="Syohin"):
	print("SyohinCode: ", instance.SyohinCode)
	print("SyohinMei: ", instance.SyohinMei)
	print("---------")

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

execute メソッドを使う

MasterSms_table = MasterSms.metadata.tables["MasterSms"]
for instance in session.execute(MasterSms_table.select().where(MasterSms_table.c.SyohinMei == "Syohin")):
	print("SyohinCode: ", instance.SyohinCode)
	print("SyohinMei: ", instance.SyohinMei)
	print("---------")

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

PCA Sales Data の挿入(INSERT)

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

new_rec = MasterSms(SyohinCode="placeholder", SyohinMei="Syohin")
session.add(new_rec)
session.commit()

PCA Sales Data を更新(UPDATE)

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

updated_rec = session.query(MasterSms).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.SyohinMei = "Syohin"
session.commit()

PCA Sales Data を削除(DELETE)

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

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

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

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