Use an ORM

Java ORM support for YugabyteDB

Hibernate ORM is an Object/Relational Mapping (ORM) framework for Java applications. Hibernate ORM is concerned with data persistence of relational databases, and enables developers to write applications whose data outlives the application lifetime.

YugabyteDB YSQL API has full compatibility with Hibernate ORM for Data persistence in Java applications. This page provides details for getting started with Hibernate ORM for connecting to YugabyteDB.

CRUD operations

Learn how to establish a connection to YugabyteDB database and begin basic CRUD operations using the steps in the Java ORM example application page.

The following sections demonstrate how to perform common tasks required for Java application development using the Hibernate ORM.

Step 1: Add the Hibernate ORM dependency

If you're using Maven, add the following to your project's pom.xml file.

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-core</artifactId>
    <version>5.4.19.Final</version>
</dependency>

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-annotations</artifactId>
    <version>3.5.6-Final</version>
</dependency>

If you're using Gradle, add the following dependencies to your build.gradle file:

implementation 'org.hibernate:hibernate-core:5.4.19.Final'
implementation 'org.hibernate:hibernate-annotations:3.5.6-Final'

Note: Hibernate ORM can be used with the YugabyteDB JDBC driver and the PostgreSQL JDBC Driver.

Step 2: Implementing ORM mapping for YugabyteDB

Create a file called Employee.java in the base package directory of your project and add the following code for a class that includes the following fields, setters, and getters.

@Entity
@Table(name = "employee")
public class Employee {

  @Id
  Integer id;
  String name;
  Integer age;
  String language;

  // Setters and Getters

}

Step 3: Create a DAO object for Employee object

Create a Data Access Object (DAO) EmployeeDAO.java in the base package directory. The DAO is used for implementing the basic CRUD operations for the domain object Employee.java. Copy the following sample code into your project.

import org.hibernate.Session;

public class EmployeeDAO {

  Session hibernateSession;

  public EmployeeDAO (Session session) {
    hibernateSession = session;
  }

  public void save(final Employee employeeEntity) {
    Transaction transaction = session.beginTransaction();
        try {
            session.save(entity);
            transaction.commit();
        } catch(RuntimeException rte) {
            transaction.rollback();
        }
        session.close();
  }

  public Optional<Employee> findById(final Integer id) {
    return Optional.ofNullable(session.get(Emplyee.class, id));
  }
}

Step 4: Configure Hibernate properties

Add the hibernate configurations file hibernate.cfg.xml to the resources directory, and copy the following contents into the file.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE hibernate-configuration SYSTEM
        "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
    <session-factory>
        <property name="hibernate.dialect">org.hibernate.dialect.PostgreSQLDialect</property>
        <property name="hibernate.connection.driver_class">com.yugabytedb.Driver</property>
        <property name="hibernate.connection.url">jdbc:yugabytedb://localhost:5433/yugabyte</property>
        <property name="hibernate.connection.username">yugabyte</property>
        <property name="hibernate.connection.password"></property>
        <property name="hibernate.hbm2ddl.auto">update</property>
        <property name="show_sql">true</property>
        <property name="generate-ddl">true</property>
        <property name="hibernate.ddl-auto">generate</property>
        <property name="hibernate.connection.isolation">8</property>
        <property name="hibernate.current_session_context_class">thread</property>
        <property name="javax.persistence.create-database-schemas">true</property>
    </session-factory>
</hibernate-configuration>

The Hibernate configuration file provides the generic set of properties that are required for configuring the Hibernate ORM for YugabyteDB.

Hibernate Parameter	Description	Default
hibernate.dialect	Dialect to use to generate SQL optimized for a particular database	org.hibernate.dialect.PostgreSQLDialect
hibernate.connection.driver_class	JDBC Driver name	com.yugabytedb.Driver
hibernate.connection.url	JDBC Connection URL	jdbc:yugabytedb://localhost:5433/yugabyte
hibernate.connection.username	Username	yugabyte
hibernate.connection.password	Password	yugabyte
hibernate.hbm2ddl.auto	Behaviour for automatic schema generation	none

Hibernate provides an exhaustive list of properties to configure the different features supported by the ORM. Additional details can be obtained by referring to the Hibernate documentation.

Step 5: Adding the Object relational mapping

Along with properties for configuring the Hibernate ORM, hibernate.cfg.xml is also used for specifying the Domain objects mapping using <mapping> tags.

Add a mapping for Employee object in hibernate.cfg.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE hibernate-configuration SYSTEM
        "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
    <session-factory>
        ...
        <mapping class="com.yugabyte.hibernatedemo.model.Employee"/>
    </session-factory>
</hibernate-configuration>

Step 6: Query the YugabyteDB Cluster using Hibernate ORM

Create a new Java class called QuickStartOrmApp.java in the base package directory of your project. Copy the following sample code to query the table contents from the Java client using Hibernate ORM. Ensure you replace the parameters in the connection string yburl with the cluster credentials and SSL certificate, if required.

import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.Scanner;
import org.hibernate.Session;
import org.hibernate.SessionFactory;

public class QuickStartOrmApp {


  public static void main(String[] args) throws ClassNotFoundException, SQLException {

    SessionFactory sessionFactory = HibernateUtil.getSessionFactory();
    Session session = sessionFactory.openSession();

    try {
          System.out.println("Connected to the YugabyteDB Cluster successfully.");
          EmplyeeDAO employeeDAO = new EmployeeDAO(session);
          // Save an employee
          employeeDAO.save(new Employee());

          // Find the emplyee
          Employee employee = employeeDAO.findByID(1);
          System.out.println("Query Returned:" + employee.toString());
        }
    } catch (SQLException e) {
      System.err.println(e.getMessage());
    }
  }
}

When you run the Project, QuickStartApp.java should output something like the following:

Connected to the YugabyteDB Cluster successfully.
Created table employee
Inserted data: INSERT INTO employee (id, name, age, language) VALUES (1, 'John', 35, 'Java');
Query returned: name=John, age=35, language: Java

Learn more

Build Java applications using Ebean ORM
YugabyteDB smart drivers for YSQL