各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でQuickBooks のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でQuickBooks にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるQuickBooks 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for QuickBooks は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで QuickBooks にデータ連携するPython アプリケーションを構築し、QuickBooks のデータを可視化できます。 本記事では、SQLAlchemy でQuickBooks に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- QuickBooks をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにQuickBooks のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてQuickBooks の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でQuickBooks のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、QuickBooks のデータに連携するEngne を作成します。
engine = create_engine("quickbooks///?URL=http://remotehost:8166&User=admin&Password=admin123")
ローカルQuickBooks インスタンスへの接続には接続プロパティ入力は不要です。
CData 製品は、リモートコネクタ経由でQuickBooks にリクエストを作成します。リモートコネクタはQuickBooks と同じマシン上で動作し、軽量の組み込みWeb サーバーを介して接続を受け入れます。サーバーはSSL/TLS をサポートし、ユーザーにリモートマシンからのセキュアな接続を可能にします。
初めて接続するときは、CData 製品をQuickBooks で認証する必要があります。詳しくは、ヘルプドキュメントの「Using the Remote Connector」を参照してください。
QuickBooks のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Customers テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Customers(base): __tablename__ = "Customers" Name = Column(String,primary_key=True) CustomerBalance = Column(String) ...
QuickBooks のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("quickbooks///?URL=http://remotehost:8166&User=admin&Password=admin123")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(Type="Commercial"):
print("Name: ", instance.Name)
print("CustomerBalance: ", instance.CustomerBalance)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.Type == "Commercial")):
print("Name: ", instance.Name)
print("CustomerBalance: ", instance.CustomerBalance)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
QuickBooks のデータの挿入（INSERT）
QuickBooks のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、QuickBooks にすべての追加インスタンスを送ります。
new_rec = Customers(Name="placeholder", Type="Commercial") session.add(new_rec) session.commit()
QuickBooks のデータを更新（UPDATE）
QuickBooks のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、QuickBooks にレコードを追加します。
updated_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Type = "Commercial" session.commit()
QuickBooks のデータを削除（DELETE）
QuickBooks のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
QuickBooks からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
