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

JDBI でKintone のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。

加藤龍彦
デジタルマーケティング

最終更新日:2022-05-25

この記事で実現できるKintone 連携のシナリオ

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

Kintone Apps Entity のDAO を作成

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

public interface MyAppsDAO { //insert new data into Kintone @SqlUpdate("INSERT INTO Apps (AppId, Description) values (:appId, :description)") void insert(@Bind("appId") String appId, @Bind("description") String description); //request specific data from Kintone (String type is used for simplicity) @SqlQuery("SELECT Description FROM Apps WHERE AppId = :appId") String findDescriptionByAppId(@Bind("appId") String appId); /* * close with no args is used to close the connection */ void close(); }

Kintone への接続を開く

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

Kintone 接続プロパティの設定方法

Kintone に接続するには、以下の接続プロパティを設定する必要があります。

  • URL:Kintone のアクセスURL(例:https://yoursitename.cybozu.com または https://yoursitename.kintone.com)
  • User:アカウントのユーザー名
  • Password:アカウントのパスワード
  • AuthScheme:Password を指定

パスワード認証の代わりにAPI トークン認証を利用する場合は、ヘルプドキュメントの「接続の設定」セクションをご参照ください。

Basic 認証の設定

ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

  • BasicAuthUser:Basic認証のユーザー名
  • BasicAuthPassword:Basic認証のパスワード

クライアント証明書認証の設定

Basic認証の代わりにクライアント証明書による認証を利用する場合は、以下の項目を設定してください。

  • SSLClientCert:クライアント証明書のパス
  • SSLClientCertType:証明書の種類
  • SSLClientCertSubject:証明書のサブジェクト
  • SSLClientCertPassword:証明書のパスワード

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

JDBC URL の構成については、Kintone JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.kintone.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;

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

DBI dbi = new DBI("jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;"); MyAppsDAO dao = dbi.open(MyAppsDAO.class); //do stuff with the DAO dao.close();

Kintone データ について

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

//disply the result of our 'find' method String description = dao.findDescriptionByAppId("1354841"); System.out.println(description);

Kintone データ の書き方

以前定義した方法を使用すれば、Kintone にデータを書き込むことも簡単になります。

//add a new entry to the Apps entity dao.insert(newAppId, newDescription);

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

CData で実現できるkintone 連携のユースケース

Power BIロゴ Tableauロゴ

Power BI、Tableau などBI ツール & Excel 連携

Power BI & Tableau との連携はこちら
SQL Serverロゴ

SQL Server 上のマスタデータとの双方向連携

SQL Server 連携はこちら
連携先基幹システムロゴ

基幹システム・SaaS 間連携による業務自動化

基幹システム・SaaS 間連携はこちら

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。