製品をチェック

IBM Cloud Object Storage Connector の30日間無償トライアルをダウンロード

 ダウンロードはこちら

製品の詳細

IBM Cloud Object Storage アイコン IBM Cloud Object Storage Python Connector 相談したい

IBM Cloud Object Storage データ連携用のPython コネクタライブラリ。IBM Cloud Object Storage データをpandas、SQLAlchemy、Dash、petl などの人気のPython ツールにシームレスに統合。

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

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

加藤龍彦
ウェブデベロッパー

最終更新日:2023-09-23
ibmcloudobjectstorage ロゴ

CData

python ロゴ画像
Python ロゴ

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でIBM Cloud Object Storage データをモデル化

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

engine = create_engine("ibmcloudobjectstorage///?ApiKey=myApiKey&CloudObjectStorageCRN=MyInstanceCRN&Region=myRegion&OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret")

Cloud Object Storage 接続プロパティの取得・設定方法

Cloud Object Storage に接続する前に、Cloud Object Storage インスタンスを登録してCloud Object Storage API キーとCRN を取得していきます。

Cloud Object Storage の新規インスタンスの登録

IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

  1. IBM Cloud アカウントにログインします。
  2. Cloud Object Storage ページに移動して、インスタンス名を指定して「作成」をクリックします。Cloud Object Storage の新規インスタンスにリダイレクトされます。

API キー

API キーは以下の手順で取得できます。

  1. まずは、IBM Cloud アカウントにログインします。
  2. API キーページに移動します。
  3. 中央右隅のIBM Cloud APIキーの作成 をクリックして、新しいAPI キーを作成します。
  4. ポップアップウィンドウが表示されたら、API キーの名前を指定して作成をクリックします。ダッシュボードからはアクセスできなくなるため、API Key を控えておきましょう。

Cloud Object Storage CRN

デフォルトでは、CData 製品はCloud Object Storage CRN を自動で取得します。ただし、複数のアカウントがある場合は、CloudObjectStorageCRN を明示的に指定する必要があります。この値は、次の2つの方法で取得できます。

  • Services ビューをクエリする。これにより、IBM Cloud Object Storage インスタンスとそれぞれのCRN がリストされます。
  • IBM Cloud で直接CRN を見つける。これを行うには、IBM Cloud のダッシュボードに移動します。リソースリストで、ストレージからCloud Object Storage リソースを選択してCRN を取得します。

IBM Cloud Object Storage への接続

これで準備は完了です。以下の接続プロパティを設定してください。

  • InitiateOAuthGETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 認証を繰り返す必要がなく、さらに自動でアクセストークンを設定できます。
  • ApiKey:セットアップ中に控えたAPI キーを指定。
  • CloudObjectStorageCRN(オプション):控えておいたCloud Object Storage のCRN に設定。Cloud Object Storage アカウントが複数ある場合のみ設定する必要があります。

プロパティを設定したら、これで接続設定は完了です。

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

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

base = declarative_base()
class Objects(base):
	__tablename__ = "Objects"
	Key = Column(String,primary_key=True)
	Etag = Column(String)
	...

IBM Cloud Object Storage データをクエリ

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

query メソッドを使う

engine = create_engine("ibmcloudobjectstorage///?ApiKey=myApiKey&CloudObjectStorageCRN=MyInstanceCRN&Region=myRegion&OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Objects).filter_by(Bucket="someBucket"):
	print("Key: ", instance.Key)
	print("Etag: ", instance.Etag)
	print("---------")

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

execute メソッドを使う

Objects_table = Objects.metadata.tables["Objects"]
for instance in session.execute(Objects_table.select().where(Objects_table.c.Bucket == "someBucket")):
	print("Key: ", instance.Key)
	print("Etag: ", instance.Etag)
	print("---------")

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。