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

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



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

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

Carbone のデータ への接続

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

まず、Profile 接続プロパティをディスク上の Carbone プロファイルの場所に設定します（例：C:\profiles\Carbone.apip）。次に、ProfileSettings 接続プロパティを Carbone の接続文字列に設定します（以下を参照）。

Carbone API プロファイル設定

Carbone では、Authorization ヘッダーの Bearer トークンによる API キー認証を使用します。API キーは以下の手順で取得できます。

  1. https://account.carbone.io で Carbone アカウントにログインします。
  2. アカウントのホームページに表示されている API キーをコピーします。

API キーを取得したら、以下の接続プロパティを設定します。

  • AuthScheme：APIKey に設定します。
  • APIKey：Carbone の API キー（Bearer トークン）に設定します。
  • CarboneVersion：（オプション）carbone-version リクエストヘッダーで指定する、対象の Carbone API のメジャーバージョンです。デフォルトは 5 です。指定できる値は 5、4、3、staging です。

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

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

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 での Carbone のデータ のモデリング

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

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


engine = create_engine("api:///?Profile=C:\profiles\Carbone.apip&AuthScheme=APIKey&APIKey=your_api_key")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、Templates テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。 


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

Carbone のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用


engine = create_engine("api:///?Profile=C:\profiles\Carbone.apip&AuthScheme=APIKey&APIKey=your_api_key")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Templates).filter_by(Category="Invoices"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用


Templates_table = Templates.metadata.tables["Templates"]
for instance in session.execute(Templates_table.select().where(Templates_table.c.Category == "Invoices")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

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

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

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

API Driver で Carbone のライブデータに接続

Carbone に接続

この記事の内容

関連記事