各製品の資料を入手。
詳細はこちら →Apache Airflow でGoogle Cloud Storage のデータに連携したワークフローを作る
CData JDBC Driver を使ってApache Airflow からGoogle Cloud Storage のデータにアクセスして操作します。
最終更新日:2022-09-07
この記事で実現できるGoogle Cloud Storage 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
Apache Airflow を使うと、データエンジニアリングワークフローの作成、スケジューリング、および監視を行うことができます。CData JDBC Driver for GoogleCloudStorage と組み合わせることで、Airflow からリアルタイムGoogle Cloud Storage のデータに連携できます。 この記事では、Apache Airflow インスタンスからGoogle Cloud Storage のデータに接続してクエリを実行し、結果をCSV ファイルに保存する方法を紹介します。
最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムGoogle Cloud Storage のデータを扱う上で高いパフォーマンスを提供します。 Google Cloud Storage にSQL クエリを発行すると、CData ドライバーはフィルタや集計などのGoogle Cloud Storage 側でサポートしているSQL 操作をGoogle Cloud Storage に直接渡し、サポートされていない操作(主にSQL 関数とJOIN 操作)は組み込みSQL エンジンを利用してクライアント側で処理します。 組み込みの動的メタデータクエリを使用すると、ネイティブのデータ型を使ってGoogle Cloud Storage のデータを操作および分析できます。
Google Cloud Storage への接続を構成する
組み込みの接続文字列デザイナー
JDBC URL の作成の補助として、Google Cloud Storage JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.googlecloudstorage.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
ユーザーアカウントでの認証
ユーザー資格情報の接続プロパティを設定することなく接続できます。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 フローが完了します。

クラスタ環境またはクラウドでJDBC ドライバーをホストするには、ライセンス(フルまたはトライアル)およびランタイムキー(RTK)が必要です。本ライセンス(またはトライアル)の取得については、こちらからお問い合わせください。
以下は、JDBC 接続で要求される必須プロパティです。
プロパティ | 値 |
---|---|
Database Connection URL |
jdbc:googlecloudstorage:RTK=5246...;ProjectId='project1';InitiateOAuth=GETANDREFRESH
|
Database Driver Class Name | cdata.jdbc.googlecloudstorage.GoogleCloudStorageDriver |
Airflow でJDBC 接続を確立する
- Apache Airflow インスタンスにログインします。
- Airflow インスタンスのナビゲーションバーで、「Admin」にカーソルを合わせ、「Connections」をクリックします。
- 次の画面で「+」マークをクリックして新しい接続を作成します。
- Add Connection フォームで、必要な接続プロパティを入力します。
- Connection Id:接続の名前:googlecloudstorage_jdbc
- Connection Type:JDBC Connection
- Connection URL:上記のJDBC 接続URL:
jdbc:googlecloudstorage:RTK=5246...;ProjectId='project1';InitiateOAuth=GETANDREFRESH
- Driver Class:cdata.jdbc.googlecloudstorage.GoogleCloudStorageDriver
- Driver Path:PATH/TO/cdata.jdbc.googlecloudstorage.jar
- フォームの下にある「Test」ボタンをクリックし、新規の接続をテストします。
- 新規接続を保存すると、新しく表示される画面に、接続リストに新しい行が追加されたことを示す緑のバナーが表示されます。
DAG を作成する
Airflow におけるDAG は、ワークフローのプロセスを格納するエンティティであり、DAG にトリガーを設定することでワークフローを実行することができます。 今回のワークフローでは、シンプルにGoogle Cloud Storage のデータに対してSQL クエリを実行し、結果をCSV ファイルに格納します。
- はじめに、Home ディレクトリにある「airflow」フォルダに移動します。その中に新しいディレクトリを作成し、タイトルを「dags」とします。 ここに、UI に表示されるAirflow のDAG を構築するPython ファイルを格納します。
- 次に新しいPython ファイルを作成し、タイトルをgoogle cloud 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="google cloud 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()
- このファイルを保存し、Airflow インスタンスをリフレッシュします。DAG リストの中に、「google cloud storage_hook」というタイトルの新しいDAG が表示されるはずです。
- このDAG をクリックし、新しく表示される画面で一時停止解除スイッチをクリックして青色にし、トリガー(=play)ボタンをクリックしてDAG を実行します。この操作で、google cloud storage_hook.py ファイルのSQL クエリを実行し、結果をCSV としてコード内で指定したファイルパスにエクスポートします。
- 新規のDAG を実行後、Downloads フォルダ(またはPython スクリプト内で選択したフォルダ)を確認し、CSV ファイルが作成されていることを確認します(本ワークフローの場合はaccount.csv です)。
- CSV ファイルを開くと、Apache Airflow によってGoogle Cloud Storage のデータがCSV 形式で利用できるようになったことが確認できます。