SQLAlchemy ORM を使って、Python でBカート のデータに連携する方法

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

加藤龍彦
デジタルマーケティング

最終更新日:2023-09-23

この記事で実現できるBカート 連携のシナリオ

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でBカート のデータをモデル化

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

engine = create_engine("bcart///?InitiateOAuth=GETANDREFRESH")

BCart への接続にはパーソナルアクセストークンが必要です。 BCart API 管理ページにログイン後、「アプリケーション管理」画面のCreate New Token をクリックし、Name を入力して必要な権限を設定します。設定すると、パーソナルアクセストークンを取得できます。その後、接続プロパティ、または接続文字列のPersonalAccessToken に生成されたパーソナルアクセストークンを設定します。

Bカート のデータのマッピングクラスの宣言

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

base = declarative_base()
class Orders(base):
	__tablename__ = "Orders"
	CustomerName = Column(String,primary_key=True)
	TotalPrice = Column(String)
	...

Bカート のデータをクエリ

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

query メソッドを使う

engine = create_engine("bcart///?InitiateOAuth=GETANDREFRESH")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(CustomerId="123436"):
	print("CustomerName: ", instance.CustomerName)
	print("TotalPrice: ", instance.TotalPrice)
	print("---------")

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

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.CustomerId == "123436")):
	print("CustomerName: ", instance.CustomerName)
	print("TotalPrice: ", instance.TotalPrice)
	print("---------")

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

Bカート のデータの挿入(INSERT)

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

new_rec = Orders(CustomerName="placeholder", CustomerId="123436")
session.add(new_rec)
session.commit()

Bカート のデータを更新(UPDATE)

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CustomerId = "123436"
session.commit()

Bカート のデータを削除(DELETE)

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

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。