各製品の資料を入手。
詳細はこちら →
製品をチェック
Python でConfluence のデータを変換・出力するETL 処理を作る方法
CData Python Connector とpetl モジュールを使って、Confluence のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。
最終更新日：2023-09-23
この記事で実現できるConfluence 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for Confluence とpetl フレームワークを使って、Confluence のデータにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。
CData Python Connector は効率的なデータ処理によりConfluence のデータ にPython から接続し、高いパフォーマンスを発揮します。Confluence にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接Confluence 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。
必要なモジュールのインストール
pip で必要なモジュールおよびフレームワークをインストールします：
pip install petl pip install pandas
Python でConfluence のデータをETL 処理するアプリを構築
モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。
CData Connector を含むモジュールをインポートします。
import petl as etl import pandas as pd import cdata.confluence as mod
接続文字列で接続を確立します。connect 関数を使って、CData Confluence Connector からConfluence への接続を行います
cnxn = mod.connect("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
Confluence 接続プロパティの取得・設定方法
任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。
Confluence への認証
Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。
API トークン - Confluence Cloud アカウント
トークンの取得
アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。
トークンを使用する認証
Cloud アカウントへの認証を行うには、以下を入力します。
- AuthScheme：APIToken に設定。
- User：Confluence サーバーに認証する際に使用されるユーザー。
- APIToken：現在認証されているユーザーに紐づくAPI トークン。
- Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
Basic 認証 - Confluence Server インスタンス
Server インスタンスへの認証を行うには、以下のように指定します。
- AuthScheme：Basic に設定。
- User：Confluence インスタンスに認証する際に使用されるユーザー。
- Password：Confluence サーバーに認証する際に使われるパスワード。
- Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
Confluence をクエリするSQL 文の作成
Confluence にはSQL でデータアクセスが可能です。Pages エンティティからのデータを読み出します。
sql = "SELECT Key, Name FROM Pages WHERE Id = '10000'"
Confluence データ のETL 処理
DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、Confluence のデータ を取得して、Name カラムでデータをソートして、CSV ファイルにデータをロードします。
table1 = etl.fromdb(cnxn,sql) table2 = etl.sort(table1,'Name') etl.tocsv(table2,'pages_data.csv')
CData Python Connector for Confluence を使えば、データベースを扱う場合と同感覚で、Confluence のデータ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。
おわりに
Confluence Python Connector の30日の無償トライアル をぜひダウンロードして、Confluence のデータ への接続をPython アプリやスクリプトから簡単に作成しましょう。
フルソースコード
import petl as etl
import pandas as pd
import cdata.confluence as mod
cnxn = mod.connect("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
sql = "SELECT Key, Name FROM Pages WHERE Id = '10000'"
table1 = etl.fromdb(cnxn,sql)
table2 = etl.sort(table1,'Name')
etl.tocsv(table2,'pages_data.csv')
関連コンテンツ
