Pipedrive のデータをApache Kafka トピックにストリーミング

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData JDBC Driver とKafka Connect JDBC コネクタを使用して、Apache Kafka でPipedrive のデータにアクセスし、ストリーミングできます。

Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData JDBC Driver for Pipedriveと組み合わせることで、Kafka はライブのPipedrive のデータを扱うことができます。この記事では、Pipedrive データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したPipedrive のデータをユーザーが安全に管理および監視できるようにする方法について説明します。

CData JDBC Driver は最適化されたデータ処理機能を内蔵しており、ライブのPipedrive のデータとのやり取りにおいて比類のないパフォーマンスを提供します。Pipedrive に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Pipedrive にプッシュし、サポートされていない操作（多くの場合SQL 関数やJOIN 操作）については組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してPipedrive のデータを操作および分析できます。

前提条件

Apache Kafka トピックでPipedrive のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。

  1. Confluent Platform for Apache Kafka
  2. Confluent Hub CLI のインストール
  3. Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector

Pipedrive のデータへの新しいJDBC 接続を定義

  1. Linux ベースのシステムにCData JDBC Driver for Pipedriveをダウンロードします。
  2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
    1. Pipedrive という名前の新しいディレクトリを作成します。 
      		mkdir Pipedrive
    2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。 
      		mv PipedriveJDBCDriver.zip Pipedrive/
    3. CData PipedriveJDBCDriver の内容をこの新しいディレクトリに解凍します。 
      		unzip PipedriveJDBCDriver.zip
  3. Pipedrive ディレクトリを開き、lib フォルダに移動します。 
    ls
cd lib/
  4. CData JDBC Driver for Pipedrive のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.pipedrive.jar ファイルがlib フォルダに正常にコピーされたことを確認します。 
    cp -r /path/to/CData JDBC Driver for Pipedrive/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
  5. 以下のコマンドを使用して、CData Pipedrive JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。 
    	java -jar cdata.jdbc.pipedrive.jar -l
  6. プロダクトキーまたは"TRIAL" を入力します（ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください）。
  7. 以下のコマンドを使用してConfluent ローカルサービスを起動します: 
    	confluent local services start

    これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for Pipedrive を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。

    Confluent ローカルサービスを起動
  8. POST HTTP API リクエストを使用してKafka トピックを手動で作成します: 
     curl --location 'server_address:8083/connectors'
	--header 'Content-Type: application/json'
	--data '{
		"name": "jdbc_source_cdata_pipedrive_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;",
		"topic.prefix": "pipedrive-01-",
		"mode": "bulk"
		}
	}'

    HTTP POST 本文（上記）で使用されるフィールドについて説明します:

    • connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
    • connection.url: Pipedrive データに接続するためのJDBC 接続URL です。

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

      JDBC URL の作成については、CData JDBC Driver for Pipedriveに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

      		java -jar cdata.jdbc.pipedrive.jar

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

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

      Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

      Basic 認証

      Basic 認証で認証するには：
      1. API トークンを取得します。
        1. Pipedrive ポータルを開きます。
        2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
        3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
        4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
      2. 次の接続プロパティを設定します。
        • APIToken：取得したAPI トークンの値。
        • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
        • AuthScheme：Basic。
      3. 承認されたユーザー名とパスワードでログインします。

      API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

      OAuth 認証

      ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。

      組み込みの接続文字列デザイナーを使用してJDBC URL を生成（Salesforce の例）

    • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「pipedrive-01-」に設定されています。
    • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

    このリクエストにより、Pipedrive のすべてのテーブル/コンテンツがKafka トピックとして追加されます。

    注意: リクエストをPOST するIP アドレス（サーバー）は、Linux ネットワークのIP アドレスです。

  9. ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します: 
    ksql
list topics;
    Kafka トピックを一覧表示（BigCommerce の例）
  10. トピック内のデータを表示するには、以下のSQL ステートメントを入力します: 
    PRINT topic FROM BEGINNING;

Confluent Control Center への接続

Confluent Control Center のユーザーインターフェースにアクセスするには、上記のセクションで説明した"confluent local services" を実行し、ローカルブラウザでhttp://<server address>:9021/clusters/ と入力してください。

Confluent Control Center に接続

おわりに

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

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

Pipedrive Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Pipedrive Icon Pipedrive JDBC Driver お問い合わせ

Pipedrive データと連携するパワフルなJava アプリケーションを短時間・低コストで作成して配布できます。

この記事の内容

関連記事