SQLAlchemy ORM を使用して Python で WordPress のデータ にアクセスする方法

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
SQLAlchemy オブジェクトリレーショナルマッピングを使用して、WordPress のデータ を操作する Python アプリケーションとスクリプトを作成します。

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Wordpress と SQLAlchemy ツールキットを使用して、WordPress に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して WordPress のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの WordPress のデータ を操作する際に比類のないパフォーマンスを提供します。WordPress に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 WordPress にプッシュし、サポートされていない操作(多くの場合 SQL 関数や JOIN 操作)は組み込みの SQL エンジンを使用してクライアント側で処理します。

WordPress のデータ への接続

WordPress のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

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

現時点では、CData JDBC Driver for WordPress はセルフホスト型のWordPress インスタンスへの接続のみをサポートしています。データに接続するには、Url を自身の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 認証プラグインの使用が必要です。)
Basic 認証を構成するには:
  1. WordPress ホストにログインします。
  2. 4.7より前のバージョンのWordPress を実行している場合は、REST API プラグインをインストールしてください。
  3. Basic Authentication プラグインをインストールします。
  4. カスタムタクソノミーを作成するには、Simple Taxonomy Refreshed をインストールします。プラグインを手動でインストールしたい場合は、圧縮されたフォルダをwp-content\plugins フォルダに展開してからWordPress 管理者インターフェース経由でプラグインを有効にします。
  5. 次の接続プロパティを設定します。
    • AuthSchemeBasic
    • Url:WordPress URL。
    • User:ユーザーネーム。
    • Password:パスワード。
OAuth 2.0 認証についてはヘルプドキュメントを参照してください。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて WordPress にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での WordPress のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、WordPress のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("wordpress:///?Url=http://www.yourwordpresshost.com")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します(この記事では、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")
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、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

WordPress のデータ の挿入

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

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

WordPress のデータ の更新

WordPress のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを WordPress にプッシュします。

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

WordPress のデータ の削除

WordPress のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード(行)に対して削除操作を実行します。

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

無料トライアルと詳細情報

CData Python Connector for Wordpress の30日間の無料トライアルをダウンロードして、WordPress のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。

はじめる準備はできましたか?

Wordpress Connector のコミュニティライセンスをダウンロード:

 ダウンロード

詳細:

Wordpress Icon Wordpress Python Connector お問い合わせ

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