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

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

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

Buildkite Builds Entity のDAO を作成

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


public interface MyBuildsDAO {
  //request specific data from Buildkite (String type is used for simplicity)
  @SqlQuery("SELECT BuildNumber FROM Builds WHERE State = :state")
  String findBuildNumberByState(@Bind("state") String state);

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

Buildkite への接続を開く

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

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

Buildkite API プロファイル設定

Buildkite では HTTP API キー認証を使用します。Buildkite の API アクセストークンを Bearer トークンとして使い、リクエストを認証します。トークンは https://buildkite.com/user/api-access-tokens で生成・確認できます。

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

  • AuthScheme:APIKey に設定します。
  • APIKey:Buildkite の API アクセストークンに設定します。
  • Organization:Buildkite の組織スラッグに設定します(例:acme-inc)。

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

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

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

jdbc:api:Profile=C:\profiles\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';

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


DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';");
MyBuildsDAO dao = dbi.open(MyBuildsDAO.class);

//do stuff with the DAO

dao.close();

Buildkite データについて

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


//disply the result of our 'find' method
String buildNumber = dao.findBuildNumberByState("passed");
System.out.println(buildNumber);

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

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

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

Buildkite に接続