SQLAlchemy ORM を使って、Python でスマレジ データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でスマレジ データをモデル化

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

engine = create_engine("smaregi///?ContractId=mycontractid&AccessToken=myaccesstoken")

スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。

• スマレジにログイン後、「設定」->「システム連携」->「スマレジAPI 設定」に移動します。
• 「API受信設定」セクションにある「受信機能を利用する」を「利用する」に変更し、「アクセストークンの生成」をクリックし、AccessToken を取得します。
• 次に必要なAPI アクセスを有効にするため、「機能設定」セクションで必要な機能を「利用する」に変更します。

ContractId： アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken： 受信設定セクションのアクセストークン。

スマレジ データのマッピングクラスの宣言

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

base = declarative_base()
class Products(base):
	__tablename__ = "Products"
	ProductName = Column(String,primary_key=True)
	Description = Column(String)
	...

スマレジ データをクエリ

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

query メソッドを使う

engine = create_engine("smaregi///?ContractId=mycontractid&AccessToken=myaccesstoken")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Products).filter_by(ProductId="666666"):
	print("ProductName: ", instance.ProductName)
	print("Description: ", instance.Description)
	print("---------")

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

execute メソッドを使う

Products_table = Products.metadata.tables["Products"]
for instance in session.execute(Products_table.select().where(Products_table.c.ProductId == "666666")):
	print("ProductName: ", instance.ProductName)
	print("Description: ", instance.Description)
	print("---------")

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

スマレジ データの挿入（INSERT）

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

new_rec = Products(ProductName="placeholder", ProductId="666666")
session.add(new_rec)
session.commit()

スマレジ データを更新（UPDATE）

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

updated_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ProductId = "666666"
session.commit()

スマレジ データを削除（DELETE）

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

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

スマレジ からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

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

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