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

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

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

Copper Account Entity のDAO を作成

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


public interface MyAccountDAO {
  //request specific data from Copper (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Account WHERE SettingEnableLeads = :settingEnableLeads")
  String findNameBySettingEnableLeads(@Bind("settingEnableLeads") String settingEnableLeads);

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

Copper への接続を開く

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

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

Copper API プロファイル設定

Copper CRM で Settings > Integrations > API Keys に移動し、Generate API Key をクリックします。API キーと、アカウントに紐づくメールアドレスの両方を指定します。

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

JDBC URL の構成については、Copper 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.)

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

jdbc:api:Profile=C:\profiles\Copper.apip;ProfileSettings='APIKey=your_api_key;UserEmail=your_email';

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


DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Copper.apip;ProfileSettings='APIKey=your_api_key;UserEmail=your_email';");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Copper データについて

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


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

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

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

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

Copper に接続