Confluence のデータをPythonのpetlでETL処理する方法｜CData Connect AI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのConfluence のデータを抽出・変換するETLパイプラインの構築方法を解説。

CData Connect AI の Python SDK と petl フレームワークを使うと、Confluence のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、Confluence のデータを抽出・変換して CSV などに出力する Confluence 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってConfluence のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

Confluence データの定期抽出パイプライン構築

SQL クエリで取得した Confluence のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで Confluence 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

Confluence への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを Confluence に自動で書き戻す処理を組み込めます。

Connect AI で Confluence に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「Confluence」を選択します
    3. データソースの選択
  3. Confluence に接続するために必要な認証プロパティを入力します。

    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 です。
    その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で Confluence のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Confluence をクエリする SQL ステートメントを作成する方法は？

SQL を使って、Confluence をクエリするステートメントを作成します。この記事では、Pages エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Confluence1）になります。

sql = (
    "SELECT Key, Name "
    "FROM [Confluence1].[Confluence].[Pages] "
    "WHERE Id = '10000'"
)

Confluence のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってConfluence のデータを抽出・変換・ロードします。この例では、Confluence のデータを抽出し、Name カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

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

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

Confluence は Connect AI では読み取り専用のソースのため、このパイプラインではConfluence のデータの抽出と変換はできますが、行の書き戻しはできません。抽出が完了したら接続を閉じましょう。

conn.close()

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにConfluence のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのConfluence のデータをパイプライン処理できるようになりました。Confluence（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Key, Name "
    "FROM [Confluence1].[Confluence].[Pages] "
    "WHERE Id = '10000'"
)

table1 = etl.fromdb(conn, sql)

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

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

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事