Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Object-Relational Mapping (ORM) With Redis Data Entities in Java

DZone's Guide to

Object-Relational Mapping (ORM) With Redis Data Entities in Java

Want to learn more about object-relational mapping (ORM)? Check out this tutorial on relational data sources with Redis and the Java-based ORM framework, Hibernate.

· Java Zone ·
Free Resource

Java-based (JDBC) data connectivity to SaaS, NoSQL, and Big Data. Download Now.

Object-relational mapping (ORM) techniques make it easier to work with relational data sources and can bridge your logical business model with your physical storage model. Follow this tutorial to integrate connectivity to Redis data into a Java-based ORM framework, Hibernate.

You can use Hibernate to map object-oriented domain models to a traditional relational database. The tutorial below shows how to use the CData JDBC Driver for Redis to generate an ORM of your Redis repository with Hibernate.

Though Eclipse is the IDE of choice for this article, the CData JDBC Driver for Redis works in any product that supports the Java Runtime Environment. In the knowledge base, you will find tutorials on how to connect Redis data from IntelliJ IDEA and NetBeans.

Install Hibernate

Follow the steps below to install the Hibernate plug-in in Eclipse.

  1. In Eclipse, navigate to Help —> Install New Software
  2. Enter "http://download.jboss.org/jbosstools/neon/stable/updates/" in the Work With box
  3. Enter "Hibernate" into the filter box
  4. Select Hibernate Tools

Installing the Hibernate Framework in Eclipse

Start a New Project

Follow the steps below to add the driver JARs in a new project.

  1. First, create a new project. Then, select Java Project as your project type and click Next. Enter a project name and click Finish.
  2. Right-click the project and click Properties. Click Java Build Path and open the Libraries tab
  3. Click Add External JARs to add the cdata.jdbc.redis.jar library, located in the lib subfolder of the installation directory

Add a Hibernate Configuration File

Follow the steps below to configure connection properties to Redis data:

  1. Right-click on the new project and select New —> Hibernate —> Hibernate Configuration File (cfg.xml)
  2. Select src as the parent folder and click Next
  3. Input the following values:
    • Hibernate version: 5.2
    • Database dialect: Derby
    • Driver class: cdata.jdbc.redis.RedisDriver
    • Connection URL: A JDBC URL, starting with jdbc:redis: and followed by a semicolon-separated list of connection properties. Set the following connection properties to connect to a Redis instance:
      • Server: Set this to the name or address of the server your Redis instance is running on. You can specify the port in Port.
      • Password: Set this to the password used to authenticate with a password-protected Redis instance, using the Redis AUTH command
      Set UseSSL to negotiate SSL/TLS encryption when you connect. A typical JDBC URL is shown below:jdbc:redis:Server=127.0.0.1;Port=6379;Password=myPassword;

Connect Hibernate to Redis Data

Follow the steps below to select the configuration you created in the previous step.

  1. Switch to the Hibernate Configurations perspective: Window —> Open Perspective —> Hibernate.
  2. Right-click on the Hibernate Configurations panel and click Add Configuration
  3. Set the Hibernate version to 5.2
  4. Click the Browse button and select the project
  5. For the Configuration file field, click Setup —> Use Existing and select the location of the hibernate.cfg.xml file (inside src folder in this demo)
  6. In the Classpath tab, if there is nothing under User Entries, click Add External JARS and add the driver jar once more. Click OK once the configuration is done.
  7. Expand the Database node of the newly created Hibernate configurations file

Hibernate Configuration Properties

Reverse Engineer Redis Data

Follow the steps below to generate the reveng.xml configuration file. You will specify the tables you want to access as objects.

  1. Switch back to the Package Explorer
  2. Right-click your project, select New —> Hibernate —> Hibernate Reverse Engineering File (reveng.xml). Click Next.
  3. Select src as the parent folder and click Next.
  4. In the Console configuration drop-down menu, select the Hibernate configuration file you created above and click Refresh.
  5. Expand the node and choose the tables you want to reverse engineer. Click Finish when you are done.

Tables to be Reverse Engineered

Configure Hibernate to Run

Follow the steps below to generate plain old Java objects (POJO) for the Redis tables:

  1. From the menu bar, click Run —> Hibernate Code Generation —> Hibernate Code Generation Configurations
  2. In the Console configuration drop-down menu, select the Hibernate configuration file you created in the previous section. Click Browse by Output directory and select src.
  3. Enable the Reverse Engineer from JDBC Connection checkbox. Click the Setup button, click Use Existing, and select the location of the hibernate.reveng.xml file (inside src folder in this demo).
  4. In the Exporters tab, check Domain code (.java) and Hibernate XML Mappings (hbm.xml).
  5. Click Run

One or more POJOs are created based on the reverse-engineering setting in the previous step.

Insert Mapping Tags

For each mapping you have generated, you will need to create a mapping tag in hibernate.cfg.xml to point Hibernate to your mapping resource. Open hibernate.cfg.xml and insert the mapping tags as so:

<hibernate-configuration>
  <session-factory name="">
    <property name="hibernate.connection.driver_class">
      cdata.redis.RedisDriver
    </property>
    <property name="hibernate.connection.url">
      jdbc:redis:Server=127.0.0.1;Port=6379;Password=myPassword;<!--?xml version="1.0" encoding="UTF-8"?-->
    </property>
    <property name="hibernate.dialect">
      org.hibernate.dialect.SQLServerDialect
    </property>

    <mapping resource="Customers.hbm.xml"></mapping> 
    </session-factory>
</hibernate-configuration>


Execute SQL

Using the entity you created from the last step, you can now search and modify Redis data:

import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM Customers C WHERE Country = :Country";
    Query q = session.createQuery(SELECT, Customers.class);
    q.setParameter("Country","US");
    List<customers> resultList = (List<customers>) q.list();

    for(Customers s: resultList){
      System.out.println(s.getCity());
      System.out.println(s.getCompanyName());
    }
  }
}


With the CData JDBC Driver for Redis, you get live connectivity to your Redis data, allowing you to easily build Java apps using popular frameworks, like Hibernate.

Connect any Java based application to your SaaS data.  Over 100+ Java-based data source connectors.

Topics:
java ,redis ,redis enterprise ,jdbc ,hibernate ,config file ,tutorial

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}