PyCharm でのCData ODBC Driver for IBM Cloud Object Storage の使用





IBM Cloud Object Storage ODBC Driver

IBM Cloud Object Storage ODBC Driver を使って、ODBC 接続をサポートするあらゆるアプリケーション・ツールからIBM Cloud Object Storage にデータ連携。

IBM Cloud Object Storage データにデータベースと同感覚でアクセスして、IBM Cloud Object Storage データに使い慣れたODBC インターフェースで双方向連携。

CData ODBC Driver for IBM Cloud Object Storage を使用して、ODBC データソースとしてPyCharm からIBM Cloud Object Storage に接続します。

CData ODBC Drivers は、ODBC ドライバーをサポートするあらゆる環境から利用可能です。本記事では、PyCharm からのCData ODBC Driver for IBM Cloud Object Storage の利用を説明します。CData ODBC Deriver をデータソースとして設定する方法、データソースをクエリして結果を表示するためのPyCharm の簡単なコードを含みます。

はじめに、このチュートリアルではCData ODBC Driver for IBM Cloud Object Storage とPyCharm が、既にインストールされていることを前提としています。

Pyodbc をプロジェクトに追加

以下のステップに従って、pyodbc モジュールをプロジェクトに追加します。

  1. File]->[Settings]とクリックして[project settings]ウィンドウを開きます。
  2. Project: YourProjectName]メニューから[Project Interpreter]をクリックします。
  3. pyodbc を追加するため、+ ボタンをクリックしてpyodbc と入力します。
  4. Install Package]をクリックしてpyodbc をインストールします。

IBM Cloud Object Storage への接続

これで、ODBC 接続文字列またはDSN で接続できます。お客様のOS でDSN を作成するためのガイドについては、CData ドライバードキュメントの[はじめに]セクションを参照してください。

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:


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.

以下はDSN の構文です。

[CData IBMCloudObjectStorage Source] Driver = CData ODBC Driver for IBM Cloud Object Storage Description = My Description ApiKey = myApiKey CloudObjectStorageCRN = MyInstanceCRN Region = myRegion OAuthClientId = MyOAuthClientId OAuthClientSecret = myOAuthClientSecret

IBM Cloud Object Storage へのクエリの実行

Cursor をインスタンス化し、Cursor クラスのexecute メソッドを使用してSQL ステートメントを実行します。

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for IBMCloudObjectStorage};ApiKey = myApiKey;CloudObjectStorageCRN = MyInstanceCRN;Region = myRegion;OAuthClientId = MyOAuthClientId;OAuthClientSecret = myOAuthClientSecret;') cursor = cnxn.cursor() cursor.execute("SELECT Key, Etag FROM Objects WHERE Bucket = 'someBucket'") rows = cursor.fetchall() for row in rows: print(row.Key, row.Etag)

CData ODBC Driver を使用してPyCharm でIBM Cloud Object Storage に接続すると、IBM Cloud Object Storage にアクセスできるPython アプリケーションを標準データベースのように構築できるようになります。このチュートリアルに関する質問、コメント、フィードバックがある場合には、 までご連絡ください。