今すぐお試しください!

製品の詳細CData Python Connector for IBM Cloud Object Storage を確認して、無償評価版をダウンロード:

今すぐダウンロード

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

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

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

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

IBM Cloud Object Storage Data への接続

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

Register a New Instance of Cloud Object Storage

If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

  1. Log in to your IBM Cloud account.
  2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

Connecting using OAuth Authentication

There are certain connection properties you need to set before you can connect. You can obtain these as follows:

API Key

To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

  1. Log in to your IBM Cloud account.
  2. Navigate to the Platform API Keys page.
  3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
  4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

Cloud Object Storage CRN

If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

  • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
  • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

Connecting to Data

You can now set the following to connect to data:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • ApiKey: Set this to your API key which was noted during setup.
  • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

When you connect, the connector completes the OAuth process.

  1. Extracts the access token and authenticates requests.
  2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でIBM Cloud Object Storage Data をモデル化します

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

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

IBM Cloud Object Storage Data のマッピングクラスの宣言

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Connector の30日の無償トライアル をぜひダウンロードして、IBM Cloud Object Storage data への接続をPython アプリやスクリプトから簡単に作成しましょう。

 
 
ダウンロード