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

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

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

CircleCI Artifacts Entity のDAO を作成

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

public interface MyArtifactsDAO {
  //request specific data from CircleCI (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Artifacts WHERE ProjectSlug = :projectSlug")
  String findByProjectSlug(@Bind("projectSlug") String projectSlug);

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

CircleCI への接続を開く

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

API キー認証の設定

CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。

以下の接続プロパティを設定して接続を確立してください:

  • AuthScheme:APIKey に設定します。
  • APIKey:CircleCI のパーソナル API トークンに設定します。

接続文字列の例:

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

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

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

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

jdbc:api:Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

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

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';");
MyArtifactsDAO dao = dbi.open(MyArtifactsDAO.class);

//do stuff with the DAO

dao.close();

CircleCI データについて

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

//disply the result of our 'find' method
String  = dao.findByProjectSlug("github/MyOrg/my-repo");
System.out.println();

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

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

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

CircleCI に接続