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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でGraphQL データをモデル化

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

engine = create_engine("graphql///?AuthScheme=Basic&User=username&Password=password&URL=https://mysite.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

GraphQL サービスのURL を指定する必要があります。 ドライバーは2種類の認証をサポートします。

• Basic: AuthScheme をBasic に設定。GraphQL サービスのUser とPassword を指定する必要があります。
• OAuth 1.0 & 2.0: 詳しい説明は、ヘルプドキュメントのOAuth セクションを参照してください。

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

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

base = declarative_base()
class Users(base):
	__tablename__ = "Users"
	Name = Column(String,primary_key=True)
	Email = Column(String)
	...

GraphQL データをクエリ

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

query メソッドを使う

engine = create_engine("graphql///?AuthScheme=Basic&User=username&Password=password&URL=https://mysite.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Users).filter_by(UserLogin="admin"):
	print("Name: ", instance.Name)
	print("Email: ", instance.Email)
	print("---------")

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

execute メソッドを使う

Users_table = Users.metadata.tables["Users"]
for instance in session.execute(Users_table.select().where(Users_table.c.UserLogin == "admin")):
	print("Name: ", instance.Name)
	print("Email: ", instance.Email)
	print("---------")

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

GraphQL データの挿入（INSERT）

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

new_rec = Users(Name="placeholder", UserLogin="admin")
session.add(new_rec)
session.commit()

GraphQL データを更新（UPDATE）

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

updated_rec = session.query(Users).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.UserLogin = "admin"
session.commit()

GraphQL データを削除（DELETE）

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

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

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

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

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