各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でBacklog のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でBacklog にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるBacklog 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Backlog は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Backlog にデータ連携するPython アプリケーションを構築し、Backlog のデータを可視化できます。 本記事では、SQLAlchemy でBacklog に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Backlog をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにBacklog のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてBacklog の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でBacklog のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Backlog のデータに連携するEngne を作成します。
engine = create_engine("backlog///?ApiKey=YOUR_API_KEY&Url=https://yourURL.backlog.com")
Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。
API キー認証
ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：
- Backlog の個人設定ページを開きます。
- 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
- ApiKey にAPI キーを指定します。
- URL はBacklog のテナントURL から取得できます。
OAuth 認証
ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。Backlog のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、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、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Backlog のデータの挿入（INSERT）
Backlog のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Backlog にすべての追加インスタンスを送ります。
new_rec = Issues(Id="placeholder", Id="1") session.add(new_rec) session.commit()
Backlog のデータを更新（UPDATE）
Backlog のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Backlog にレコードを追加します。
updated_rec = session.query(Issues).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Id = "1" session.commit()
Backlog のデータを削除（DELETE）
Backlog のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Issues).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
Backlog からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
