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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("wordpress///?Url=http://www.yourwordpresshost.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

URL を完全な形式で記入します。例えば、あなたのサイトが'http://localhost/wp/wordpress' でホストされている場合、URL は'http://localhost' ではなく、'http://localhost/wp/wordpress' となるべきです。 URL を完全な形式で入力しないと、'site not found' というエラーが発生します。

WordPress は2種類の認証をサポートします。

• Basic 認証は、テスト環境での使用が推奨されます。
• OAuth 2.0 認証は、デスクトップアプリケーション、Web アプリケーション、またはヘッドレスマシンからのブラウザベースのアクセスをサポートします。

Basic 認証

Basic 認証を使用するようにWordPress を設定する前に：

• WordPress ログインに管理者権限があることを確認してください。
• ローカルホストで実行されているWordPress のバージョンを確認します。（WordPress 4.7 以降はネイティブでWordPress REST API サポートしていますが、それより前のバージョンでは、REST API へのアクセスを安全に行うには、Basic 認証プラグインの使用が必要です。）

1. WordPress ホストにログインします。
2. 4.7より前のバージョンのWordPress を実行している場合は、REST API プラグインをインストールしてください。
3. Basic Authentication プラグインをインストールします。
4. カスタムタクソノミーを作成するには、Simple Taxonomy Refreshed をインストールします。プラグインを手動でインストールしたい場合は、圧縮されたフォルダをwp-content\plugins フォルダに展開してからWordPress 管理者インターフェース経由でプラグインを有効にします。
5. 次の接続プロパティを設定します。
   • AuthScheme：Basic。
   • Url：WordPress URL。
   • User：ユーザーネーム。
   • Password：パスワード。

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

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

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

WordPress のデータをクエリ

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

query メソッドを使う

engine = create_engine("wordpress///?Url=http://www.yourwordpresshost.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Categories).filter_by(Id="1"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

execute メソッドを使う

Categories_table = Categories.metadata.tables["Categories"]
for instance in session.execute(Categories_table.select().where(Categories_table.c.Id == "1")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

WordPress のデータの挿入（INSERT）

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

new_rec = Categories(Id="placeholder", Id="1")
session.add(new_rec)
session.commit()

WordPress のデータを更新（UPDATE）

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

updated_rec = session.query(Categories).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Id = "1"
session.commit()

WordPress のデータを削除（DELETE）

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

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

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

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

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