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

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

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

Box への接続

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

Box は、認証にOAuth スタンダードを使用します。Box への認証には、登録アプリのOAuthClientId、OAuthClientSecret、CallbackURL を入力します。詳細はヘルプドキュメントの「はじめに」を参照してください。

尚、本製品はBox のファイルの一覧表示やユーザー管理情報の取得用です。Box に保管されているExcel、CSV、JSON などのファイル内のデータを読み込みたい場合には、Excel Driver、CSV Driver、JSON Driver をご利用ください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でBox データをモデル化

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

engine = create_engine("box///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

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

Box データをクエリ

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

query メソッドを使う

engine = create_engine("box///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Files).filter_by(Id="123"):
	print("Name: ", instance.Name)
	print("Size: ", instance.Size)
	print("---------")

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

execute メソッドを使う

Files_table = Files.metadata.tables["Files"]
for instance in session.execute(Files_table.select().where(Files_table.c.Id == "123")):
	print("Name: ", instance.Name)
	print("Size: ", instance.Size)
	print("---------")

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

Box データの挿入（INSERT）

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

new_rec = Files(Name="placeholder", Id="123")
session.add(new_rec)
session.commit()

Box データを更新（UPDATE）

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

updated_rec = session.query(Files).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Id = "123"
session.commit()

Box データを削除（DELETE）

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

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

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

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