Hypersistence Optimizer Installation Guide

Installation Guide

Once you downloaded the release version, you need to unzip the package.

> unzip hypersistence-optimizer-1.2.0-pack.zip

After unzipping the setup package, you will get the following resource file structure:

Archive:  hypersistence-optimizer-1.2.0-pack.zip
   creating: hypersistence-optimizer-1.2.0/
   creating: hypersistence-optimizer-1.2.0/lib/
  inflating: hypersistence-optimizer-1.2.0/lib/hypersistence-optimizer-1.2.0-javadoc.jar
  inflating: hypersistence-optimizer-1.2.0/lib/hypersistence-optimizer-1.2.0-sources.jar
  inflating: hypersistence-optimizer-1.2.0/changelog.txt
  inflating: hypersistence-optimizer-1.2.0/LICENSE.txt
  inflating: hypersistence-optimizer-1.2.0/lib/hypersistence-optimizer-1.2.0.jar
  inflating: hypersistence-optimizer-1.2.0/maven-install.bat
  inflating: hypersistence-optimizer-1.2.0/maven-install.sh
  inflating: hypersistence-optimizer-1.2.0/README.txt

Installing the Maven dependency

Now, you need to install the Maven dependency to your local repository.

For Windows, use the maven-install.bat script. For Unix-based systems (e.g. Linux, Mac OS), use the maven-install.sh script.

> maven-install.bat

Now, the hypersistence-optimizer Maven dependency is installed to your local repository.

Adding the Maven dependency to your project

You need to add the hypersistence-optimizer Maven dependency to your project pom.xml configuration file:

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-optimizer</artifactId>
    <version>${hypersistence-optimizer.version}</version>
</dependency>

The hypersistence-optimizer.version is a Maven property which you need to declare in the properties tag of your pom.xml configuration file:

<hypersistence-optimizer.version>1.2.0</hypersistence-optimizer.version>

Requirements

The compatibility matrix between Hibernate, JPA and Java versions looks as follows:

Hibernate JPA Java
5.4 2.2 1.8 or above
5.3 2.2 1.8 or above
5.2 2.1 1.8 or above
5.1 2.1 1.6 or above
5.0 2.1 1.6 or above
4.3 2.1 1.6 or above
4.2 2.0 1.6 or above
4.1 2.0 1.6 or above
3.6 2.0 1.6 or above
3.5 2.0 1.6 or above
3.3 1.0 1.6 or above

Therefore, you need to make sure that you are using the proper Java version based on what Hibernate is compiled with. Hypersistence Optimizer simply follows the Hibernate minimum Java requirement. So, if you’re using Hibernate 5.1, you can use Java 1.6 and the Hypersiste Optimizer will work just fine.

Other than Hibernate, Hypersistence Optimizer requires you to have the SLF4J dependency in your Maven or Gradle project. Thanks to SLF4J, you can use the Logging framework of your choice (e.g. Logback, Log4j 2, Log4j).

And, that’s pretty much what you need in order to install Hypersistence Optimizer.

Want to run your data access layer at warp speed?