Learn more
 

Ready to get started?

Download a free trial of the AlloyDB Driver to get started:

 Download Now

Learn more:

AlloyDB Icon AlloyDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with AlloyDB.

In this article

Related articles

Create a Data Access Object for AlloyDB Data using JDBI


A brief overview of creating a SQL Object API for AlloyDB data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for AlloyDB integrates connectivity to live AlloyDB data in Java applications. By pairing these technologies, you gain simple, programmatic access to AlloyDB data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write AlloyDB data.

Create a DAO for the AlloyDB Orders Entity

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 MyOrdersDAO { //insert new data into AlloyDB @SqlUpdate("INSERT INTO Orders (ShipCountry, ShipCity) values (:shipCountry, :shipCity)") void insert(@Bind("shipCountry") String shipCountry, @Bind("shipCity") String shipCity); //request specific data from AlloyDB (String type is used for simplicity) @SqlQuery("SELECT ShipCity FROM Orders WHERE ShipCountry = :shipCountry") String findShipCityByShipCountry(@Bind("shipCountry") String shipCountry); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to AlloyDB

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

The following connection properties are usually required in order to connect to AlloyDB.

  • Server: The host name or IP of the server hosting the AlloyDB database.
  • User: The user which will be used to authenticate with the AlloyDB server.
  • Password: The password which will be used to authenticate with the AlloyDB server.

You can also optionally set the following:

  • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
  • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

Authenticating with Standard Authentication

Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

No further action is required to leverage Standard Authentication to connect.

Authenticating with pg_hba.conf Auth Schemes

There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

Find instructions about authentication setup on the AlloyDB Server here.

Authenticating with MD5 Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

Authenticating with SASL Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

Authenticating with Kerberos

The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

Built-in Connection String Designer

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

java -jar cdata.jdbc.alloydb.jar

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

A connection string for AlloyDB will typically look like the following:

jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432

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:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432"); MyOrdersDAO dao = dbi.open(MyOrdersDAO.class); //do stuff with the DAO dao.close();

Read AlloyDB Data

With the connection open to AlloyDB, simply call the previously defined method to retrieve data from the Orders entity in AlloyDB.

//disply the result of our 'find' method String shipCity = dao.findShipCityByShipCountry("USA"); System.out.println(shipCity);

Write AlloyDB Data

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

//add a new entry to the Orders entity dao.insert(newShipCountry, newShipCity);

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