Python でSquare データを変換・出力するETL 処理を作る方法

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

Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for Square とpetl フレームワークを使って、Square データにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

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

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

pip で必要なモジュールおよびフレームワークをインストールします：

pip install petl
pip install pandas

Python でSquare データをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

CData Connector を含むモジュールをインポートします。

import petl as etl
import pandas as pd
import cdata.square as mod

接続文字列で接続を確立します。connect 関数を使って、CData Square Connector からSquare への接続を行います

cnxn = mod.connect("OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

Square をクエリするSQL 文の作成

Square にはSQL でデータアクセスが可能です。Refunds エンティティからのデータを読み出します。

sql = "SELECT Reason, RefundedMoneyAmount FROM Refunds WHERE Type = 'FULL'"

Square データ のETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、Square データ を取得して、RefundedMoneyAmount カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'RefundedMoneyAmount')

etl.tocsv(table2,'refunds_data.csv')

CData Python Connector for Square を使えば、データベースを扱う場合と同感覚で、Square データ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

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

フルソースコード

import petl as etl
import pandas as pd
import cdata.square as mod

cnxn = mod.connect("OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT Reason, RefundedMoneyAmount FROM Refunds WHERE Type = 'FULL'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'RefundedMoneyAmount')

etl.tocsv(table2,'refunds_data.csv')