SQLAlchemy ORM を使って、Python でGoogle Cloud Storage データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Google Cloud Storage をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにGoogle Cloud Storage データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてGoogle Cloud Storage の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でGoogle Cloud Storage データをモデル化

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

engine = create_engine("googlecloudstorage///?ProjectId='project1'&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

ユーザーアカウントでの認証

ユーザー資格情報の接続プロパティを設定することなく接続できます。InitiateOAuth をGETANDREFRESH に設定したら、接続の準備が完了です。

接続すると、Google Cloud Storage OAuth エンドポイントがデフォルトブラウザで開きます。ログインして権限を付与すると、OAuth プロセスが完了します。

サービスアカウントでの認証

サービスアカウントには、ブラウザでユーザー認証を行わないサイレント認証があります。サービスアカウントを使用して、企業全体のアクセススコープを委任することもできます。

このフローでは、OAuth アプリケーションを作成する必要があります。詳しくは、ヘルプドキュメントを参照してください。以下の接続プロパティを設定したら、接続の準備が完了です：

• InitiateOAuth: GETANDREFRESH に設定。
• OAuthJWTCertType: PFXFILE に設定。
• OAuthJWTCert: 生成した.p12 ファイルへのパスに設定。
• OAuthJWTCertPassword: .p12 ファイルのパスワードに設定。
• OAuthJWTCertSubject: 証明書ストアの最初の証明書が選ばれるように"*" に設定。
• OAuthJWTIssuer: 「サービスアカウント」セクションで「サービスアカウントの管理」をクリックし、このフィールドをサービスアカウントID フィールドに表示されているE メールアドレスに設定。
• OAuthJWTSubject: サブジェクトタイプが"enterprise" に設定されている場合はエンタープライズID に設定し、"user" に設定されている場合はアプリユーザーID に設定。
• ProjectId: 接続するプロジェクトのID に設定。

これで、サービスアカウントのOAuth フローが完了します。

Google Cloud Storage データのマッピングクラスの宣言

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

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

Google Cloud Storage データをクエリ

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

query メソッドを使う

engine = create_engine("googlecloudstorage///?ProjectId='project1'&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Buckets).filter_by(Name="TestBucket"):
	print("Name: ", instance.Name)
	print("OwnerId: ", instance.OwnerId)
	print("---------")

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

execute メソッドを使う

Buckets_table = Buckets.metadata.tables["Buckets"]
for instance in session.execute(Buckets_table.select().where(Buckets_table.c.Name == "TestBucket")):
	print("Name: ", instance.Name)
	print("OwnerId: ", instance.OwnerId)
	print("---------")

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

Google Cloud Storage からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。