HCL Domino のデータをPythonのpetlでETL処理する方法｜CData Connect AI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのHCL Domino のデータを抽出・変換するETLパイプラインの構築方法を解説。

CData Connect AI の Python SDK と petl フレームワークを使うと、HCL Domino のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、HCL Domino のデータを抽出・変換して CSV などに出力する HCL Domino 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってHCL Domino のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

HCL Domino データの定期抽出パイプライン構築

SQL クエリで取得した HCL Domino のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで HCL Domino 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

HCL Domino への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを HCL Domino に自動で書き戻す処理を組み込めます。

Connect AI で HCL Domino に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「HCL Domino」を選択します
    3. データソースの選択
  3. HCL Domino に接続するために必要な認証プロパティを入力します。

    Domino への接続

    それでは、Domino のデータに接続していきましょう。接続するには、以下のプロパティを設定してください。

    • URL：Domino データベースをホスティングしているサーバーのホスト名またはIP アドレス。Domino データベースをホスティングしているサーバーのポートを含めます。例：http://sampleserver:1234/
    • DatabaseScope：Domino Web UI でのスコープ名。CData 製品は、指定されたスコープに適合するスキーマのフォームとビューを公開します。Domino Admin UI で、サイドバーのScopes メニューを選択してください。このプロパティを既存のスコープ名に設定します

    Domino での認証

    続いて、認証方法を設定しましょう。Domino では、ログインクレデンシャル（OAuthPassword）またはMicrosoft Entra ID（AzureAD）のいずれかによる認証をサポートしています。

    ログインクレデンシャル

    ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

    • AuthScheme：OAuthPassword
    • User：認証するDomino ユーザーのユーザー名
    • Password：認証するDomino ユーザーに関連付けられたパスワード

    ドライバーがログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

    Microsoft Entra ID（Azure AD）

    この認証方法は、Azure Active Directory をIdP として使用してJWT トークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。詳しい手順については、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

    • AuthScheme：AzureAD
    • InitiateOAuth：これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます
    • OAuthClientId：カスタムAzure AD アプリケーションの作成時に取得したクライアントID
    • OAuthClientSecret：カスタムAzure AD アプリケーションの作成時に取得したクライアントシークレット
    • CallbackURL：カスタムAzure AD アプリケーションの登録時に指定されたリダイレクトURI。例えば、https://localhost:33333
    • AzureTenant：データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください

    テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で HCL Domino のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

HCL Domino をクエリする SQL ステートメントを作成する方法は？

SQL を使って、HCL Domino をクエリするステートメントを作成します。この記事では、ByName エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Domino1）になります。

sql = (
    "SELECT Name, Address "
    "FROM [Domino1].[Domino].[ByName] "
    "WHERE City = 'Miami'"
)

HCL Domino のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってHCL Domino のデータを抽出・変換・ロードします。この例では、HCL Domino のデータを抽出し、Address カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Address')

etl.tocsv(table2, 'byname_data.csv')

HCL Domino は Connect AI では読み取り専用のソースのため、このパイプラインではHCL Domino のデータの抽出と変換はできますが、行の書き戻しはできません。抽出が完了したら接続を閉じましょう。

conn.close()

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにHCL Domino のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのHCL Domino のデータをパイプライン処理できるようになりました。HCL Domino（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Name, Address "
    "FROM [Domino1].[Domino].[ByName] "
    "WHERE City = 'Miami'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Address')

etl.tocsv(table2, 'byname_data.csv')
conn.close()

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事