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

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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;")

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

1. Backlog の個人設定ページを開きます。
2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
3. ApiKey にAPI キーを指定します。
4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

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

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

sql = "SELECT Id, ProjectID FROM Issues WHERE Id = '1'"

Backlog データ のETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;")

sql = "SELECT Id, ProjectID FROM Issues WHERE Id = '1'"

table1 = etl.fromdb(cnxn,sql)

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

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