Python でConfluence データをETL

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Confluence Python Connector

Confluence へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにConfluence をシームレスに統合。



CData Python Connector for Confluence を使って、Python petl でConfluence data のETL 連携・パイプラインアプリケーションを作成。

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

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

Confluence Data への接続

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

API Token を取得する方法

API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

Confluence Cloud Account への接続

Cloud アカウントへの接続には、以下のプロパティを設定します(Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。):

  • User: Confluence サーバーに認証するユーザー名。
  • APIToken: 認証するユーザーに紐付けられたAPI Token。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

Confluence Server Instance への接続

Server instance への接続には以下を設定します:

  • User: Confluence Instance に接続するユーザー名。
  • Password: Confluence Instance に接続するユーザーのパスワード。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

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

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

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 をクエリするSQL 文の作成

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

sql = "SELECT Key, Name FROM Pages WHERE Id = '10000'"

Confluence Data のETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

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

Confluence Python Connector の30日の無償トライアル をぜひダウンロードして、Confluence data への接続を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')