ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →Adobe Commerce Connector の30日間無償トライアルをダウンロード
30日間の無償トライアルへ製品の詳細
Adobe Commerce Python Connector 相談したいAdobe Commerce へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにAdobe Commerce をシームレスに統合。
CData
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for AdobeCommerce は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Adobe Commerce にデータ連携するPython アプリケーションを構築し、Adobe Commerce データを可視化できます。 本記事では、SQLAlchemy でAdobe Commerce に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors は、以下のような特徴を持った製品です。
CData Python Connectors では、1.データソースとしてAdobe Commerce の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
pip でSQLAlchemy ツールキットをインストールします:
pip install sqlalchemy
モジュールのインポートを忘れずに行います:
import sqlalchemy
次は、接続文字列で接続を確立します。create_engine 関数を使って、Adobe Commerce データに連携するEngne を作成します。
engine = create_engine("adobecommerce///?OAuthClientId=MyConsumerKey&OAuthClientSecret=MyConsumerSecret&CallbackURL=http://127.0.0.1:33333&Url=https://myadobecommercehost.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Adobe Commerce はOAuth 1 認証標準を使用します。Adobe Commerce REST API に接続するには、Adobe Commerce システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。
また、Adobe Commerce システムへのURL を提供する必要があります。URL は、Adobe Commerce REST API を顧客として使用しているか管理者として使用しているかによって異なります。
Customer: Adobe Commerce を顧客として使用するには、事前にAdobe Commerce のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをAdobe Commerce システムのエンドポイントに設定します。
Administrator: Adobe Commerce を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。
このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Products テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。
base = declarative_base() class Products(base): __tablename__ = "Products" Name = Column(String,primary_key=True) Price = Column(String) ...
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
engine = create_engine("adobecommerce///?OAuthClientId=MyConsumerKey&OAuthClientSecret=MyConsumerSecret&CallbackURL=http://127.0.0.1:33333&Url=https://myadobecommercehost.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Products).filter_by(Style="High Tech"): print("Name: ", instance.Name) print("Price: ", instance.Price) print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
Products_table = Products.metadata.tables["Products"] for instance in session.execute(Products_table.select().where(Products_table.c.Style == "High Tech")): print("Name: ", instance.Name) print("Price: ", instance.Price) print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Adobe Commerce データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Adobe Commerce にすべての追加インスタンスを送ります。
new_rec = Products(Name="placeholder", Style="High Tech") session.add(new_rec) session.commit()
Adobe Commerce データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Adobe Commerce にレコードを追加します。
updated_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Style = "High Tech" session.commit()
Adobe Commerce データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。