SQLAlchemy ORM を使って、Python でConfluence データに連携

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

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Confluence Python Connector

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



CData Python Connector for Confluence を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でConfluence にOR マッピング可能に。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Confluence は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Confluence にデータ連携するPython アプリケーションを構築し、Confluence data をビジュアライズできます。 本記事では、SQLAlchemy でConfluence に連携して、データを取得、 する方法を説明します。

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

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからConfluence に接続します。

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

pip でSQLAlchemy ツールキットをインストールします:

pip install sqlalchemy

モジュールのインポートを忘れずに行います:

import sqlalchemy

Python でConfluence Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、Confluence data に連携するEngne を作成します。

engine = create_engine("confluence///?User=admin&APIToken=myApiToken&Url=https://yoursitename.atlassian.net&Timezone=America/New_York")

Confluence Data のマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Pages テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。

base = declarative_base()
class Pages(base):
	__tablename__ = "Pages"
	Key = Column(String,primary_key=True)
	Name = Column(String)
	...

Confluence Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("confluence///?User=admin&APIToken=myApiToken&Url=https://yoursitename.atlassian.net&Timezone=America/New_York")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Pages).filter_by(Id="10000"):
	print("Key: ", instance.Key)
	print("Name: ", instance.Name)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Pages_table = Pages.metadata.tables["Pages"]
for instance in session.execute(Pages_table.select().where(Pages_table.c.Id == "10000")):
	print("Key: ", instance.Key)
	print("Name: ", instance.Name)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

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

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