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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのCouchDB のデータを抽出・変換・ロードするETLパイプラインの構築方法を解説。読み取りから書き込みまで対応します。

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

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

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

Python + petl でできること

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

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

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

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

CouchDB への書き戻し処理の自動化

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

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

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

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

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

    それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

    ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

    Apache CouchDB への認証

    続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

    • Basic：基本的なユーザー名 / パスワード認証
    • JWT：JWT 認証
    • None：パブリックなデータベースへの匿名アクセス

    Basic 認証

    データに接続するには、以下のプロパティを設定してください。

    • AuthScheme：Basic
    • User：認証に使用されるApache CouchDB ユーザーアカウント
    • Password：認証するユーザーに関連付けられたApache CouchDB パスワード

    その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

    接続の設定（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 で CouchDB のデータの ETL アプリを構築する方法は？

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

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

import petl as etl
import cdata_connect_ai

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

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

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

sql = (
    "SELECT MovieRuntime, MovieRating "
    "FROM [ApacheCouchDB1].[ApacheCouchDB].[Movies] "
    "WHERE MovieRating = 'R'"
)

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

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

table1 = etl.fromdb(conn, sql)

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

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

新しい行を CouchDB に書き戻す方法は？

CouchDB が書き込みに対応している場合は、バッチ INSERT で行を書き戻せます。SDK の executemany は、@name のプレースホルダーと、1行につき1つのパラメータ辞書のリストを受け取ります。

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [ApacheCouchDB1].[ApacheCouchDB].[Movies] (MovieRuntime, MovieRating) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。

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

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

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのCouchDB のデータをパイプライン処理できるようになりました。CouchDB（および数百種類のその他のデータソース）への接続について詳しくは、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 MovieRuntime, MovieRating "
    "FROM [ApacheCouchDB1].[ApacheCouchDB].[Movies] "
    "WHERE MovieRating = 'R'"
)

table1 = etl.fromdb(conn, sql)

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

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

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [ApacheCouchDB1].[ApacheCouchDB].[Movies] (MovieRuntime, MovieRating) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()

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

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

無料トライアル

この記事の内容

関連記事