SQLAlchemy ORM を使って、Python でShipStation データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

ShipStation Python Connector

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



CData Python Connector for ShipStation を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でShipStation にOR マッピング可能に。

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムShipStation data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。ShipStation に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接ShipStation 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

ShipStation Data への接続

ShipStation data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Use the BASIC Authentication standard to connect.

  1. Login to your ShipStation account
  2. Click on the settings icon in the upper right corner. A column menu will show up on the left
  3. Click Account -> API Settings
  4. On the API Settings page, note the API Key and API Secret.

Authenticating to ShipStation

  • APIKey: Set this to the API key from the API settings page.
  • APISecret: Set this to the Secret key from the API settings page.

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからShipStation に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でShipStation Data をモデル化します

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

engine = create_engine("shipstation///?APIKey='YourAPIKey'&APISecret='YourAPISecret'")

ShipStation Data のマッピングクラスの宣言

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

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

ShipStation Data をクエリ

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

query メソッドを使う

engine = create_engine("shipstation///?APIKey='YourAPIKey'&APISecret='YourAPISecret'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Tags).filter_by(CustomerId="1368175"):
	print("Id: ", instance.Id)
	print("Color: ", instance.Color)
	print("---------")

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

execute メソッドを使う

Tags_table = Tags.metadata.tables["Tags"]
for instance in session.execute(Tags_table.select().where(Tags_table.c.CustomerId == "1368175")):
	print("Id: ", instance.Id)
	print("Color: ", instance.Color)
	print("---------")

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

製品の無償トライアル情報

ShipStation Python Connector の30日の無償トライアル をぜひダウンロードして、ShipStation data への接続をPython アプリやスクリプトから簡単に作成しましょう。