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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でXML のデータをモデル化

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

engine = create_engine("xml///?URI=C:/people.xml&DataModel=Relational")

データソースを認証するには、データプロバイダーのドキュメント内の「はじめに」セクションをご覧ください。 データプロバイダーはXML API を双方向データベーステーブルとしてモデル化し、XML ファイルをread-only ビュー（ローカルファイル、人気のクラウドサービスに格納されたファイル、およびFTP サーバー）としてモデル化します。 HTTP Basic、Digest、NTLM、OAuth、およびFTP を含む主な認証スキームはサポートされています。認証のガイドについては、データプロバイダーのドキュメント内の「はじめに」セクションをご覧ください。

URI と認証値を設定した後で、DataModel を設定することでデータの構造によりよくマッチするようデータの抽象化を調整できます。

DataModel プロパティはデータがどのようにテーブルとして抽象化されるかを制御するプロパティであり、次の基本的な設定を調整します。

• Document（デフォルト）：XML データのトップレベルのドキュメントビューをモデル化します。データプロバイダーは入れ子化した要素をデータの集約値として返します。
• FlattenedDocuments：入れ子化したドキュメントとその親を結合して単一のテーブルに入力します。
• Relational：個別の関連テーブルを階層化されたデータから返します。テーブルは主キーと、親ドキュメントにリンクする外部キーを含みます。

リレーショナルな抽象化の設定についての詳細は、「XML データのモデリング」セクションを参照してください。次の例で使用されているサンプルデータも存在します。 このデータには、人名、その人たちが所有する車、車に施されたさまざまなメンテナンスに関する情報が含まれます。

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

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

base = declarative_base()
class people(base):
	__tablename__ = "people"
	[ personal.name.first ] = Column(String,primary_key=True)
	[ personal.name.last ] = Column(String)
	...

XML のデータをクエリ

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

query メソッドを使う

engine = create_engine("xml///?URI=C:/people.xml&DataModel=Relational")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(people).filter_by([ personal.name.last ]="Roberts"):
	print("[ personal.name.first ]: ", instance.[ personal.name.first ])
	print("[ personal.name.last ]: ", instance.[ personal.name.last ])
	print("---------")

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

execute メソッドを使う

people_table = people.metadata.tables["people"]
for instance in session.execute(people_table.select().where(people_table.c.[ personal.name.last ] == "Roberts")):
	print("[ personal.name.first ]: ", instance.[ personal.name.first ])
	print("[ personal.name.last ]: ", instance.[ personal.name.last ])
	print("---------")

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

XML のデータの挿入（INSERT）

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

new_rec = people([ personal.name.first ]="placeholder", [ personal.name.last ]="Roberts")
session.add(new_rec)
session.commit()

XML のデータを更新（UPDATE）

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

updated_rec = session.query(people).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.[ personal.name.last ] = "Roberts"
session.commit()

XML のデータを削除（DELETE）

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

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

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

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

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