Top Related Projects
Kotlin SQL Framework
Simplifies the development of creating a JPA-based data access layer.
MyBatis SQL mapper framework for Java
jOOQ is the best way to write SQL in Java
requery - modern SQL based query & persistence for Java / Kotlin / Android
Quick Overview
Hibernate ORM is a powerful, high-performance Object/Relational Mapping (ORM) framework for Java. It provides a seamless bridge between object-oriented domain models and relational database systems, simplifying database operations and reducing boilerplate code in Java applications.
Pros
- Simplifies database operations by allowing developers to work with Java objects instead of SQL queries
- Supports a wide range of databases and provides database-independent querying
- Offers excellent performance optimization features, including lazy loading and caching
- Integrates well with other Java frameworks and technologies, such as Spring
Cons
- Steep learning curve for beginners, especially those new to ORM concepts
- Can introduce performance overhead if not configured properly
- May lead to unnecessary complexity for simple applications or small-scale projects
- Debugging can be challenging due to the abstraction layer between the application and the database
Code Examples
- Defining an entity:
@Entity
@Table(name = "users")
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(name = "username")
private String username;
@Column(name = "email")
private String email;
// Getters and setters
}
- Performing a simple query:
Session session = sessionFactory.openSession();
List<User> users = session.createQuery("FROM User", User.class).list();
session.close();
- Saving an entity:
Session session = sessionFactory.openSession();
Transaction tx = session.beginTransaction();
User user = new User();
user.setUsername("johndoe");
user.setEmail("john@example.com");
session.save(user);
tx.commit();
session.close();
Getting Started
To start using Hibernate ORM in your Java project:
- Add Hibernate dependencies to your project (using Maven):
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
<version>5.6.5.Final</version>
</dependency>
- Create a
hibernate.cfg.xml
configuration file in yoursrc/main/resources
directory:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
<session-factory>
<property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>
<property name="hibernate.connection.url">jdbc:mysql://localhost:3306/your_database</property>
<property name="hibernate.connection.username">your_username</property>
<property name="hibernate.connection.password">your_password</property>
<property name="hibernate.dialect">org.hibernate.dialect.MySQLDialect</property>
<property name="hibernate.show_sql">true</property>
<property name="hibernate.hbm2ddl.auto">update</property>
</session-factory>
</hibernate-configuration>
-
Create your entity classes and annotate them with Hibernate annotations.
-
Use
SessionFactory
to createSession
instances and perform database operations.
Competitor Comparisons
Kotlin SQL Framework
Pros of Exposed
- Lightweight and less complex, making it easier to learn and use
- Provides type-safe SQL DSL, reducing the risk of runtime errors
- Better integration with Kotlin language features
Cons of Exposed
- Less mature ecosystem and community support compared to Hibernate
- Fewer advanced features and optimizations for complex scenarios
- Limited documentation and learning resources
Code Comparison
Hibernate ORM:
@Entity
public class User {
@Id
private Long id;
private String name;
// Getters and setters
}
Exposed:
object Users : Table() {
val id = long("id").autoIncrement()
val name = varchar("name", 50)
override val primaryKey = PrimaryKey(id)
}
Summary
Hibernate ORM is a mature, feature-rich ORM framework with extensive documentation and community support. It offers advanced features for complex scenarios but can be more complex to set up and use.
Exposed is a lightweight, Kotlin-specific SQL framework that provides a type-safe DSL for database operations. It's easier to learn and use, especially for Kotlin developers, but lacks some advanced features and optimizations found in Hibernate.
The choice between the two depends on project requirements, team expertise, and the specific use case. Hibernate may be better suited for large, complex applications, while Exposed could be ideal for smaller Kotlin projects or those prioritizing simplicity and type safety.
Simplifies the development of creating a JPA-based data access layer.
Pros of Spring Data JPA
- Simplifies data access layer with repository interfaces
- Provides powerful query methods and custom query creation
- Integrates seamlessly with Spring ecosystem
Cons of Spring Data JPA
- Steeper learning curve for developers new to Spring
- Less flexibility in complex scenarios compared to Hibernate ORM
- Potential performance overhead due to abstraction layer
Code Comparison
Spring Data JPA:
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
List<User> findByLastName(String lastName);
}
Hibernate ORM:
Session session = sessionFactory.openSession();
List<User> users = session.createQuery("FROM User WHERE lastName = :lastName", User.class)
.setParameter("lastName", lastName)
.getResultList();
Spring Data JPA simplifies data access with repository interfaces and method naming conventions, while Hibernate ORM requires more explicit query definitions. Spring Data JPA abstracts away much of the boilerplate code, making it easier to work with JPA entities. However, Hibernate ORM offers more fine-grained control over queries and database operations, which can be beneficial in complex scenarios.
Both projects are widely used in the Java ecosystem, with Spring Data JPA being more tightly integrated with the Spring framework, while Hibernate ORM can be used independently or with other frameworks.
MyBatis SQL mapper framework for Java
Pros of MyBatis
- Simpler learning curve and easier to use for SQL-centric developers
- More fine-grained control over SQL queries and database interactions
- Lighter weight and potentially better performance for simple use cases
Cons of MyBatis
- Less abstraction from the database, requiring more manual SQL writing
- Fewer advanced ORM features compared to Hibernate
- Limited support for complex object relationships and cascading operations
Code Comparison
MyBatis:
@Select("SELECT * FROM users WHERE id = #{id}")
User getUser(int id);
Hibernate:
@Entity
public class User {
@Id
private int id;
// Other fields and annotations
}
User user = session.get(User.class, id);
MyBatis focuses on mapping SQL queries to method calls, while Hibernate uses annotations to define entity relationships and handles most SQL generation automatically. MyBatis provides more direct control over SQL, whereas Hibernate offers a higher level of abstraction from the database.
jOOQ is the best way to write SQL in Java
Pros of jOOQ
- Type-safe SQL queries with compile-time checking
- Easier to write complex SQL queries and joins
- Better performance for read-heavy applications
Cons of jOOQ
- Steeper learning curve for developers familiar with ORM concepts
- Less abstraction from the database, requiring more SQL knowledge
- Limited support for automatic schema generation and migrations
Code Comparison
Hibernate ORM:
Session session = sessionFactory.openSession();
List<User> users = session.createQuery("FROM User WHERE age > :age", User.class)
.setParameter("age", 18)
.getResultList();
jOOQ:
DSLContext create = DSL.using(connection, SQLDialect.MYSQL);
Result<Record> result = create.select()
.from(USER)
.where(USER.AGE.gt(18))
.fetch();
Key Differences
- Hibernate ORM is an Object-Relational Mapping tool, while jOOQ is a SQL builder and executor
- Hibernate focuses on object-oriented domain modeling, jOOQ on type-safe SQL generation
- Hibernate provides automatic dirty checking and lazy loading, jOOQ requires manual management
- jOOQ offers better support for database-specific features and optimizations
- Hibernate is more suitable for complex domain models, jOOQ for data-centric applications
requery - modern SQL based query & persistence for Java / Kotlin / Android
Pros of requery
- Lightweight and less complex, with a smaller codebase
- Supports reactive programming with RxJava integration
- Faster compile times and reduced build complexity
Cons of requery
- Less mature and smaller community compared to Hibernate
- Fewer advanced features and customization options
- Limited documentation and learning resources
Code Comparison
Hibernate ORM:
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
private String name;
// Getters and setters
}
requery:
@Entity
public interface User {
@Key @Generated
int getId();
String getName();
void setName(String name);
}
Summary
requery offers a lightweight alternative to Hibernate ORM with reactive programming support and faster compile times. However, it lacks the maturity, extensive feature set, and community support of Hibernate. The code comparison shows that requery uses interfaces for entity definitions, while Hibernate uses classes with annotations. Developers should consider their project requirements and team expertise when choosing between these ORM solutions.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Hibernate ORM is a powerful object/relational mapping solution for Java, and makes it easy to develop persistence logic for applications, libraries, and frameworks.
Hibernate implements JPA, the standard API for object/relational persistence in Java, but also offers an extensive set of features and APIs which go beyond the specification.
See https://hibernate.org/orm/[Hibernate.org] for more information.
image:https://ci.hibernate.org/job/hibernate-orm-pipeline/job/main/badge/icon[Build Status,link=https://ci.hibernate.org/job/hibernate-orm-pipeline/job/main/] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A[link=https://ge.hibernate.org/scans]
== Continuous Integration
Hibernate uses both https://jenkins-ci.org[Jenkins] and https://github.com/features/actions[GitHub Actions] for its CI needs. See
- https://ci.hibernate.org/view/ORM/[Jenkins Jobs]
- https://github.com/hibernate/hibernate-orm/actions[GitHub Actions Jobs]
== Building from sources
The build requires at least Java 11 and at most Java 17.
Hibernate uses https://gradle.org[Gradle] as its build tool. See the Gradle Primer section below if you are new to Gradle.
Contributors should read the link:CONTRIBUTING.md[Contributing Guide].
See the guides for setting up https://hibernate.org/community/contribute/intellij-idea/[IntelliJ] or https://hibernate.org/community/contribute/eclipse-ide/[Eclipse] as your development environment.
== Gradle Primer
The Gradle build tool has amazing documentation. 2 in particular that are indispensable:
- https://docs.gradle.org/current/userguide/userguide_single.html[Gradle User Guide] is a typical user guide in that it follows a topical approach to describing all of the capabilities of Gradle.
- https://docs.gradle.org/current/dsl/index.html[Gradle DSL Guide] is unique and excellent in quickly getting up to speed on certain aspects of Gradle.
We will cover the basics developers and contributors new to Gradle need to know to get productive quickly.
NOTE: The project defines a https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle Wrapper]. The rest of the section will assume execution through the wrapper.
=== Executing Tasks
Gradle uses the concept of build tasks (equivalent to Ant targets or Maven phases/goals). You can get a list of available tasks via
gradle tasks
To execute a task across all modules, simply perform that task from the root directory. Gradle will visit each sub-project and execute that task if the sub-project defines it. To execute a task in a specific module you can either:
. cd
into that module directory and execute the task
. name the "task path". For example, to run the tests for the hibernate-core module from the root directory
you could say gradle hibernate-core:test
=== Common tasks
The common tasks you might use in building Hibernate include:
- build - Assembles (jars) and tests this project
- compile - Performs all compilation tasks including staging resources from both main and test
- jar - Generates a jar archive with all the compiled classes
- test - Runs the tests
- publishToMavenLocal - Installs the project jar to your local maven cache (aka ~/.m2/repository). Note that Gradle never uses this, but it can be useful for testing your build with other local Maven-based builds.
- clean - Cleans the build directory
== Testing and databases
Testing against a specific database can be achieved in 2 different ways:
=== Using the "Matrix Testing Plugin" for Gradle.
Coming laterâ¦
=== Using "profiles"
The Hibernate build defines several database testing "profiles" in databases.gradle
. These
profiles can be activated by name using the db
build property which can be passed either as
a JVM system prop (-D
) or as a Gradle project property (-P
). Examples below use the Gradle
project property approach.
gradle clean build -Pdb=pgsql
To run a test from your IDE, you need to ensure the property expansions happen. Use the following command:
gradle clean compile -Pdb=pgsql
NOTE: If you are running tests against a JDBC driver that is not available via Maven central be sure to add these drivers to your local Maven repo cache (~/.m2/repository) or (better) add it to a personal Maven repo server
=== Running database-specific tests from the IDE using "profiles"
You can run any test on any particular database that is configured in a databases.gradle
profile.
All you have to do is run the following command:
./gradlew setDataBase -Pdb=pgsql
or you can use the shortcut version:
./gradlew sDB -Pdb=pgsql
You can do this from the module which you are interested in testing or from the hibernate-orm
root folder.
Afterward, just pick any test from the IDE and run it as usual. Hibernate will pick the database configuration from the hibernate.properties
file that was set up by the setDataBase
Gradle task.
=== Starting test databases locally as docker containers
You don't have to install all databases locally to be able to test against them in case you have docker available.
The script docker_db.sh
allows you to start a pre-configured database which can be used for testing.
All you have to do is run the following command:
./docker_db.sh postgresql
omitting the argument will print a list of possible options.
When the database is properly started, you can run tests with special profiles that are suffixed with _ci
e.g. pgsql_ci
for PostgreSQL. By using the system property dbHost
you can configure the IP address of your docker host.
The command for running tests could look like the following:
./gradlew test -Pdb=pgsql_ci "-DdbHost=192.168.99.100"
The following table illustrates a list of commands for various databases that can be tested locally.
|===
|Database |docker_db.sh
|Gradle command
H2 |
---|
./gradlew test -Pdb=h2 |
HSQLDB |
---|
./gradlew test -Pdb=hsqldb |
Apache Derby |
---|
./gradlew test -Pdb=derby |
|MySQL
|./docker_db.sh mysql
|./gradlew test -Pdb=mysql_ci
|MariaDB
|./docker_db.sh mariadb
|./gradlew test -Pdb=mariadb_ci
|PostgreSQL
|./docker_db.sh postgresql
|./gradlew test -Pdb=pgsql_ci
|EnterpriseDB
|./docker_db.sh edb
|./gradlew test -Pdb=edb_ci
|Oracle
|./docker_db.sh oracle
|./gradlew test -Pdb=oracle_ci
|DB2
|./docker_db.sh db2
|./gradlew test -Pdb=db2_ci
|SQL Server
|./docker_db.sh mssql
|./gradlew test -Pdb=mssql_ci
|Sybase ASE (jTDS)
|./docker_db.sh sybase
|./gradlew test -Pdb=sybase_ci
|Sybase ASE (jConnect)
|./docker_db.sh sybase
|./gradlew test -Pdb=sybase_jconn_ci
|SAP HANA
|./docker_db.sh hana
|./gradlew test -Pdb=hana_ci
|CockroachDB
|./docker_db.sh cockroachdb
|./gradlew test -Pdb=cockroachdb
|TiDB
|./docker_db.sh tidb
|./gradlew test -Pdb=tidb
|Informix
|./docker_db.sh informix
|./gradlew test -Pdb=informix
|===
To stop a container started by docker
, use the command
[source]
docker stop $container_name
NOTE:: Substitute podman
command for docker
if using podman
E.g., to stop the mariadb container
[source]
docker stop mariadb
Top Related Projects
Kotlin SQL Framework
Simplifies the development of creating a JPA-based data access layer.
MyBatis SQL mapper framework for Java
jOOQ is the best way to write SQL in Java
requery - modern SQL based query & persistence for Java / Kotlin / Android
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot