SQLAlchemy ORM を使って、Python でJira Service Desk データに連携

製品をチェック

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Jira Service Desk Python Connector

Jira Service Desk データ連携用Python コネクタライブラリ。Jira Service Desk データをpandas、SQLAlchemy、Dash、petl などの人気のPython ツールにシームレスに統合。


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



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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムJira Service Desk data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Jira Service Desk に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Jira Service Desk 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

Jira Service Desk Data への接続

Jira Service Desk data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

You can establish a connection to any Jira Service Desk Cloud account or Server instance.

Connecting with a Cloud Account

To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Supply the following to connect to data:

  • User: Set this to the username of the authenticating user.
  • APIToken: Set this to the API token found previously.

Connecting with a Service Account

To authenticate with a service account, you will need to supply the following connection properties:

  • User: Set this to the username of the authenticating user.
  • Password: Set this to the password of the authenticating user.
  • URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

Accessing Custom Fields

By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でJira Service Desk Data をモデル化します

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

engine = create_engine("jiraservicedesk///?ApiKey=myApiKey&User=MyUser&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Jira Service Desk Data のマッピングクラスの宣言

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

base = declarative_base()
class Requests(base):
	__tablename__ = "Requests"
	RequestId = Column(String,primary_key=True)
	ReporterName = Column(String)
	...

Jira Service Desk Data をクエリ

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

query メソッドを使う

engine = create_engine("jiraservicedesk///?ApiKey=myApiKey&User=MyUser&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Requests).filter_by(CurrentStatus="Open"):
	print("RequestId: ", instance.RequestId)
	print("ReporterName: ", instance.ReporterName)
	print("---------")

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

execute メソッドを使う

Requests_table = Requests.metadata.tables["Requests"]
for instance in session.execute(Requests_table.select().where(Requests_table.c.CurrentStatus == "Open")):
	print("RequestId: ", instance.RequestId)
	print("ReporterName: ", instance.ReporterName)
	print("---------")

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

Jira Service Desk Data の挿入(INSERT)

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

new_rec = Requests(RequestId="placeholder", CurrentStatus="Open")
session.add(new_rec)
session.commit()

Jira Service Desk Data を更新(UPDATE)

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

updated_rec = session.query(Requests).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CurrentStatus = "Open"
session.commit()

Jira Service Desk Data を削除(DELETE)

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

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

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

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