Apache Airflow で Snowflake データを連携
Apache Airflow は、データエンジニアリングワークフローの作成、スケジューリング、モニタリングをサポートするツールです。 CData JDBC Driver for Snowflake と組み合わせることで、Airflow からリアルタイムの Snowflake のデータ を扱うことができます。 この記事では、Apache Airflow インスタンスから Snowflake のデータ に接続してクエリを実行し、結果を CSV ファイルに保存する方法を説明します。
CData JDBC ドライバーは、最適化されたデータ処理機能を組み込んでおり、 リアルタイムの Snowflake のデータ を扱う際に比類のないパフォーマンスを発揮します。複雑な SQL クエリを Snowflake に発行すると、 ドライバーはフィルタや集計などのサポートされている SQL 操作を直接 Snowflake にプッシュし、 サポートされていない操作(主に SQL 関数や JOIN 操作)は組み込みの SQL エンジンを使用してクライアント側で処理します。 また、組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して Snowflake のデータ の操作・分析が可能です。
Snowflake データ連携について
CData は、Snowflake のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています:
- Snowflake データを迅速かつ効率的に読み書きできます。
- 指定された Warehouse、Database、Schema のメタデータを動的に取得できます。
- OAuth、OKTA、Azure AD、Azure マネージド サービス ID、PingFederate、秘密鍵など、さまざまな方法で認証できます。
多くの CData ユーザーは、CData ソリューションを使用して、お気に入りのツールやアプリケーションから Snowflake にアクセスし、さまざまなシステムからデータを Snowflake にレプリケートして、包括的なウェアハウジングと分析を行っています。
CData ソリューションとの Snowflake 統合についての詳細は、ブログをご覧ください:https://jp.cdata.com/blog/snowflake-integrations
はじめに
Snowflake への接続を設定
組み込みの接続文字列デザイナー
JDBC URL の構築には、Snowflake JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
java -jar cdata.jdbc.snowflake.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
それでは、Snowflake データベースに接続していきましょう。認証に加えて、以下の接続プロパティを設定します。
- Url:お使いのSnowflake URL を指定します。例:https://orgname-myaccount.snowflakecomputing.com
- Legacy URL を使用する場合:https://myaccount.region.snowflakecomputing.com
- ご自身のURL は以下のステップで確認できます。
- Snowflake UI の左下にあるユーザー名をクリックします
- Account ID にカーソルを合わせます
- Copy Account URL アイコンをクリックして、アカウントURL をコピーします
- Database(オプション):CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベースのものに制限したい場合に設定します
- Schema(オプション):CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベーススキーマのものに制限したい場合に設定します
Snowflakeへの認証
CData 製品では、Snowflake ユーザー認証、フェデレーション認証、およびSSL クライアント認証をサポートしています。認証するには、User とPassword を設定し、AuthScheme プロパティで認証方法を選択してください。
キーペア認証
ユーザーアカウントに定義されたプライベートキーを使用してセキュアなトークンを作成し、キーペア認証で接続することも可能です。この方法で接続するには、AuthScheme をPRIVATEKEY に設定し、以下の値を設定してください。
- User:認証に使用するユーザーアカウント
- PrivateKey:プライベートキーを含む.pem ファイルへのパスなど、ユーザーに使用されるプライベートキー
- PrivateKeyType:プライベートキーを含むキーストアの種類(PEMKEY_FILE、PFXFILE など)
- PrivateKeyPassword:指定されたプライベートキーのパスワード
その他の認証方法については、ヘルプドキュメントの「Snowflakeへの認証」セクションをご確認ください。
クラスター環境やクラウドで JDBC ドライバーをホストする場合は、ライセンス(製品版またはトライアル版)とランタイムキー(RTK)が必要です。ライセンス(またはトライアル)の取得については、弊社営業チームにお問い合わせください。
以下は、JDBC 接続に必要な主なプロパティです。
| プロパティ | 値 |
|---|---|
| データベース接続 URL | jdbc:snowflake:RTK=5246...;User=Admin;Password=test123;Server=localhost;Database=Northwind;Warehouse=TestWarehouse;Account=Tester1; |
| データベースドライバークラス名 | cdata.jdbc.snowflake.SnowflakeDriver |
Airflow で JDBC 接続を設定
- Apache Airflow インスタンスにログインします。
- Airflow インスタンスのナビゲーションバーで、Admin にカーソルを合わせ、Connections をクリックします。
- 次の画面で + ボタンをクリックして、新しい接続を作成します。
- Add Connection フォームで、必要な接続プロパティを入力します:
- Connection Id:接続の名前を入力します(例:snowflake_jdbc)
- Connection Type:JDBC Connection
- Connection URL:上記の JDBC 接続 URL(例:jdbc:snowflake:RTK=5246...;User=Admin;Password=test123;Server=localhost;Database=Northwind;Warehouse=TestWarehouse;Account=Tester1;)
- Driver Class:cdata.jdbc.snowflake.SnowflakeDriver
- Driver Path:PATH/TO/cdata.jdbc.snowflake.jar
- フォーム下部の Test ボタンをクリックして、新しい接続をテストします。
- 新しい接続を保存すると、次の画面で接続リストに新しい行が追加されたことを示す緑色のバナーが表示されます。
DAG の作成
Airflow の DAG は、ワークフローのプロセスを保存し、トリガーすることでワークフローを実行できるエンティティです。 ここでのワークフローは、Snowflake のデータ に対して SQL クエリを実行し、結果を CSV ファイルに保存するというシンプルなものです。
- まず、ホームディレクトリに「airflow」フォルダがあるはずです。その中に「dags」という新しいディレクトリを作成します。 ここに Python ファイルを保存すると、UI 上で Airflow DAG として表示されます。
- 次に、新しい Python ファイルを作成し、snowflake_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="snowflake_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv']) # DAG 関数を定義 def extract_and_load(): # タスクを定義 @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 のリストに「snowflake_hook」という新しい DAG が表示されるはずです。
- この DAG をクリックし、次の画面で一時停止スイッチをクリックして青色にオンにします。次に、トリガー(再生)ボタンをクリックして DAG を実行します。これにより、snowflake_hook.py ファイル内の SQL クエリが実行され、コード内で指定したファイルパスに CSV として結果がエクスポートされます。
- 新しい DAG をトリガーした後、Downloads フォルダ(または Python スクリプト内で指定した場所)を確認すると、CSV ファイルが作成されていることがわかります。この例では account.csv です。
- CSV ファイルを開くと、Apache Airflow によって Snowflake のデータ が CSV 形式で利用可能になっていることを確認できます。