製品をチェック

HCL Domino Driver の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

HCL Domino アイコン HCL Domino JDBC Driver 相談したい

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

Apache Airflow でHCL Domino データに連携したワークフローを作る

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

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

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

CData

jdbc ロゴ画像
Apache Airflow ロゴ

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

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

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

HCL Domino への接続を構成する

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

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

java -jar cdata.jdbc.domino.jar

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

Domino 接続プロパティの取得・設定方法

接続の前に

CData 製品を経由してDomino に接続するには、「Proton コンポーネント」のインストールが必要です。通常、 Proton はAppDev パックの一部として配布されています。Proton またはAppDev パックの入手およびインストール方法については、HCL のドキュメントを参照してください。

CData 製品は匿名アクセス、またはクライアント証明書の提供によりProton を認証できます。 これらのオプションは両方ともDomino で特定の設定が必要です。

次の2セクションでは、接続に必要な事前設定について説明します。使用したい認証方法に対応するセクションを参照してください。

クライアント証明書による認証の設定

クライアント証明書による認証では、CData 製品は専用のユーザーアカウントとして接続します。このユーザーには、接続するすべてのデータベースに対するdesigner またはそれ以上のアクセス権が付与する必要があります。

また、CData 製品を使用するためにはユーザーがインターネット証明書を取得する必要があります。サーバーコンソールで以下のコマンドを実行することで、Proton にこの証明書を作成させることができます。 APPUSER はCData 製品でアクセス設定するユーザーアカウント名、ADMINISTRATOR は証明書を受け取るユーザー名です。

load proton --setupclient "APPUSER" --sendto "ADMINISTRATOR"

新しい証明書は、Notes のADMINISTRATOR メールボックスから利用できます。証明書は、クライアント証明書(clientcert)およびキー(clientkey)の2ファイルに分けて送信される場合があります。 キーファイルのテキストを証明書ファイルの末尾にコピーアンドペーストして、2つのファイルを結合する必要があります。

匿名認証の設定

匿名アクセスでは、CData 製品はAnonymous という一般的なユーザーアカウントで接続します。 接続するすべてのデータベースには、次の2つの権限が設定される必要があります。

  • Anonymous ユーザーには、designer またはそれ以上のデータベースへのアクセス権が付与される必要があります。
  • データベースは、Maximum Internet name and password オプションがdesigner またはそれ以上のアクセスに設定される必要があります。 この設定は、データベースのAccess Control List オプションのAdvanced タブにあります。

Domino への接続

接続するには以下を設定します。

  • Server:Proton サービスを使ってDomino を実行中のサーバーのIP アドレス。
  • Port:Proton サービスがリッスンしているポート番号。
  • Database:.nsf 拡張子を含むデータベースファイル名。
  • SSLServerCert:サーバーが受け入れ可能なTLS/SSL 証明書に設定。コンピュータによって信頼されていない他の証明書はすべて拒否されます。または、"*" を設定するとすべての証明書を受け入れます。

Domino への認証

CData 製品は、クライアント証明書を使用してProton に認証することも、匿名アクセスで認証することも可能です。

クライアント証明書による認証

クライアント証明書で認証するには以下を設定します。

  • AuthSchemeSSLCertificate に設定。
  • SSLClientCertType:これは、証明書ファイルの形式と一致する必要があります。 通常、.pem 証明書の場合はPEMKEY_FILE、.pfx 証明書の場合はPFXFILE のいずれかになります。
  • SSLClientCert:証明書ファイルへのパス。

匿名認証

匿名認証を使用するには、AuthSchemeAnonymous に設定します。

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

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

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

プロパティ
Database Connection URL jdbc:domino:RTK=5246...;Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
Database Driver Class Namecdata.jdbc.domino.DominoDriver

Airflow でJDBC 接続を確立する

  1. Apache Airflow インスタンスにログインします。
  2. Airflow インスタンスのナビゲーションバーで、「Admin」にカーソルを合わせ、「Connections」をクリックします。 connections をクリック
  3. 次の画面で「+」マークをクリックして新しい接続を作成します。
  4. Add Connection フォームで、必要な接続プロパティを入力します。
    • Connection Id:接続の名前:domino_jdbc
    • Connection Type:JDBC Connection
    • Connection URL:上記のJDBC 接続URL:jdbc:domino:RTK=5246...;Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
    • Driver Class:cdata.jdbc.domino.DominoDriver
    • Driver Path:PATH/TO/cdata.jdbc.domino.jar
    JDBC 接続フォームを追加
  5. フォームの下にある「Test」ボタンをクリックし、新規の接続をテストします。
  6. 新規接続を保存すると、新しく表示される画面に、接続リストに新しい行が追加されたことを示す緑のバナーが表示されます。 新規接続が追加

DAG を作成する

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

  1. はじめに、Home ディレクトリにある「airflow」フォルダに移動します。その中に新しいディレクトリを作成し、タイトルを「dags」とします。 ここに、UI に表示されるAirflow のDAG を構築するPython ファイルを格納します。
  2. 次に新しいPython ファイルを作成し、タイトルをhcl domino_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="hcl domino_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 リストの中に、「hcl domino_hook」というタイトルの新しいDAG が表示されるはずです。 新しいDAG が追加
  4. このDAG をクリックし、新しく表示される画面で一時停止解除スイッチをクリックして青色にし、トリガー(=play)ボタンをクリックしてDAG を実行します。この操作で、hcl domino_hook.py ファイルのSQL クエリを実行し、結果をCSV としてコード内で指定したファイルパスにエクスポートします。 DAG を実行
  5. 新規のDAG を実行後、Downloads フォルダ(またはPython スクリプト内で選択したフォルダ)を確認し、CSV ファイルが作成されていることを確認します(本ワークフローの場合はaccount.csv です)。 CSV が作成される
  6. CSV ファイルを開くと、Apache Airflow によってHCL Domino データがCSV 形式で利用できるようになったことが確認できます。 HCL Domino データのCSV ファイル

詳細と無償トライアル

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

関連コンテンツ

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

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