SQLAlchemy ORM を使って、Python でAzure DevOps データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Azure DevOps をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにAzure DevOps データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてAzure DevOps の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でAzure DevOps データをモデル化

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

engine = create_engine("azuredevops///?AuthScheme=Basic&Organization=MyAzureDevOpsOrganization&ProjectId=MyProjectId&PersonalAccessToken=MyPAT&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

AzureDevOps 接続プロパティの取得・設定方法

Azure DevOps アカウントに接続するには、Profile -> Organizations に移動して、アカウント内の組織名であるOrganization を指定します。

例： Organization=MyAzureDevOpsOrganization

NOTE ：Analytics スキーマに接続する場合は、Organization と一緒にProjectId を指定する必要があります。

Azure DevOps への認証

Basic

Organization とPersonalAccessToken を指定することで、Azure DevOps アカウントに接続できます。 パーソナルアクセストークンを生成するには、Azure DevOps Organization アカウントにログインし、Profile -> Personal Access Tokens -> New Token に移動します。生成されたトークンが表示されます。

Azure AD

Azure ADは、OAuth を利用して認証する接続形式です。OAuth は、認証ユーザーがインターネットブラウザを使用してAzure DevOps と通信することを要求します。 CData 製品は、いくつかの方法でこれをサポートします。AuthScheme をAzureAD に設定し、Organization をAzure DevOps の組織名に設定します。 詳しくは、ヘルプドキュメント の「Azure DevOps への認証」セクションを参照してください。

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

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

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

Azure DevOps データをクエリ

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

query メソッドを使う

engine = create_engine("azuredevops///?AuthScheme=Basic&Organization=MyAzureDevOpsOrganization&ProjectId=MyProjectId&PersonalAccessToken=MyPAT&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Builds).filter_by(Reason="Manual"):
	print("Id: ", instance.Id)
	print("BuildNumber: ", instance.BuildNumber)
	print("---------")

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

execute メソッドを使う

Builds_table = Builds.metadata.tables["Builds"]
for instance in session.execute(Builds_table.select().where(Builds_table.c.Reason == "Manual")):
	print("Id: ", instance.Id)
	print("BuildNumber: ", instance.BuildNumber)
	print("---------")

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

Azure DevOps データの挿入（INSERT）

Azure DevOps データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Azure DevOps にすべての追加インスタンスを送ります。

new_rec = Builds(Id="placeholder", Reason="Manual")
session.add(new_rec)
session.commit()

Azure DevOps データを更新（UPDATE）

Azure DevOps データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Azure DevOps にレコードを追加します。

updated_rec = session.query(Builds).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Reason = "Manual"
session.commit()

Azure DevOps データを削除（DELETE）

Azure DevOps データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

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

Azure DevOps からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。