各製品の資料を入手。
詳細はこちら →
SQLAlchemy ORM を使って、Python でBASE のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でBASE にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるBASE 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for API は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで BASE にデータ連携するPython アプリケーションを構築し、BASE のデータを可視化できます。 本記事では、SQLAlchemy でBASE に連携して、データを取得、 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- BASE をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにBASE のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてBASE の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でBASE のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、BASE のデータに連携するEngne を作成します。
engine = create_engine("api///?Profile=Base.apip&Authscheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
最初に、BASE のOAuth アプリを作成する必要があります。作成するには、https://developers.thebase.in/dashboardにアクセスし、「Create New Application」ボタンをクリックします。アプリ名を入力し、リダイレクトURLを指定して「Register」をクリックします。これで、クライアントIDとクライアントシークレットが表示されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme: OAuth に設定します。
- OAuthClientID: アプリ設定で指定したOAuth クライアントID を設定します。
- OAuthClientSecret: アプリ設定で指定したOAuth クライアントシークレットを設定します。
- CallbackURL: アプリ設定で指定したリダイレクトURI を設定します。
- InitiateOAuth: GETANDREFRESH に設定します。この設定を使って、OAuthAccessToken を取得するプロセスを管理できます。
BASE のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Customers, Orders テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Customers, Orders(base): __tablename__ = "Customers, Orders" Customers.ContactName = Column(String,primary_key=True) Orders.OrderDate = Column(String) ...
BASE のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("api///?Profile=Base.apip&Authscheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers, Orders).filter_by(Customers.CustomerID="Orders.CustomerID"):
print("Customers.ContactName: ", instance.Customers.ContactName)
print("Orders.OrderDate: ", instance.Orders.OrderDate)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Customers, Orders_table = Customers, Orders.metadata.tables["Customers, Orders"]
for instance in session.execute(Customers, Orders_table.select().where(Customers, Orders_table.c.Customers.CustomerID == "Orders.CustomerID")):
print("Customers.ContactName: ", instance.Customers.ContactName)
print("Orders.OrderDate: ", instance.Orders.OrderDate)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
BASE からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
