JDBI からCanny データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムCanny のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Canny のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するCanny のデータ の読み書きのためのコードの作成について説明します。
Canny Boards Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyBoardsDAO {
//request specific data from Canny (String type is used for simplicity)
@SqlQuery("SELECT Name FROM Boards WHERE IsPrivate = :isPrivate")
String findNameByIsPrivate(@Bind("isPrivate") String isPrivate);
/*
* close with no args is used to close the connection
*/
void close();
}
Canny への接続を開く
必要な接続プロパティを収集し、Canny に接続するための適切なJDBC URL を作成します。
まず、Profile 接続プロパティをディスク上の Canny プロファイルの場所に設定します(例:C:\profiles\Canny.apip)。次に、ProfileSettings 接続プロパティを Canny の接続文字列に設定します(以下を参照)。
Canny API プロファイル設定
Canny では、シークレット API キーで API へのアクセスを制御します。API キーは、Canny API エンドポイントへのすべての HTTP POST リクエストで、'apiKey' という名前の JSON ボディパラメータとして送信されます。
Canny API で認証するには、会社単位のシークレット API キーが必要です。このキーは、Canny アカウントの「Settings」>「API」で確認できます。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:APIKey に設定します。
- APIKey:Canny ダッシュボードの「Settings」>「API」ページで確認できる、会社単位のシークレット API キーに設定します。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Canny JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Canny の接続文字列は、通常次のようになります。
jdbc:api:Profile=C:\profiles\Canny.apip;ProfileSettings='APIKey=your-canny-api-key';
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Canny.apip;ProfileSettings='APIKey=your-canny-api-key';");
MyBoardsDAO dao = dbi.open(MyBoardsDAO.class);
//do stuff with the DAO
dao.close();
Canny データについて
Canny への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Canny のBoards エンティティからデータを取得できます。
//disply the result of our 'find' method
String name = dao.findNameByIsPrivate("false");
System.out.println(name);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムCanny を操作しましょう。