JDBI からCleverPush データのデータアクセスオブジェクトを作成

加藤龍彦
加藤龍彦
デジタルマーケティング
JDBI でCleverPush のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムCleverPush のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、CleverPush のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するCleverPush のデータ の読み書きのためのコードの作成について説明します。

CleverPush Segments Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。


public interface MySegmentsDAO {
  //request specific data from CleverPush (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Segments WHERE ChannelId = :channelId")
  String findNameByChannelId(@Bind("channelId") String channelId);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

CleverPush への接続を開く

必要な接続プロパティを収集し、CleverPush に接続するための適切なJDBC URL を作成します。

まず、Profile 接続プロパティをディスク上の Cleverpush プロファイルの場所に設定します(例:C:\profiles\Cleverpush.apip)。次に、ProfileSettings 接続プロパティを Cleverpush の接続文字列に設定します(以下を参照)。

Cleverpush API プロファイル設定

CleverPush では、プライベート API キーでリクエストを認証します。API キーは、すべての API 呼び出しで Authorization リクエストヘッダーの値として渡されます。

プライベート API キーは、CleverPush ダッシュボードの「Settings」>「API」で確認できます。サーバーサイドからアクセスする場合は、パブリックキーではなくプライベートキーを使用してください。

以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme:APIKey に設定します。
  • APIKey:CleverPush のプライベート API キーに設定します。

オプションの接続プロパティ

  • ChannelId:デフォルトで使用する CleverPush のチャネル識別子に設定します。ほとんどのテーブルではチャネルによるフィルタが必要です。このプロパティを設定しておくと、WHERE 句で毎回 ChannelId を指定しなくてもクエリを実行できます。

ビルトイン接続文字列デザイナー

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


java -jar cdata.jdbc.api.jar

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

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

CleverPush の接続文字列は、通常次のようになります。

jdbc:api:Profile=C:\profiles\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。


DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';");
MySegmentsDAO dao = dbi.open(MySegmentsDAO.class);

//do stuff with the DAO

dao.close();

CleverPush データについて

CleverPush への接続を開いた状態で以前定義したメソッドを呼び出すだけで、CleverPush のSegments エンティティからデータを取得できます。


//disply the result of our 'find' method
String name = dao.findNameByChannelId("your_channel_id");
System.out.println(name);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムCleverPush を操作しましょう。

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

API Driver で CleverPush のライブデータに接続

CleverPush に接続