各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からSmartsheet データ のデータアクセスオブジェクトを作成
JDBI でSmartsheet のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるSmartsheet 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Smartsheet は、Java アプリケーションとリアルタイムSmartsheet のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Smartsheet のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するSmartsheet のデータ の読み書きのためのコードの作成について説明します。
Smartsheet Sheet_Event_Plan_Budget Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MySheet_Event_Plan_BudgetDAO {
//insert new data into Smartsheet
@SqlUpdate("INSERT INTO Sheet_Event_Plan_Budget (Assigned, Progress) values (:assigned, :progress)")
void insert(@Bind("assigned") String assigned, @Bind("progress") String progress);
//request specific data from Smartsheet (String type is used for simplicity)
@SqlQuery("SELECT Progress FROM Sheet_Event_Plan_Budget WHERE Assigned = :assigned")
String findProgressByAssigned(@Bind("assigned") String assigned);
/*
* close with no args is used to close the connection
*/
void close();
}
Smartsheet への接続を開く
必要な接続プロパティを収集し、Smartsheet に接続するための適切なJDBC URL を作成します。
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。
- Smartsheet にログインします。
- 「アカウント」をクリックして「個人用の設定」を選択します。
- 「API アクセス」をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。
その後、OAuthAccessToken を生成したトークンに設定します。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Smartsheet JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.smartsheet.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Smartsheet の接続文字列は、通常次のようになります。
jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH");
MySheet_Event_Plan_BudgetDAO dao = dbi.open(MySheet_Event_Plan_BudgetDAO.class);
//do stuff with the DAO
dao.close();
Smartsheet データ について
Smartsheet への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Smartsheet のSheet_Event_Plan_Budget エンティティからデータを取得できます。
//disply the result of our 'find' method
String progress = dao.findProgressByAssigned("Ana Trujilo");
System.out.println(progress);
Smartsheet データ の書き方
以前定義した方法を使用すれば、Smartsheet にデータを書き込むことも簡単になります。
//add a new entry to the Sheet_Event_Plan_Budget entity
dao.insert(newAssigned, newProgress);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Smartsheet と統合することで、SQL Object API for Smartsheet を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムSmartsheet を操作しましょう。
関連コンテンツ
