Ready to get started?

Learn more about the CData JDBC Driver for Cosmos DB or download a free trial:

Download Now

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

JDBI でCosmos DB data 用のSQL オブジェクトAPIを作成する方法を概説します。

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

Cosmos DB Customers Entity のDAO を作成

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyCustomersDAO { //insert new data into Cosmos DB @SqlUpdate("INSERT INTO Customers (Name, CompanyName) values (:name, :companyName)") void insert(@Bind("name") String name, @Bind("companyName") String companyName); //request specific data from Cosmos DB (String type is used for simplicity) @SqlQuery("SELECT CompanyName FROM Customers WHERE Name = :name") String findCompanyNameByName(@Bind("name") String name); /* * close with no args is used to close the connection */ void close(); }

Cosmos DB への接続を開く

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Cosmos DB.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

  • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
  • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.


For assistance in constructing the JDBC URL, use the connection string designer built into the Cosmos DB JDBC Driver.Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.cosmosdb.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Cosmos DB will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface.The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;"); MyCustomersDAO dao =; //do stuff with the DAO dao.close();

Cosmos DB Data について

With the connection open to Cosmos DB, simply call the previously defined method to retrieve data from the Customers entity in Cosmos DB.

//disply the result of our 'find' method String companyName = dao.findCompanyNameByName("Morris Park Bake Shop"); System.out.println(companyName);

Cosmos DB Data の書き方

It is also simple to write data to Cosmos DB, using the previously defined method.

//add a new entry to the Customers entity dao.insert(newName, newCompanyName);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Cosmos DB by integrating with the CData JDBC Driver for Cosmos DB.Download a free trial and work with live Cosmos DB data in custom Java applications today.