各製品の資料を入手。
詳細はこちら →JDBI からCouchDB データ のデータアクセスオブジェクトを作成
JDBI でCouchDB のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日:2022-05-25
この記事で実現できるCouchDB 連携のシナリオ
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for ApacheCouchDB は、Java アプリケーションとリアルタイムCouchDB のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、CouchDB のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するCouchDB のデータ の読み書きのためのコードの作成について説明します。
CouchDB Movies Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyMoviesDAO {
//insert new data into CouchDB
@SqlUpdate("INSERT INTO Movies (MovieRating, MovieRating) values (:movieRating, :movieRating)")
void insert(@Bind("movieRating") String movieRating, @Bind("movieRating") String movieRating);
//request specific data from CouchDB (String type is used for simplicity)
@SqlQuery("SELECT MovieRating FROM Movies WHERE MovieRating = :movieRating")
String findMovieRatingByMovieRating(@Bind("movieRating") String movieRating);
/*
* close with no args is used to close the connection
*/
void close();
}
CouchDB への接続を開く
必要な接続プロパティを収集し、CouchDB に接続するための適切なJDBC URL を作成します。
Apache CouchDB 接続プロパティの取得・設定方法
Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例:http://localhost:5984
ユーザー(またはJWT)が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするために本製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。
Apache CouchDB への認証
3種類の認証をサポートします。- Basic:基本的なユーザー名 / パスワード認証。
- JWT:JWT 認証。
- None:パブリックなデータベースへの匿名アクセス。
Basic 認証
データに接続するには以下を設定します。
- AuthScheme:Basic。
- User:認証に使用されるApache CouchDB ユーザーアカウント。
- Password:認証するユーザーに関連付けられたApache CouchDB パスワード。
その他の認証方法は、ヘルプドキュメント の「接続の確立」セクションを参照してください。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、CouchDB JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.apachecouchdb.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

CouchDB の接続文字列は、通常次のようになります。
jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef;");
MyMoviesDAO dao = dbi.open(MyMoviesDAO.class);
//do stuff with the DAO
dao.close();
CouchDB データ について
CouchDB への接続を開いた状態で以前定義したメソッドを呼び出すだけで、CouchDB のMovies エンティティからデータを取得できます。
//disply the result of our 'find' method
String movieRating = dao.findMovieRatingByMovieRating("R");
System.out.println(movieRating);
CouchDB データ の書き方
以前定義した方法を使用すれば、CouchDB にデータを書き込むことも簡単になります。
//add a new entry to the Movies entity
dao.insert(newMovieRating, newMovieRating);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for ApacheCouchDB と統合することで、SQL Object API for ApacheCouchDB を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムCouchDB を操作しましょう。