今すぐお試しください!

製品の詳細CData Python Connector for Square を確認して、無償評価版をダウンロード:

今すぐダウンロード

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

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

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

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

Square Data への接続

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

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("square///?OAuthClientId=MyAppId&OAuthClientSecret=MyAppSecret&CallbackURL=http://localhost:33333&LocationId=MyDefaultLocation&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

base = declarative_base()
class Refunds(base):
	__tablename__ = "Refunds"
	Reason = Column(String,primary_key=True)
	RefundedMoneyAmount = Column(String)
	...

Square Data をクエリ

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

query メソッドを使う

engine = create_engine("square///?OAuthClientId=MyAppId&OAuthClientSecret=MyAppSecret&CallbackURL=http://localhost:33333&LocationId=MyDefaultLocation&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Refunds).filter_by(Type="FULL"):
	print("Reason: ", instance.Reason)
	print("RefundedMoneyAmount: ", instance.RefundedMoneyAmount)
	print("---------")

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

execute メソッドを使う

Refunds_table = Refunds.metadata.tables["Refunds"]
for instance in session.execute(Refunds_table.select().where(Refunds_table.c.Type == "FULL")):
	print("Reason: ", instance.Reason)
	print("RefundedMoneyAmount: ", instance.RefundedMoneyAmount)
	print("---------")

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

Square Data の挿入(INSERT)

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

new_rec = Refunds(Reason="placeholder", Type="FULL")
session.add(new_rec)
session.commit()

Square Data を更新(UPDATE)

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

updated_rec = session.query(Refunds).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Type = "FULL"
session.commit()

Square Data を削除(DELETE)

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

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

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

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

 
 
ダウンロード