製品をチェック

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

 ダウンロードはこちら

製品の詳細

IBM Cloud Object Storage アイコン IBM Cloud Object Storage JDBC Driver 相談したい

IBM Cloud Object Storage データに連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。

Apache Airflow でIBM Cloud Object Storage データに連携したワークフローを作る

CData JDBC Driver を使ってApache Airflow からIBM Cloud Object Storage データにアクセスして操作します。

古川えりか
コンテンツスペシャリスト

最終更新日:2022-09-07
ibmcloudobjectstorage ロゴ

CData

jdbc ロゴ画像
Apache Airflow ロゴ

こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。

Apache Airflow を使うと、データエンジニアリングワークフローの作成、スケジューリング、および監視を行うことができます。CData JDBC Driver for IBMCloudObjectStorage と組み合わせることで、Airflow からリアルタイムIBM Cloud Object Storage データに連携できます。 この記事では、Apache Airflow インスタンスからIBM Cloud Object Storage データに接続してクエリを実行し、結果をCSV ファイルに保存する方法を紹介します。

最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムIBM Cloud Object Storage データを扱う上で高いパフォーマンスを提供します。 IBM Cloud Object Storage にSQL クエリを発行すると、CData ドライバーはフィルタや集計などのIBM Cloud Object Storage 側でサポートしているSQL 操作をIBM Cloud Object Storage に直接渡し、サポートされていない操作(主にSQL 関数とJOIN 操作)は組み込みSQL エンジンを利用してクライアント側で処理します。 組み込みの動的メタデータクエリを使用すると、ネイティブのデータ型を使ってIBM Cloud Object Storage データを操作および分析できます。

IBM Cloud Object Storage への接続を構成する

組み込みの接続文字列デザイナー

JDBC URL の作成の補助として、IBM Cloud Object Storage JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

java -jar cdata.jdbc.ibmcloudobjectstorage.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

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 アカウントが複数ある場合のみ設定する必要があります。

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

組み込みの接続文字列デザイナーを使ってJDBC URL を生成(ibm cloud object storage の場合)

クラスタ環境またはクラウドでJDBC ドライバーをホストするには、ライセンス(フルまたはトライアル)およびランタイムキー(RTK)が必要です。本ライセンス(またはトライアル)の取得については、こちらからお問い合わせください。

以下は、JDBC 接続で要求される必須プロパティです。

プロパティ
Database Connection URL jdbc:ibmcloudobjectstorage:RTK=5246...;ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
Database Driver Class Namecdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver

Airflow でJDBC 接続を確立する

  1. Apache Airflow インスタンスにログインします。
  2. Airflow インスタンスのナビゲーションバーで、「Admin」にカーソルを合わせ、「Connections」をクリックします。 connections をクリック
  3. 次の画面で「+」マークをクリックして新しい接続を作成します。
  4. Add Connection フォームで、必要な接続プロパティを入力します。
    • Connection Id:接続の名前:ibmcloudobjectstorage_jdbc
    • Connection Type:JDBC Connection
    • Connection URL:上記のJDBC 接続URL:jdbc:ibmcloudobjectstorage:RTK=5246...;ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
    • Driver Class:cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver
    • Driver Path:PATH/TO/cdata.jdbc.ibmcloudobjectstorage.jar
    JDBC 接続フォームを追加
  5. フォームの下にある「Test」ボタンをクリックし、新規の接続をテストします。
  6. 新規接続を保存すると、新しく表示される画面に、接続リストに新しい行が追加されたことを示す緑のバナーが表示されます。 新規接続が追加

DAG を作成する

Airflow におけるDAG は、ワークフローのプロセスを格納するエンティティであり、DAG にトリガーを設定することでワークフローを実行することができます。 今回のワークフローでは、シンプルにIBM Cloud Object Storage データに対してSQL クエリを実行し、結果をCSV ファイルに格納します。

  1. はじめに、Home ディレクトリにある「airflow」フォルダに移動します。その中に新しいディレクトリを作成し、タイトルを「dags」とします。 ここに、UI に表示されるAirflow のDAG を構築するPython ファイルを格納します。
  2. 次に新しいPython ファイルを作成し、タイトルをibm cloud object storage_hook.py にします。この新規ファイル内に、次のコードを挿入します。
    		import time
    		from datetime import datetime
    		from airflow.decorators import dag, task
    		from airflow.providers.jdbc.hooks.jdbc import JdbcHook
    		import pandas as pd
    
    		# Dag の宣言
    		@dag(dag_id="ibm cloud object storage_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv'])
    	
    		# Dag となる関数を定義(取得するテーブルは必要に応じて変更してください)
    		def extract_and_load():
    		# Define tasks
    			@task()
    			def jdbc_extract():
    				try:
    					hook = JdbcHook(jdbc_conn_id="jdbc")
    					sql = """ select * from Account """
    					df = hook.get_pandas_df(sql)
    					df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1)
    					# print(df.head())
    					print(df)
    					tbl_dict = df.to_dict('dict')
    					return tbl_dict
    				except Exception as e:
    					print("Data extract error: " + str(e))
                
    			jdbc_extract()
        
    		sf_extract_and_load = extract_and_load()
    	
  3. このファイルを保存し、Airflow インスタンスをリフレッシュします。DAG リストの中に、「ibm cloud object storage_hook」というタイトルの新しいDAG が表示されるはずです。 新しいDAG が追加
  4. このDAG をクリックし、新しく表示される画面で一時停止解除スイッチをクリックして青色にし、トリガー(=play)ボタンをクリックしてDAG を実行します。この操作で、ibm cloud object storage_hook.py ファイルのSQL クエリを実行し、結果をCSV としてコード内で指定したファイルパスにエクスポートします。 DAG を実行
  5. 新規のDAG を実行後、Downloads フォルダ(またはPython スクリプト内で選択したフォルダ)を確認し、CSV ファイルが作成されていることを確認します(本ワークフローの場合はaccount.csv です)。 CSV が作成される
  6. CSV ファイルを開くと、Apache Airflow によってIBM Cloud Object Storage データがCSV 形式で利用できるようになったことが確認できます。 IBM Cloud Object Storage データのCSV ファイル

詳細と無償トライアル

CData JDBC Driver for IBMCloudObjectStorage の 30日間無償トライアル をダウンロードして、Apache Airflow でリアルタイムIBM Cloud Object Storage データの操作をはじめましょう!ご不明な点があれば、サポートチームにお問い合わせください。

関連コンテンツ

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

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