SQLAlchemy ORM を使用して Python で Backlog のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Backlog と SQLAlchemy ツールキットを使用して、Backlog に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Backlog のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Backlog のデータ を操作する際に比類のないパフォーマンスを提供します。Backlog に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Backlog にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Backlog のデータ への接続

Backlog のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

1. Backlog の個人設定ページを開きます。
2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
3. ApiKey にAPI キーを指定します。
4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Backlog にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Backlog のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Backlog のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("backlog:///?ApiKey=YOUR_API_KEY&Url=https://yourURL.backlog.com")

Backlog のデータ のマッピングクラスの宣言

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、Issues テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

base = declarative_base()
class Issues(base):
	__tablename__ = "Issues"
	Id = Column(String,primary_key=True)
	ProjectID = Column(String)
	...

Backlog のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("backlog:///?ApiKey=YOUR_API_KEY&Url=https://yourURL.backlog.com")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Issues).filter_by(Id="1"):
	print("Id: ", instance.Id)
	print("ProjectID: ", instance.ProjectID)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

Issues_table = Issues.metadata.tables["Issues"]
for instance in session.execute(Issues_table.select().where(Issues_table.c.Id == "1")):
	print("Id: ", instance.Id)
	print("ProjectID: ", instance.ProjectID)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

Backlog のデータ の挿入

Backlog のデータ を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを Backlog にプッシュします。

new_rec = Issues(Id="placeholder", Id="1")
session.add(new_rec)
session.commit()

Backlog のデータ の更新

Backlog のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを Backlog にプッシュします。

updated_rec = session.query(Issues).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Id = "1"
session.commit()

Backlog のデータ の削除

Backlog のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

deleted_rec = session.query(Issues).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

無料トライアルと詳細情報

CData Python Connector for Backlog の30日間の無料トライアルをダウンロードして、Backlog のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。