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