各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でJira Assets のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でJira Assets にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるJira Assets 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for JiraAssets は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Jira Assets にデータ連携するPython アプリケーションを構築し、Jira Assets のデータを可視化できます。 本記事では、SQLAlchemy でJira Assets に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Jira Assets をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにJira Assets のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてJira Assets の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でJira Assets のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Jira Assets のデータに連携するEngne を作成します。
engine = create_engine("jiraassets///?User=MyUser&APIToken=myApiToken&Url=https://yoursitename.atlassian.net")
Jira Assets は、APIToken 経由での接続と認証をサポートしています。
API トークンを生成するには：
- Atlassian アカウントにログインします。
- セキュリティ設定 > API トークン > API トークンを作成するをクリックします。
Atlassian がAPI トークンを生成して表示します。
API トークンを生成したら、以下のパラメータをセットします。
- AuthScheme：APIToken。
- User：認証するユーザーのログイン名。
- APIToken：生成したAPI トークン。
これでJira Assets に接続して認証する準備が整いました。
Jira Assets のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Objects テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Objects(base): __tablename__ = "Objects" ID = Column(String,primary_key=True) Name = Column(String) ...
Jira Assets のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("jiraassets///?User=MyUser&APIToken=myApiToken&Url=https://yoursitename.atlassian.net")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Objects).filter_by(Label="SYD-1"):
print("ID: ", instance.ID)
print("Name: ", instance.Name)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Objects_table = Objects.metadata.tables["Objects"]
for instance in session.execute(Objects_table.select().where(Objects_table.c.Label == "SYD-1")):
print("ID: ", instance.ID)
print("Name: ", instance.Name)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Jira Assets のデータの挿入（INSERT）
Jira Assets のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Jira Assets にすべての追加インスタンスを送ります。
new_rec = Objects(ID="placeholder", Label="SYD-1") session.add(new_rec) session.commit()
Jira Assets のデータを更新（UPDATE）
Jira Assets のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Jira Assets にレコードを追加します。
updated_rec = session.query(Objects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Label = "SYD-1" session.commit()
Jira Assets のデータを削除（DELETE）
Jira Assets のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Objects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
Jira Assets からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
