今すぐお試しください!

製品の詳細CData Python Connector for FreshBooks を確認して、無償評価版をダウンロード:

今すぐダウンロード

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

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

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

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

FreshBooks Data への接続

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

FreshBooks はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。

詳細はヘルプドキュメントの「はじめに」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("freshbooks///?CompanyName=CData&Token=token")

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

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

base = declarative_base()
class Clients(base):
	__tablename__ = "Clients"
	Username = Column(String,primary_key=True)
	Credit = Column(String)
	...

FreshBooks Data をクエリ

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

query メソッドを使う

engine = create_engine("freshbooks///?CompanyName=CData&Token=token")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Clients).filter_by(Email="Captain Hook"):
	print("Username: ", instance.Username)
	print("Credit: ", instance.Credit)
	print("---------")

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

execute メソッドを使う

Clients_table = Clients.metadata.tables["Clients"]
for instance in session.execute(Clients_table.select().where(Clients_table.c.Email == "Captain Hook")):
	print("Username: ", instance.Username)
	print("Credit: ", instance.Credit)
	print("---------")

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

FreshBooks Data の挿入(INSERT)

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

new_rec = Clients(Username="placeholder", Email="Captain Hook")
session.add(new_rec)
session.commit()

FreshBooks Data を更新(UPDATE)

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

updated_rec = session.query(Clients).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Email = "Captain Hook"
session.commit()

FreshBooks Data を削除(DELETE)

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

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

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

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

 
 
ダウンロード