各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からHighrise データ のデータアクセスオブジェクトを作成
JDBI でHighrise のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるHighrise 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Highrise は、Java アプリケーションとリアルタイムHighrise のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Highrise のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するHighrise のデータ の読み書きのためのコードの作成について説明します。
Highrise Deals Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyDealsDAO {
//insert new data into Highrise
@SqlUpdate("INSERT INTO Deals (GroupId, Price) values (:groupId, :price)")
void insert(@Bind("groupId") String groupId, @Bind("price") String price);
//request specific data from Highrise (String type is used for simplicity)
@SqlQuery("SELECT Price FROM Deals WHERE GroupId = :groupId")
String findPriceByGroupId(@Bind("groupId") String groupId);
/*
* close with no args is used to close the connection
*/
void close();
}
Highrise への接続を開く
必要な接続プロパティを収集し、Highrise に接続するための適切なJDBC URL を作成します。
Highrise はOAuth 認証標準を利用しています。Highrise に認証するには、Highrise にアプリケーションを登録し、OAuthClientId、OAuthClientSecret、およびCallbackURL を取得する必要があります。データへの接続には、AccountId の設定も必要です。
OAuth の使用については、ヘルプドキュメントの「はじめに」を参照してください。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Highrise JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.highrise.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Highrise の接続文字列は、通常次のようになります。
jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH");
MyDealsDAO dao = dbi.open(MyDealsDAO.class);
//do stuff with the DAO
dao.close();
Highrise データ について
Highrise への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Highrise のDeals エンティティからデータを取得できます。
//disply the result of our 'find' method
String price = dao.findPriceByGroupId("MyGroupId");
System.out.println(price);
Highrise データ の書き方
以前定義した方法を使用すれば、Highrise にデータを書き込むことも簡単になります。
//add a new entry to the Deals entity
dao.insert(newGroupId, newPrice);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Highrise と統合することで、SQL Object API for Highrise を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムHighrise を操作しましょう。
関連コンテンツ
