Python でFreshdesk データをETL

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for FreshDesk とpetl フレームワークを使って、Freshdesk に連携するPython アプリや、Freshdesk データをETL することが可能です。本記事では、CData Python Connector をpetl と一緒に使い、ETL 処理を実装します。

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

Freshdesk Data への接続

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

FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。

• Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
• APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。

CData Freshdesk Connector をインストールしたら、次のように必要なモジュールをインストールし、Python オブジェクトでFreshdesk にアクセスします。

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Domain=MyDomain;APIKey=myAPIKey;")

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

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

sql = "SELECT Id, Name FROM Tickets WHERE Status = '2'"

Freshdesk Data のETL 処理

DataFrame に格納されたクエリ結果を使って、petl でExtract（取得）、Transform（加工）、Load（ロード）を組みます。この例では、Freshdesk data を取得して、Name カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

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

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

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

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

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

フルソースコード

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

cnxn = mod.connect("Domain=MyDomain;APIKey=myAPIKey;")

sql = "SELECT Id, Name FROM Tickets WHERE Status = '2'"

table1 = etl.fromdb(cnxn,sql)

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

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