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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でPCA Sales データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、PCA Sales データに連携する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 クラウド商魂・商管DX では、OAuth 2 認証標準を使います。

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

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

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

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

PCA Sales データのマッピングクラスの宣言

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

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

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

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

PCA Sales データを更新（UPDATE）

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

PCA Sales データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 へのデータ連携には、ぜひCData Python Connector をご利用ください

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

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