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

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

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Smaregi Python Connector

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



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

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

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

Smaregi Data への接続

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

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

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

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

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

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

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

Smaregi Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Smaregi Data の挿入(INSERT)

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

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

Smaregi Data を更新(UPDATE)

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

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

Smaregi Data を削除(DELETE)

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

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

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

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