-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat JBoss Web Server
Hibernate Core Reference Guide
An Introductory Guide for Hibernate with Red Hat JBoss Web Server 3.0
Red Hat Customer Content Services
Abstract
Chapter 1. Using Hibernate
1.1. Introduction to Using Hibernate
1.2. Hibernate Tutorial
Important
1.3. Your First Hibernate Application
1.3.1. About the Hibernate Application Tutorial
Note
1.3.2. Set Up Your Hibernate Application
src/main/java
, src/main/resources
and src/main/webapp
directories.
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http:// maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.hibernate.tutorials</groupId> <artifactId>hibernate-tutorial</artifactId> <version>1.0.0-SNAPSHOT</version> <packaging>war</packaging> <name>First Hibernate Tutorial</name> <build> <!--we dont want the version to be part of the generated war file name--> <finalName>${artifactId}</finalName> <!--we dont want to use the jars maven provided, we want to use JBoss' ones--> <plugins> <plugin> <artifactId>maven-war-plugin</artifactId> <configuration> <packagingExcludes>WEB-INF/lib/*.jar</packagingExcludes> </configuration> </plugin> </plugins> </build> <dependencies> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-core</artifactId> <version>3.3.2.GA_CP03</version> <!-- please check the release notes for the correct version you're using --> </dependency> <dependency> <groupId>org.hsqldb</groupId> <artifactId>hsqldb</artifactId> <version>2.2.9</version> </dependency> <!-- Because this is a web app, we also have a dependency on the servlet api. --> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <version>2.5</version> </dependency> <!-- Hibernate uses slf4j for logging, for our purposes here use the simple backend --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-simple</artifactId> <version>1.5.8</version> </dependency> <!-- Hibernate gives you a choice of bytecode providers between cglib and javassist --> <dependency> <groupId>javassist</groupId> <artifactId>javassist</artifactId> <version>3.12.0.GA</version> </dependency> </dependencies> </project>
Note
hibernate3.jar
, all artifacts in the lib/required
directory and all files from either the lib/bytecode/cglib
or lib/bytecode/javassist
directory; additionally you will need both the servlet-api jar and one of the slf4j logging backends.
pom.xml
in the project root directory.
1.3.3. Create the First Class
package org.hibernate.tutorial.domain; import java.util.Date; public class Event { private Long id; private String title; private Date date; public Event() {} public Long getId() { return id; } private void setId(Long id) { this.id = id; } public Date getDate() { return date; } public void setDate(Date date) { this.date = date; } public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } }
id
property holds a unique identifier value for a particular event. All persistent entity classes (there are less important dependent classes as well) will need such an identifier property if we want to use the full feature set of Hibernate. In fact, most applications, especially web applications, need to distinguish objects by identifier, so you should consider this a feature rather than a limitation. However, we usually do not manipulate the identity of an object, hence the setter method should be private. Only Hibernate will assign identifiers when an object is saved. Hibernate can access public, private, and protected accessor methods, as well as public, private and protected fields directly. The choice is up to you and you can match it to fit your application design.
Event.java
in the src/main/java/org/hibernate/tutorial/domain
directory.
1.3.4. The Mapping File
<?xml version="1.0"?> <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> <hibernate-mapping package="org.hibernate.tutorial.domain"> [...] </hibernate-mapping>
hibernate-core.jar
(it is also included in the hibernate3.jar
, if using the distribution bundle).
Important
hibernate-mapping
tags, include a class
element. All persistent entity classes (again, there might be dependent classes later on, which are not first-class entities) need a mapping to a table in the SQL database:
<hibernate-mapping package="org.hibernate.tutorial.domain"> <class name="Event" table="EVENTS"> </class> </hibernate-mapping>
Event
to the table EVENTS
. Each instance is now represented by a row in that table. Now we can continue by mapping the unique identifier property to the tables primary key. As we do not want to care about handling this identifier, we configure Hibernate's identifier generation strategy for a surrogate primary key column:
<hibernate-mapping package="org.hibernate.tutorial.domain"> <class name="Event" table="EVENTS"> <id name="id" column="EVENT_ID"> <generator class="native"/> </id> </class> </hibernate-mapping>
id
element is the declaration of the identifier property. The name="id"
mapping attribute declares the name of the JavaBean property and tells Hibernate to use the getId()
and setId()
methods to access the property. The column attribute tells Hibernate which column of the EVENTS
table holds the primary key value.
generator
element specifies the identifier generation strategy. In this case we choose native
, which offers a level of portability depending on the configured database dialect. Hibernate supports database generated, globally unique, as well as application assigned, identifiers. Identifier value generation is also one of Hibernate's many extension points and you can plugin in your own strategy.
Note
native
is no longer considered the best strategy in terms of portability.
<hibernate-mapping package="org.hibernate.tutorial.domain"> <class name="Event" table="EVENTS"> <id name="id" column="EVENT_ID"> <generator class="native"/> </id> <property name="date" type="timestamp" column="EVENT_DATE"/> <property name="title"/> </class> </hibernate-mapping>
id
element, the name
attribute of the property
element tells Hibernate which getter and setter methods to use. In this case, Hibernate will search for getDate()
, setDate()
, getTitle()
and setTitle()
methods.
Note
date
property mapping include the column
attribute, but the title
does not? Without the column
attribute, Hibernate by default uses the property name as the column name. This works for title
, however, date
is a reserved keyword in most databases so you will need to map it to a different name.
title
mapping also lacks a type
attribute. The types declared and used in the mapping files are not Java data types; they are not SQL database types either. These types are called Hibernate mapping types, converters which can translate from Java to SQL data types and vice versa. Again, Hibernate will try to determine the correct conversion and mapping type itself if the type
attribute is not present in the mapping. In some cases this automatic detection using Reflection on the Java class might not have the default you expect or need. This is the case with the date
property. Hibernate cannot know if the property, which is of java.util.Date
, should map to a SQL date
, timestamp
, or time
column. Full date and time information is preserved by mapping the property with a timestamp
converter.
Note
src/main/resources/org/hibernate/tutorial/domain/Event.hbm.xml
.
1.3.5. Hibernate Configuration
mvn exec:java -Dexec.mainClass="org.hsqldb.Server" -Dexec.args="-database.0 file:target/data/tutorial"
You will see it start up and bind to a TCP/IP socket; this is where our application will connect later. If you want to start with a fresh database during this tutorial, shutdown HSQLDB, delete all files in the target/data
directory, and start HSQLDB again.
javax.sql.DataSource
). Hibernate comes with support for two third-party open source JDBC connection pools: c3p0 and proxool. However, we will be using the Hibernate built-in connection pool for this tutorial.
Warning
hibernate.properties
file, a more sophisticated hibernate.cfg.xml
file, or even complete programmatic setup. Most users prefer the XML configuration file:
<?xml version='1.0' encoding='utf-8'?> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> <hibernate-configuration> <session-factory> <!-- Database connection settings --> <property name="connection.driver_class">org.hsqldb.jdbcDriver</property> <property name="connection.url">jdbc:hsqldb:hsql://localhost</property> <property name="connection.username">sa</property> <property name="connection.password"></property> <!-- JDBC connection pool (use the built-in) --> <property name="connection.pool_size">1</property> <!-- SQL dialect --> <property name="dialect">org.hibernate.dialect.HSQLDialect</property> <!-- Enable Hibernate's automatic session context management --> <property name="current_session_context_class">thread</property> <!-- Disable the second-level cache --> <property name="cache.provider_class">org.hibernate.cache.NoCacheProvider</property> <!-- Echo all executed SQL to stdout --> <property name="show_sql">true</property> <!-- Drop and re-create the database schema on startup --> <property name="hbm2ddl.auto">update</property> <mapping resource="org/hibernate/tutorial/domain/Event.hbm.xml"/> </session-factory> </hibernate-configuration>
Note
SessionFactory
. SessionFactory is a global factory responsible for a particular database. If you have several databases, for easier startup you should use several <session-factory>
configurations in several configuration files.
property
elements contain the necessary configuration for the JDBC connection. The dialect property
element specifies the particular SQL variant Hibernate generates.
Note
hbm2ddl.auto
option turns on automatic generation of database schemas directly into the database. This can also be turned off by removing the configuration option, or redirected to a file with the help of the SchemaExport
Ant task. Finally, add the mapping file(s) for persistent classes to the configuration.
hibernate.cfg.xml
into the src/main/resources
directory.
1.3.6. Building with Maven
/pom.xml
file we created earlier and know how to perform some basic project tasks. First, lets run the compile
goal to make sure we can compile everything so far. In the root directory of your maven project, run the following command:
$ mvn compile
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Building First Hibernate Tutorial
[INFO] task-segment: [compile]
[INFO] ------------------------------------------------------------------------
[INFO] [resources:resources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:compile]
[INFO] Compiling 1 source file to /home/steve/projects/sandbox/hibernateTutorial/target/classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2 seconds
[INFO] Finished at: Tue Jun 09 12:25:25 CDT 2009
[INFO] Final Memory: 5M/547M
[INFO] ------------------------------------------------------------------------
1.3.7. Startup and Helpers
Event
objects, but first you have to complete the setup with some infrastructure code. You have to startup Hibernate by building a global org.hibernate.SessionFactory
object and storing it somewhere for easy access in application code. A org.hibernate.SessionFactory
is used to obtain org.hibernate.Session
instances. A org.hibernate.Session
represents a single-threaded unit of work. The org.hibernate.SessionFactory
is a thread-safe global object that is instantiated once.
HibernateUtil
helper class that takes care of startup and makes accessing the org.hibernate.SessionFactory
more convenient.
package org.hibernate.tutorial.util; import org.hibernate.SessionFactory; import org.hibernate.cfg.Configuration; public class HibernateUtil { private static final SessionFactory sessionFactory = buildSessionFactory(); private static SessionFactory buildSessionFactory() { try { // Create the SessionFactory from hibernate.cfg.xml return new Configuration().configure().buildSessionFactory(); } catch (Throwable ex) { // Make sure you log the exception, as it might be swallowed System.err.println("Initial SessionFactory creation failed." + ex); throw new ExceptionInInitializerError(ex); } } public static SessionFactory getSessionFactory() { return sessionFactory; } }
src/main/java/org/hibernate/tutorial/util/HibernateUtil.java
org.hibernate.SessionFactory
reference in its static initializer; it also hides the fact that it uses a static singleton. We might just as well have looked up the org.hibernate.SessionFactory
reference from JNDI in an application server or any other location for that matter.
org.hibernate.SessionFactory
a name in your configuration, Hibernate will try to bind it to JNDI under that name after it has been built. Another, better option is to use a JMX deployment and let the JMX-capable container instantiate and bind a HibernateService
to JNDI. Such advanced options are discussed later.
log4j.properties
from the Hibernate distribution in the etc/
directory to your src
directory, next to hibernate.cfg.xml
. If you prefer to have more verbose output than that provided in the example configuration, you can change the settings. By default, only the Hibernate startup message is shown on stdout.
1.3.8. Loading and Storing Objects
EventManager
class with a main()
method:
package org.hibernate.tutorial; import org.hibernate.Session; import java.util.*; import org.hibernate.tutorial.domain.Event; import org.hibernate.tutorial.util.HibernateUtil; public class EventManager { public static void main(String[] args) { EventManager mgr = new EventManager(); if (args[0].equals("store")) { mgr.createAndStoreEvent("My Event", new Date()); } HibernateUtil.getSessionFactory().close(); } private void createAndStoreEvent(String title, Date theDate) { Session session = HibernateUtil.getSessionFactory().getCurrentSession(); session.beginTransaction(); Event theEvent = new Event(); theEvent.setTitle(title); theEvent.setDate(theDate); session.save(theEvent); session.getTransaction().commit(); } }
createAndStoreEvent()
we created a new Event
object and handed it over to Hibernate. At that point, Hibernate takes care of the SQL and executes an INSERT
on the database.
org.hibernate.Transaction
API. In this particular case we are using JDBC-based transactional semantics, but it could also run with JTA.
sessionFactory.getCurrentSession()
do? First, you can call it as many times and anywhere you like once you get hold of your org.hibernate.SessionFactory
. The getCurrentSession()
method always returns the "current" unit of work. Remember that we switched the configuration option for this mechanism to "thread" in our src/main/resources/hibernate.cfg.xml
? Due to that setting, the context of a current unit of work is bound to the current Java thread that executes the application.
Important
getCurrentSession()
is made for the current thread. It is then bound by Hibernate to the current thread. When the transaction ends, either through commit or rollback, Hibernate automatically unbinds the org.hibernate.Session from the thread and closes it for you. If you call getCurrentSession()
again, you get a new org.hibernate.Session and can start a new unit of work.
mvn exec:java -Dexec.mainClass="org.hibernate.tutorial.EventManager" -Dexec.args="store"
Note
mvn compile
first.
[java] Hibernate: insert into EVENTS (EVENT_DATE, title, EVENT_ID) values (?, ?, ?)
INSERT
executed by Hibernate.
if (args[0].equals("store")) { mgr.createAndStoreEvent("My Event", new Date()); } else if (args[0].equals("list")) { List events = mgr.listEvents(); for (int i = 0; i < events.size(); i++) { Event theEvent = (Event) events.get(i); System.out.println( "Event: " + theEvent.getTitle() + " Time: " + theEvent.getDate() ); } }
listEvents()
method is also added:
private List listEvents() { Session session = HibernateUtil.getSessionFactory().getCurrentSession(); session.beginTransaction(); List result = session.createQuery("from Event").list(); session.getTransaction().commit(); return result; }
Event
objects from the database. Hibernate will generate the appropriate SQL, send it to the database and populate Event
objects with the data. You can create more complex queries with HQL. See the Hibernate Query Language chapter for further information.
mvn exec:java -Dexec.mainClass="org.hibernate.tutorial.EventManager" -Dexec.args="list"
1.4. Mapping Associations
1.4.1. About Mapping Associations
1.4.2. Mapping the Person Class
Person
class looks like this:
package org.hibernate.tutorial.domain; public class Person { private Long id; private int age; private String firstname; private String lastname; public Person() {} // Accessor methods for all properties, private setter for 'id' }
src/main/java/org/hibernate/tutorial/domain/Person.java
src/main/resources/org/hibernate/tutorial/domain/Person.hbm.xml
<hibernate-mapping package="org.hibernate.tutorial.domain"> <class name="Person" table="PERSON"> <id name="id" column="PERSON_ID"> <generator class="native"/> </id> <property name="age"/> <property name="firstname"/> <property name="lastname"/> </class> </hibernate-mapping>
Event.hbm.xml
:
<mapping resource="events/Event.hbm.xml"/> <mapping resource="events/Person.hbm.xml"/>
1.4.3. A Unidirectional Set-based Association
Person
class, you can easily navigate to the events for a particular person, without executing an explicit query - by calling Person#getEvents
. Multi-valued associations are represented in Hibernate by one of the Java Collection Framework contracts; here we choose a java.util.Set
because the collection will not contain duplicate elements and the ordering is not relevant to our examples:
import java.util.Set; public class Person { private Set events = new HashSet(); public Set getEvents() { return events; } public void setEvents(Set events) { this.events = events; } }
Event
, if we wanted to be able to navigate it from both directions. This is not necessary, from a functional perspective. You can always execute an explicit query to retrieve the participants for a particular event. This is a design choice left to you, but what is clear from this discussion is the multiplicity of the association: "many" valued on both sides is called a many-to-many association. Hence, we use Hibernate's many-to-many mapping:
<class name="Person" table="PERSON"> <id name="id" column="PERSON_ID"> <generator class="native"/> </id> <property name="age"/> <property name="firstname"/> <property name="lastname"/> <set name="events" table="PERSON_EVENT"> <key column="PERSON_ID"/> <many-to-many column="EVENT_ID" class="Event"/> </set> </class>
set
being most common. For a many-to-many association, or n:m entity relationship, an association table is required. Each row in this table represents a link between a person and an event. The table name is decalred using the table
attribute of the set
element. The identifier column name in the association, for the person side, is defined with the key
element, the column name for the event's side with the column
attribute of the many-to-many
. You also have to tell Hibernate the class of the objects in your collection (the class on the other side of the collection of references).
_____________ __________________ | | | | _____________ | EVENTS | | PERSON_EVENT | | | |_____________| |__________________| | PERSON | | | | | |_____________| | *EVENT_ID | <--> | *EVENT_ID | | | | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | | TITLE | |__________________| | AGE | |_____________| | FIRSTNAME | | LASTNAME | |_____________|
1.4.4. Working the Association
EventManager
:
private void addPersonToEvent(Long personId, Long eventId) { Session session = HibernateUtil.getSessionFactory().getCurrentSession(); session.beginTransaction(); Person aPerson = (Person) session.load(Person.class, personId); Event anEvent = (Event) session.load(Event.class, eventId); aPerson.getEvents().add(anEvent); session.getTransaction().commit(); }
Person
and an Event
, simply modify the collection using the normal collection methods. There is no explicit call to update()
or save()
; Hibernate automatically detects that the collection has been modified and needs to be updated. This is called automatic dirty checking. You can also try it by modifying the name or the date property of any of your objects. As long as they are in persistent state, that is, bound to a particular Hibernate org.hibernate.Session
, Hibernate monitors any changes and executes SQL in a write-behind fashion. The process of synchronizing the memory state with the database, usually only at the end of a unit of work, is called flushing. In our code, the unit of work ends with a commit, or rollback, of the database transaction.
org.hibernate.Session
, when it is not in persistent state (if it was persistent before, this state is called detached). You can even modify a collection when it is detached:
private void addPersonToEvent(Long personId, Long eventId) { Session session = HibernateUtil.getSessionFactory().getCurrentSession(); session.beginTransaction(); Person aPerson = (Person) session .createQuery("select p from Person p left join fetch p.events where p.id = :pid") .setParameter("pid", personId) .uniqueResult(); // Eager fetch the collection so we can use it detached Event anEvent = (Event) session.load(Event.class, eventId); session.getTransaction().commit(); // End of first unit of work aPerson.getEvents().add(anEvent); // aPerson (and its collection) is detached // Begin second unit of work Session session2 = HibernateUtil.getSessionFactory().getCurrentSession(); session2.beginTransaction(); session2.update(aPerson); // Reattachment of aPerson session2.getTransaction().commit(); }
update
makes a detached object persistent again by binding it to a new unit of work, so any modifications you made to it while detached can be saved to the database. This includes any modifications (additions/deletions) you made to a collection of that entity object.
EventManager
and call it from the command line. If you need the identifiers of a person and an event - the save()
method returns it (you might have to modify some of the previous methods to return that identifier):
else if (args[0].equals("addpersontoevent")) { Long eventId = mgr.createAndStoreEvent("My Event", new Date()); Long personId = mgr.createAndStorePerson("Foo", "Bar"); mgr.addPersonToEvent(personId, eventId); System.out.println("Added person " + personId + " to event " + eventId); }
int
or a java.lang.String
. We call these classes value types, and their instances depend on a particular entity. Instances of these types do not have their own identity, nor are they shared between entities. Two persons do not reference the same firstname
object, even if they have the same first name. Value types cannot only be found in the JDK , but you can also write dependent classes yourself such as an Address
or MonetaryAmount
class. In fact, in a Hibernate application all JDK classes are considered value types.
1.4.5. Collection of Values
Person
entity. This will be represented as a java.util.Set
of java.lang.String
instances:
private Set emailAddresses = new HashSet(); public Set getEmailAddresses() { return emailAddresses; } public void setEmailAddresses(Set emailAddresses) { this.emailAddresses = emailAddresses; }
Set
is as follows:
<set name="emailAddresses" table="PERSON_EMAIL_ADDR"> <key column="PERSON_ID"/> <element type="string" column="EMAIL_ADDR"/> </set>
element
part which tells Hibernate that the collection does not contain references to another entity, but is rather a collection whose elements are values types, here specifically of type string
. The lowercase name tells you it is a Hibernate mapping type/converter. Again the table
attribute of the set
element determines the table name for the collection. The key
element defines the foreign-key column name in the collection table. The column
attribute in the element
element defines the column name where the email address values will actually be stored.
_____________ __________________ | | | | _____________ | EVENTS | | PERSON_EVENT | | | ___________________ |_____________| |__________________| | PERSON | | | | | | | |_____________| | PERSON_EMAIL_ADDR | | *EVENT_ID | <--> | *EVENT_ID | | | |___________________| | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | <--> | *PERSON_ID | | TITLE | |__________________| | AGE | | *EMAIL_ADDR | |_____________| | FIRSTNAME | |___________________| | LASTNAME | |_____________|
private void addEmailToPerson(Long personId, String emailAddress) { Session session = HibernateUtil.getSessionFactory().getCurrentSession(); session.beginTransaction(); Person aPerson = (Person) session.load(Person.class, personId); // adding to the emailAddress collection might trigger a lazy load of the collection aPerson.getEmailAddresses().add(emailAddress); session.getTransaction().commit(); }
1.4.6. Bi-directional Associations
Note
Event
class:
private Set participants = new HashSet(); public Set getParticipants() { return participants; } public void setParticipants(Set participants) { this.participants = participants; }
Event.hbm.xml
.
<set name="participants" table="PERSON_EVENT" inverse="true"> <key column="EVENT_ID"/> <many-to-many column="PERSON_ID" class="org.hibernate.tutorial.domain.Person"/> </set>
set
mappings in both mapping documents. Notice that the column names in key
and many-to-many
swap in both mapping documents. The most important addition here is the inverse="true"
attribute in the set
element of the Event
's collection mapping.
Person
class, when it needs to find out information about the link between the two. This will be a lot easier to understand once you see how the bi-directional link between our two entities is created.
1.4.7. Working Bi-directional Links
Person
and an Event
in the unidirectional example? You add an instance of Event
to the collection of event references, of an instance of Person
. If you want to make this link bi-directional, you have to do the same on the other side by adding a Person
reference to the collection in an Event
. This process of "setting the link on both sides" is absolutely necessary with bi-directional links.
Person
):
protected Set getEvents() { return events; } protected void setEvents(Set events) { this.events = events; } public void addToEvent(Event event) { this.getEvents().add(event); event.getParticipants().add(this); } public void removeFromEvent(Event event) { this.getEvents().remove(event); event.getParticipants().remove(this); }
inverse
mapping attribute? For you, and for Java, a bi-directional link is simply a matter of setting the references on both sides correctly. Hibernate, however, does not have enough information to correctly arrange SQL INSERT
and UPDATE
statements (to avoid constraint violations). Making one side of the association inverse
tells Hibernate to consider it a mirror of the other side. That is all that is necessary for Hibernate to resolve any issues that arise when transforming a directional navigation model to a SQL database schema. The rules are straightforward: all bi-directional associations need one side as inverse
. In a one-to-many association it has to be the many-side, and in many-to-many association you can select either side.
1.5. The EventManager Web Application
1.5.1. About the EventManager
Session
and Transaction
almost like a standalone application. However, some common patterns are useful. You can now write an EventManagerServlet
. This servlet can list all events stored in the database, and it provides an HTML form to enter new events.
1.5.2. Writing the Basic Servlet
GET
requests, we will only implement the doGet()
method:
package org.hibernate.tutorial.web; // Imports public class EventManagerServlet extends HttpServlet { protected void doGet( HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { SimpleDateFormat dateFormatter = new SimpleDateFormat( "dd.MM.yyyy" ); try { // Begin unit of work HibernateUtil.getSessionFactory().getCurrentSession().beginTransaction(); // Process request and render page... // End unit of work HibernateUtil.getSessionFactory().getCurrentSession().getTransaction().commit(); } catch (Exception ex) { HibernateUtil.getSessionFactory().getCurrentSession().getTransaction().rollback(); if ( ServletException.class.isInstance( ex ) ) { throw ( ServletException ) ex; } else { throw new ServletException( ex ); } } } }
src/main/java/org/hibernate/tutorial/web/EventManagerServlet.java
Session
is opened through the first call to getCurrentSession()
on the SessionFactory
. A database transaction is then started. All data access occurs inside a transaction irrespective of whether the data is read or written. Do not use the auto-commit mode in applications.
Session
for every database operation. Use one Hibernate Session
that is scoped to the whole request. Use getCurrentSession()
, so that it is automatically bound to the current Java thread.
session-per-request
pattern. Instead of the transaction demarcation code in every servlet, you could also write a servlet filter. See the Hibernate website and Wiki for more information about this pattern called Open Session in View. You will need it as soon as you consider rendering your view in JSP, not in a servlet.
1.5.3. Processing and Rendering
// Write HTML header PrintWriter out = response.getWriter(); out.println("<html><head><title>Event Manager</title></head><body>"); // Handle actions if ( "store".equals(request.getParameter("action")) ) { String eventTitle = request.getParameter("eventTitle"); String eventDate = request.getParameter("eventDate"); if ( "".equals(eventTitle) || "".equals(eventDate) ) { out.println("<b><i>Please enter event title and date.</i></b>"); } else { createAndStoreEvent(eventTitle, dateFormatter.parse(eventDate)); out.println("<b><i>Added event.</i></b>"); } } // Print page printEventForm(out); listEvents(out, dateFormatter); // Write HTML footer out.println("</body></html>"); out.flush(); out.close();
private void printEventForm(PrintWriter out) { out.println("<h2>Add new event:</h2>"); out.println("<form>"); out.println("Title: <input name='eventTitle' length='50'/><br/>"); out.println("Date (e.g. 24.12.2009): <input name='eventDate' length='10'/><br/>"); out.println("<input type='submit' name='action' value='store'/>"); out.println("</form>"); }
listEvents()
method uses the Hibernate Session
bound to the current thread to execute a query:
private void listEvents(PrintWriter out, SimpleDateFormat dateFormatter) { List result = HibernateUtil.getSessionFactory() .getCurrentSession().createCriteria(Event.class).list(); if (result.size() > 0) { out.println("<h2>Events in database:</h2>"); out.println("<table border='1'>"); out.println("<tr>"); out.println("<th>Event title</th>"); out.println("<th>Event date</th>"); out.println("</tr>"); Iterator it = result.iterator(); while (it.hasNext()) { Event event = (Event) it.next(); out.println("<tr>"); out.println("<td>" + event.getTitle() + "</td>"); out.println("<td>" + dateFormatter.format(event.getDate()) + "</td>"); out.println("</tr>"); } out.println("</table>"); } }
store
action is dispatched to the createAndStoreEvent()
method, which also uses the Session
of the current thread:
protected void createAndStoreEvent(String title, Date theDate) { Event theEvent = new Event(); theEvent.setTitle(title); theEvent.setDate(theDate); HibernateUtil.getSessionFactory() .getCurrentSession().save(theEvent); }
Session
and Transaction
. As earlier in the standalone application, Hibernate can automatically bind these objects to the current thread of execution. This gives you the freedom to layer your code and access the SessionFactory
in any way you like. Usually you would use a more sophisticated design and move the data access code into data access objects (the DAO pattern).
1.5.4. Deploying and Testing
src/main/webapp/WEB-INF/web.xml
<?xml version="1.0" encoding="UTF-8"?> <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <servlet> <servlet-name>Event Manager</servlet-name> <servlet-class>org.hibernate.tutorial.web.EventManagerServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>Event Manager</servlet-name> <url-pattern>/eventmanager</url-pattern> </servlet-mapping> </web-app>
mvn package
in your project directory and copy the hibernate-tutorial.war
file into your $JBOSS_HOME/server/$CONFIG/deploy
directory.
http://localhost:8080/hibernate-tutorial/eventmanager
. Watch the server log (in $JBOSS_HOME/server/$CONFIG/log/server.log
) to see Hibernate initialize when the first request hits your servlet (the static initializer in HibernateUtil
is called) and to get the detailed output if any exceptions occurs.
1.5.5. Summary
Chapter 2. Hibernate
2.1. About Hibernate Core
2.2. Java Persistence API (JPA)
2.2.1. About JPA
2.2.2. Hibernate EntityManager
2.2.3. Configuration
2.2.3.1. Hibernate Configuration Properties
Table 2.1. Hibernate Java Properties
Property Name | Description |
---|---|
hibernate.dialect |
The classname of a Hibernate
org.hibernate.dialect.Dialect . Allows Hibernate to generate SQL optimized for a particular relational database.
In most cases Hibernate will be able to choose the correct
org.hibernate.dialect.Dialect implementation, based on the JDBC metadata returned by the JDBC driver.
|
hibernate.show_sql |
Boolean. Writes all SQL statements to console. This is an alternative to setting the log category
org.hibernate.SQL to debug .
|
hibernate.format_sql |
Boolean. Pretty print the SQL in the log and console.
|
hibernate.default_schema |
Qualify unqualified table names with the given schema/tablespace in generated SQL.
|
hibernate.default_catalog |
Qualifies unqualified table names with the given catalog in generated SQL.
|
hibernate.session_factory_name |
The
org.hibernate.SessionFactory will be automatically bound to this name in JNDI after it has been created. For example, jndi/composite/name .
|
hibernate.max_fetch_depth |
Sets a maximum "depth" for the outer join fetch tree for single-ended associations (one-to-one, many-to-one). A
0 disables default outer join fetching. The recommended value is between 0 and 3 .
|
hibernate.default_batch_fetch_size |
Sets a default size for Hibernate batch fetching of associations. The recommended values are
4 , 8 , and 16 .
|
hibernate.default_entity_mode |
Sets a default mode for entity representation for all sessions opened from this
SessionFactory . Values include: dynamic-map , dom4j , pojo .
|
hibernate.order_updates |
Boolean. Forces Hibernate to order SQL updates by the primary key value of the items being updated. This will result in fewer transaction deadlocks in highly concurrent systems.
|
hibernate.generate_statistics |
Boolean. If enabled, Hibernate will collect statistics useful for performance tuning.
|
hibernate.use_identifier_rollback |
Boolean. If enabled, generated identifier properties will be reset to default values when objects are deleted.
|
hibernate.use_sql_comments |
Boolean. If turned on, Hibernate will generate comments inside the SQL, for easier debugging. Default value is
false .
|
hibernate.id.new_generator_mappings |
Boolean. This property is relevant when using
@GeneratedValue . It indicates whether or not the new IdentifierGenerator implementations are used for javax.persistence.GenerationType.AUTO , javax.persistence.GenerationType.TABLE and javax.persistence.GenerationType.SEQUENCE . Default value is true .
|
hibernate.ejb.naming_strategy |
Chooses the
org.hibernate.cfg.NamingStrategy implementation when using Hibernate EntityManager. This class is deprecated and this property is only provided for backward compatibility. This property must not be used with hibernate.ejb.naming_strategy_delegator .
If the application does not use EntityManager, follow the instructions here to configure the NamingStrategy: Hibernate Reference Documentation - Implementing a Naming Strategy.
|
hibernate.ejb.naming_strategy_delegator |
Specifies an
org.hibernate.cfg.naming.NamingStrategyDelegator implementation for database objects and schema elements when using Hibernate EntityManager. This property has the following possible values.
Note
This property must not be used with hibernate.ejb.naming_strategy . It is a temporary replacement for org.hibernate.cfg.NamingStrategy to address its limitations. A more comprehensive solution is planned for Hibernate 5.0 that replaces both org.hibernate.cfg.NamingStrategy and org.hibernate.cfg.naming.NamingStrategyDelegator .
If the application does not use EntityManager, follow the instructions here to configure the NamingStrategy: Hibernate Reference Documentation - Implementing a Naming Strategy.
|
Important
hibernate.id.new_generator_mappings
, new applications should keep the default value of true
. Existing applications that used Hibernate 3.3.x may need to change it to false
to continue using a sequence object or table based generator, and maintain backward compatibility.
2.2.3.2. Hibernate JDBC and Connection Properties
Table 2.2. Properties
Property Name | Description |
---|---|
hibernate.jdbc.fetch_size |
A non-zero value that determines the JDBC fetch size (calls
Statement.setFetchSize() ).
|
hibernate.jdbc.batch_size |
A non-zero value enables use of JDBC2 batch updates by Hibernate. The recommended values are between
5 and 30 .
|
hibernate.jdbc.batch_versioned_data |
Boolean. Set this property to
true if the JDBC driver returns correct row counts from executeBatch() . Hibernate will then use batched DML for automatically versioned data. Default value is to false .
|
hibernate.jdbc.factory_class |
Select a custom
org.hibernate.jdbc.Batcher . Most applications will not need this configuration property.
|
hibernate.jdbc.use_scrollable_resultset |
Boolean. Enables use of JDBC2 scrollable resultsets by Hibernate. This property is only necessary when using user-supplied JDBC connections. Hibernate uses connection metadata otherwise.
|
hibernate.jdbc.use_streams_for_binary |
Boolean. This is a system-level property. Use streams when writing/reading
binary or serializable types to/from JDBC.
|
hibernate.jdbc.use_get_generated_keys |
Boolean. Enables use of JDBC3
PreparedStatement.getGeneratedKeys() to retrieve natively generated keys after insert. Requires JDBC3+ driver and JRE1.4+. Set to false if JDBC driver has problems with the Hibernate identifier generators. By default, it tries to determine the driver capabilities using connection metadata.
|
hibernate.connection.provider_class |
The classname of a custom
org.hibernate.connection.ConnectionProvider which provides JDBC connections to Hibernate.
|
hibernate.connection.isolation |
Sets the JDBC transaction isolation level. Check
java.sql.Connection for meaningful values, but note that most databases do not support all isolation levels and some define additional, non-standard isolations. Standard values are 1, 2, 4, 8 .
|
hibernate.connection.autocommit |
Boolean. This property is not recommended for use. Enables autocommit for JDBC pooled connections.
|
hibernate.connection.release_mode |
Specifies when Hibernate should release JDBC connections. By default, a JDBC connection is held until the session is explicitly closed or disconnected. The default value
auto will choose after_statement for the JTA and CMT transaction strategies, and after_transaction for the JDBC transaction strategy.
Available values are
auto (default), on_close , after_transaction , after_statement .
This setting only affects
Session returned from SessionFactory.openSession . For Session obtained through SessionFactory.getCurrentSession , the CurrentSessionContext implementation configured for use controls the connection release mode for that Session .
|
hibernate.connection.<propertyName> |
Pass the JDBC property <propertyName> to
DriverManager.getConnection() .
|
hibernate.jndi.<propertyName> |
Pass the property <propertyName> to the JNDI
InitialContextFactory .
|
2.2.3.3. Hibernate Cache Properties
Table 2.3. Properties
Property Name | Description |
---|---|
hibernate.cache.region.factory_class |
The classname of a custom
CacheProvider .
|
hibernate.cache.use_minimal_puts |
Boolean. Optimizes second-level cache operation to minimize writes, at the cost of more frequent reads. This setting is most useful for clustered caches and, in Hibernate3, is enabled by default for clustered cache implementations.
|
hibernate.cache.use_query_cache |
Boolean. Enables the query cache. Individual queries still have to be set cacheable.
|
hibernate.cache.use_second_level_cache |
Boolean. Used to completely disable the second level cache, which is enabled by default for classes that specify a
<cache> mapping.
|
hibernate.cache.query_cache_factory |
The classname of a custom
QueryCache interface. The default value is the built-in StandardQueryCache .
|
hibernate.cache.region_prefix |
A prefix to use for second-level cache region names.
|
hibernate.cache.use_structured_entries |
Boolean. Forces Hibernate to store data in the second-level cache in a more human-friendly format.
|
hibernate.cache.default_cache_concurrency_strategy |
Setting used to give the name of the default
org.hibernate.annotations.CacheConcurrencyStrategy to use when either @Cacheable or @Cache is used. @Cache(strategy="..") is used to override this default.
|
2.2.3.4. Hibernate Transaction Properties
Table 2.4. Properties
Property Name | Description |
---|---|
hibernate.transaction.factory_class |
The classname of a
TransactionFactory to use with Hibernate Transaction API. Defaults to JDBCTransactionFactory ).
|
jta.UserTransaction |
A JNDI name used by
JTATransactionFactory to obtain the JTA UserTransaction from the application server.
|
hibernate.transaction.manager_lookup_class |
The classname of a
TransactionManagerLookup . It is required when JVM-level caching is enabled or when using hilo generator in a JTA environment.
|
hibernate.transaction.flush_before_completion |
Boolean. If enabled, the session will be automatically flushed during the before completion phase of the transaction. Built-in and automatic session context management is preferred.
|
hibernate.transaction.auto_close_session |
Boolean. If enabled, the session will be automatically closed during the after completion phase of the transaction. Built-in and automatic session context management is preferred.
|
2.2.3.5. Miscellaneous Hibernate Properties
Table 2.5. Properties
Property Name | Description |
---|---|
hibernate.current_session_context_class |
Supply a custom strategy for the scoping of the "current"
Session . Values include jta , thread , managed , custom.Class .
|
hibernate.query.factory_class |
Chooses the HQL parser implementation:
org.hibernate.hql.internal.ast.ASTQueryTranslatorFactory or org.hibernate.hql.internal.classic.ClassicQueryTranslatorFactory .
|
hibernate.query.substitutions |
Used to map from tokens in Hibernate queries to SQL tokens (tokens might be function or literal names). For example,
hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC .
|
hibernate.hbm2ddl.auto |
Automatically validates or exports schema DDL to the database when the
SessionFactory is created. With create-drop , the database schema will be dropped when the SessionFactory is closed explicitly. Property value options are validate , update , create , create-drop
|
hibernate.hbm2ddl.import_files |
Comma-separated names of the optional files containing SQL DML statements executed during the
SessionFactory creation. This is useful for testing or demonstrating. For example, by adding INSERT statements, the database can be populated with a minimal set of data when it is deployed. An example value is /humans.sql,/dogs.sql .
File order matters, as the statements of a given file are executed before the statements of the following files. These statements are only executed if the schema is created (i.e. if
hibernate.hbm2ddl.auto is set to create or create-drop ).
|
hibernate.hbm2ddl.import_files_sql_extractor |
The classname of a custom
ImportSqlCommandExtractor . Defaults to the built-in SingleLineSqlCommandExtractor . This is useful for implementing a dedicated parser that extracts a single SQL statement from each import file. Hibernate also provides MultipleLinesSqlCommandExtractor , which supports instructions/comments and quoted strings spread over multiple lines (mandatory semicolon at the end of each statement).
|
hibernate.bytecode.use_reflection_optimizer |
Boolean. This is a system-level property, which cannot be set in the
hibernate.cfg.xml file. Enables the use of bytecode manipulation instead of runtime reflection. Reflection can sometimes be useful when troubleshooting. Hibernate always requires either cglib or javassist even if the optimizer is turned off.
|
hibernate.bytecode.provider |
Both javassist or cglib can be used as byte manipulation engines. The default is
javassist . Property value is either javassist or cglib
|
2.2.3.6. Hibernate SQL Dialects
Important
hibernate.dialect
property should be set to the correct org.hibernate.dialect.Dialect
subclass for the application database. If a dialect is specified, Hibernate will use sensible defaults for some of the other properties. This means that they do not have to be specified manually.
Table 2.6. SQL Dialects (hibernate.dialect
)
RDBMS | Dialect |
---|---|
DB2 | org.hibernate.dialect.DB2Dialect |
DB2 AS/400 | org.hibernate.dialect.DB2400Dialect |
DB2 OS390 | org.hibernate.dialect.DB2390Dialect |
Firebird | org.hibernate.dialect.FirebirdDialect |
FrontBase | org.hibernate.dialect.FrontbaseDialect |
H2 Database | org.hibernate.dialect.H2Dialect |
HypersonicSQL | org.hibernate.dialect.HSQLDialect |
Informix | org.hibernate.dialect.InformixDialect |
Ingres | org.hibernate.dialect.IngresDialect |
Interbase | org.hibernate.dialect.InterbaseDialect |
Mckoi SQL | org.hibernate.dialect.MckoiDialect |
Microsoft SQL Server 2000 | org.hibernate.dialect.SQLServerDialect |
Microsoft SQL Server 2005 | org.hibernate.dialect.SQLServer2005Dialect |
Microsoft SQL Server 2008 | org.hibernate.dialect.SQLServer2008Dialect |
Microsoft SQL Server 2012 | org.hibernate.dialect.SQLServer2008Dialect |
MySQL5 | org.hibernate.dialect.MySQL5Dialect |
MySQL5 with InnoDB | org.hibernate.dialect.MySQL5InnoDBDialect |
MySQL with MyISAM | org.hibernate.dialect.MySQLMyISAMDialect |
Oracle (any version) | org.hibernate.dialect.OracleDialect |
Oracle 9i | org.hibernate.dialect.Oracle9iDialect |
Oracle 10g | org.hibernate.dialect.Oracle10gDialect |
Oracle 11g | org.hibernate.dialect.Oracle10gDialect |
Pointbase | org.hibernate.dialect.PointbaseDialect |
PostgreSQL | org.hibernate.dialect.PostgreSQLDialect |
PostgreSQL 9.2 | org.hibernate.dialect.PostgreSQL82Dialect |
Postgres Plus Advanced Server | org.hibernate.dialect.PostgresPlusDialect |
Progress | org.hibernate.dialect.ProgressDialect |
SAP DB | org.hibernate.dialect.SAPDBDialect |
Sybase | org.hibernate.dialect.SybaseASE15Dialect |
Sybase 15.7 | org.hibernate.dialect.SybaseASE157Dialect |
Sybase Anywhere | org.hibernate.dialect.SybaseAnywhereDialect |
2.3. Connection Pooling
2.3.1. About Connection Pooling
hibernate.connection.pool_size
property with the appropriate settings for your selected connection pool. Setting a new value automatically disabled Hibernate's internal connection pool.
2.3.2. C3P0 Connection Pool
lib/
directory. Hibernate uses org.hibernate.service.jdbc.connections.internal.C3P0ConnectionProvider
for connection pooling if the hibernate.c3p0
connection properties are set.
hibernate.c3p0
connection properties to set to use the c3p0 connection pool in Hibernate:
Table 2.7. Configuration Properties for the C3p0 Connection Pool
Property | Details |
---|---|
hibernate.c3p0.min_size | The minimum number of concurrent connections per connection identity. |
hibernate.c3p0.max_size | The maximum number of concurrent connections per connection identity. |
hibernate.c3p0.timeout | The period an idle connection is allowed to remain in the connection pool before it is closed and removed from the pool. |
hibernate.c3p0.max_statements | The maximum size of the statement cache. |
2.3.3. Use JNDI to Obtain a Connection
javax.sql.Datasource
) that is registered in JNDI. Set more than one of the following properties to configure JNDI to obtain a connection:
Table 2.8. JNDI Properties
Property Name | Description |
---|---|
hibernate.connection.datasource | Datasource JNDI name (mandatory). |
hibernate.jndi.url | URL of the JNDI provider (optional). |
hibernate.jndi.class | Class of the JNDI InitialContextFactory (optional). |
hibernate.connection.username | Database user (optional). |
hibernate.connection.password | Database user's password (optional). |
2.3.4. Other Connection Specific Configurations
hibernate.connection
. For example, to specify a charSet
property, specify a new charSet
connection property names hibernate.connection.charSet
.
org.hibernate.service.jdbc.connections.spi.ConnectionProvider
and by specifying a custom implementation with the hibernate.connection.provider_class
property.
2.4. Hibernate Annotations
2.4.1. Hibernate Annotations
Table 2.9. Hibernate Defined Annotations
Annotation | Description |
---|---|
AccessType | Property Access type. |
Any | Defines a ToOne association pointing to several entity types. Matching the according entity type is done through a metadata discriminator column. This kind of mapping should be only marginal. |
AnyMetaDef | Defines @Any and @ManyToAny metadata. |
AnyMedaDefs | Defines @Any and @ManyToAny set of metadata. Can be defined at the entity level or the package level. |
BatchSize | Batch size for SQL loading. |
Cache | Add caching strategy to a root entity or a collection. |
Cascade | Apply a cascade strategy on an association. |
Check | Arbitrary SQL check constraints which can be defined at the class, property or collection level. |
Columns | Support an array of columns. Useful for component user type mappings. |
ColumnTransformer | Custom SQL expression used to read the value from and write a value to a column. Use for direct object loading/saving as well as queries. The write expression must contain exactly one '?' placeholder for the value. |
ColumnTransformers | Plural annotation for @ColumnTransformer. Useful when more than one column is using this behavior. |
DiscriminatorFormula | Discriminator formula to be placed at the root entity. |
DiscriminatorOptions | Optional annotation to express Hibernate specific discriminator properties. |
Entity | Extends Entity with Hibernate features. |
Fetch | Defines the fetching strategy used for the given association. |
FetchProfile | Defines the fetching strategy profile. |
FetchProfiles | Plural annotation for @FetchProfile. |
Filter | Adds filters to an entity or a target entity of a collection. |
FilterDef | Filter definition. |
FilterDefs | Array of filter definitions. |
FilterJoinTable | Adds filters to a join table collection. |
FilterJoinTables | Adds multiple @FilterJoinTable to a collection. |
Filters | Adds multiple @Filters. |
Formula | To be used as a replacement for @Column in most places. The formula has to be a valid SQL fragment. |
Generated | This annotated property is generated by the database. |
GenericGenerator | Generator annotation describing any kind of Hibernate generator in a detyped manner. |
GenericGenerators | Array of generic generator definitions. |
Immutable |
Mark an Entity or a Collection as immutable. No annotation means the element is mutable.
An immutable entity may not be updated by the application. Updates to an immutable entity will be ignored, but no exception is thrown.
@Immutable placed on a collection makes the collection immutable, meaning additions and deletions to and from the collection are not allowed. A HibernateException is thrown in this case.
|
Index | Defines a database index. |
JoinFormula | To be used as a replacement for @JoinColumn in most places. The formula has to be a valid SQL fragment. |
LazyCollection | Defines the lazy status of a collection. |
LazyToOne | Defines the lazy status of a ToOne association (i.e. OneToOne or ManyToOne). |
Loader | Overwrites Hibernate default FIND method. |
ManyToAny | Defines a ToMany association pointing to different entity types. Matching the according entity type is done through a metadata discriminator column. This kind of mapping should be only marginal. |
MapKeyType | Defines the type of key of a persistent map. |
MetaValue | Represents a discriminator value associated to a given entity type. |
NamedNativeQueries | Extends NamedNativeQueries to hold Hibernate NamedNativeQuery objects. |
NamedNativeQuery | Extends NamedNativeQuery with Hibernate features. |
NamedQueries | Extends NamedQueries to hold Hibernate NamedQuery objects. |
NamedQuery | Extends NamedQuery with Hibernate features. |
NaturalId | Specifies that a property is part of the natural id of the entity. |
NotFound | Action to do when an element is not found on an association. |
OnDelete | Strategy to use on collections, arrays and on joined subclasses delete. OnDelete of secondary tables is currently not supported. |
OptimisticLock | Whether or not a change of the annotated property will trigger an entity version increment. If the annotation is not present, the property is involved in the optimistic lock strategy (default). |
OptimisticLocking | Used to define the style of optimistic locking to be applied to an entity. In a hierarchy, only valid on the root entity. |
OrderBy | Order a collection using SQL ordering (not HQL ordering). |
ParamDef | A parameter definition. |
Parameter | Key/value pattern. |
Parent | Reference the property as a pointer back to the owner (generally the owning entity). |
Persister | Specify a custom persister. |
Polymorphism | Used to define the type of polymorphism Hibernate will apply to entity hierarchies. |
Proxy | Lazy and proxy configuration of a particular class. |
RowId | Support for ROWID mapping feature of Hibernate. |
Sort | Collection sort (Java level sorting). |
Source | Optional annotation in conjunction with Version and timestamp version properties. The annotation value decides where the timestamp is generated. |
SQLDelete | Overwrites the Hibernate default DELETE method. |
SQLDeleteAll | Overwrites the Hibernate default DELETE ALL method. |
SQLInsert | Overwrites the Hibernate default INSERT INTO method. |
SQLUpdate | Overwrites the Hibernate default UPDATE method. |
Subselect | Maps an immutable and read-only entity to a given SQL subselect expression. |
Synchronize | Ensures that auto-flush happens correctly and that queries against the derived entity do not return stale data. Mostly used with Subselect. |
Table | Complementary information to a table either primary or secondary. |
Tables | Plural annotation of Table. |
Target | Defines an explicit target, avoiding reflection and generics resolving. |
Tuplizer | Defines a tuplizer for an entity or a component. |
Tuplizers | Defines a set of tuplizers for an entity or a component. |
Type | Hibernate Type. |
TypeDef | Hibernate Type definition. |
TypeDefs | Hibernate Type definition array. |
Where | Where clause to add to the element Entity or target entity of a collection. The clause is written in SQL. |
WhereJoinTable | Where clause to add to the collection join table. The clause is written in SQL. |
Note
2.5. Envers
2.5.1. About Hibernate Envers
@Audited
, which store the history of changes made to the entity. The data can then be retrieved and queried.
- audit all mappings defined by the JPA specification,
- audit all hibernate mappings that extend the JPA specification,
- audit entities mapped by or using the native Hibernate API
- log data for each revision using a revision entity, and
- query historical data.
2.5.2. About Auditing Persistent Classes
@Audited
annotation. When the annotation is applied to a class, a table is created, which stores the revision history of the entity.
2.5.3. Auditing Strategies
2.5.3.1. About Auditing Strategies
- Default Audit Strategy
- This strategy persists the audit data together with a start revision. For each row that is inserted, updated or deleted in an audited table, one or more rows are inserted in the audit tables, along with the start revision of its validity.Rows in the audit tables are never updated after insertion. Queries of audit information use subqueries to select the applicable rows in the audit tables, which are slow and difficult to index.
- Validity Audit Strategy
- This strategy stores the start revision, as well as the end revision of the audit information. For each row that is inserted, updated or deleted in an audited table, one or more rows are inserted in the audit tables, along with the start revision of its validity.At the same time, the end revision field of the previous audit rows (if available) is set to this revision. Queries on the audit information can then use between start and end revision, instead of subqueries. This means that persisting audit information is a little slower because of the extra updates, but retrieving audit information is a lot faster.This can also be improved by adding extra indexes.
2.5.4. Getting Started with Entity Auditing
2.5.4.1. Add Auditing Support to a JPA Entity
- Task Summary
- This topic covers adding auditing support for a JPA entity.
Procedure 2.1. Add Auditing Support to a JPA Entity
- Configure the available auditing parameters to suit the deployment (refer to Section 2.5.5.1, “Configure Envers Parameters”).
- Open the Java source of JPA entity in an editor.
- Import the
org.hibernate.envers.Audited
interface. - Apply the
@Audited
annotation to each field or property to be audited, or apply it once to the whole class.Example 2.1. Audit Two Fields
import org.hibernate.envers.Audited; import javax.persistence.Entity; import javax.persistence.Id; import javax.persistence.GeneratedValue; import javax.persistence.Column; @Entity public class Person { @Id @GeneratedValue private int id; @Audited private String name; private String surname; @ManyToOne @Audited private Address address; // add getters, setters, constructors, equals and hashCode here }
Example 2.2. Audit an entire Class
import org.hibernate.envers.Audited; import javax.persistence.Entity; import javax.persistence.Id; import javax.persistence.GeneratedValue; import javax.persistence.Column; @Entity @Audited public class Person { @Id @GeneratedValue private int id; private String name; private String surname; @ManyToOne private Address address; // add getters, setters, constructors, equals and hashCode here }
- Result
- The JPA entity has been configured for auditing. A table called
Entity_AUD
will be created to store the historical changes.
2.5.5. Configuration
2.5.5.1. Configure Envers Parameters
- Task Summary
- This topic covers configuring the available Envers parameters.
Procedure 2.2. Configure Envers Parameters
- Open the
persistence.xml
file for the application. - Add, remove or configure Envers properties as required. For a list of available properties, refer to Section 2.5.5.4, “Envers Configuration Properties”.
Example 2.3. Example Envers Parameters
<persistence-unit ...> <provider>org.hibernate.ejb.HibernatePersistence</provider> <class>...</class> <properties> <property name="hibernate.dialect" ... /> <!-- other hibernate properties --> <property name="hibernate.ejb.event.post-insert" value="org.hibernate.ejb.event.EJB3PostInsertEventListener,org.hibernate.envers.event.AuditEventListener" /> <property name="hibernate.ejb.event.post-update" value="org.hibernate.ejb.event.EJB3PostUpdateEventListener,org.hibernate.envers.event.AuditEventListener" /> <property name="hibernate.ejb.event.post-delete" value="org.hibernate.ejb.event.EJB3PostDeleteEventListener,org.hibernate.envers.event.AuditEventListener" /> <property name="hibernate.ejb.event.pre-collection-update" value="org.hibernate.envers.event.AuditEventListener" /> <property name="hibernate.ejb.event.pre-collection-remove" value="org.hibernate.envers.event.AuditEventListener" /> <property name="hibernate.ejb.event.post-collection-recreate" value="org.hibernate.envers.event.AuditEventListener" /> <property name="org.hibernate.envers.versionsTableSuffix" value="_V" /> <property name="org.hibernate.envers.revisionFieldName" value="ver_rev" /> <!-- other envers properties --> </properties> </persistence-unit>
- Result
- Auditing has been configured for all JPA entities in the application.
2.5.5.2. Enable or Disable Auditing at Runtime
This task covers the configuration steps required to enable/disable entity version auditing at runtime.
Procedure 2.3. Enable/Disable Auditing
- Subclass the
AuditEventListener
class. - Override the following methods that are called on Hibernate events:
- onPostInsert
- onPostUpdate
- onPostDelete
- onPreUpdateCollection
- onPreRemoveCollection
- onPostRecreateCollection
- Specify the subclass as the listener for the events.
- Determine if the change should be audited.
- Pass the call to the superclass if the change should be audited.
2.5.5.3. Configure Conditional Auditing
Hibernate Envers persists audit data in reaction to various Hibernate events, using a series of event listeners. These listeners are registered automatically if the Envers jar is in the class path. This task covers the steps required to implement conditional auditing, by overriding some of the Envers event listeners.
Procedure 2.4. Implement Conditional Auditing
- Set the
hibernate.listeners.envers.autoRegister
Hibernate property to false in thepersistence.xml
file. - Subclass each event listener to be overridden. Place the conditional auditing logic in the subclass, and call the super method if auditing should be performed.
- Create a custom implementation of
org.hibernate.integrator.spi.Integrator
, similar toorg.hibernate.envers.event.EnversIntegrator
. Use the event listener subclasses created in step two, rather than the default classes. - Add a
META-INF/services/org.hibernate.integrator.spi.Integrator
file to the jar. This file should contain the fully qualified name of the class implementing the interface.
Conditional auditing has been configured, overriding the default Envers event listeners.
2.5.5.4. Envers Configuration Properties
Table 2.10. Entity Data Versioning Configuration Parameters
Property Name | Default Value | Description |
---|---|---|
org.hibernate.envers.audit_table_prefix
| |
A string that is prepended to the name of an audited entity, to create the name of the entity that will hold the audit information.
|
org.hibernate.envers.audit_table_suffix
|
_AUD
|
A string that is appended to the name of an audited entity to create the name of the entity that will hold the audit information. For example, if an entity with a table name of
Person is audited, Envers will generate a table called Person_AUD to store the historical data.
|
org.hibernate.envers.revision_field_name
|
REV
|
The name of the field in the audit entity that holds the revision number.
|
org.hibernate.envers.revision_type_field_name
|
REVTYPE
|
The name of the field in the audit entity that holds the type of revision. The current types of revisions possible are:
add , mod and del .
|
org.hibernate.envers.revision_on_collection_change
|
true
|
This property determines if a revision should be generated if a relation field that is not owned changes. This can either be a collection in a one-to-many relation, or the field using the
mappedBy attribute in a one-to-one relation.
|
org.hibernate.envers.do_not_audit_optimistic_locking_field
|
true
|
When true, properties used for optimistic locking (annotated with
@Version ) will automatically be excluded from auditing.
|
org.hibernate.envers.store_data_at_delete
|
false
|
This property defines whether or not entity data should be stored in the revision when the entity is deleted, instead of only the ID, with all other properties marked as null. This is not usually necessary, as the data is present in the last-but-one revision. Sometimes, however, it is easier and more efficient to access it in the last revision. However, this means the data the entity contained before deletion is stored twice.
|
org.hibernate.envers.default_schema
|
null (same as normal tables)
|
The default schema name used for audit tables. Can be overridden using the
@AuditTable(schema="...") annotation. If not present, the schema will be the same as the schema of the normal tables.
|
org.hibernate.envers.default_catalog
|
null (same as normal tables)
|
The default catalog name that should be used for audit tables. Can be overridden using the
@AuditTable(catalog="...") annotation. If not present, the catalog will be the same as the catalog of the normal tables.
|
org.hibernate.envers.audit_strategy
|
org.hibernate.envers.strategy.DefaultAuditStrategy
|
This property defines the audit strategy that should be used when persisting audit data. By default, only the revision where an entity was modified is stored. Alternatively,
org.hibernate.envers.strategy.ValidityAuditStrategy stores both the start revision and the end revision. Together, these define when an audit row was valid.
|
org.hibernate.envers.audit_strategy_validity_end_rev_field_name
|
REVEND
|
The column name that will hold the end revision number in audit entities. This property is only valid if the validity audit strategy is used.
|
org.hibernate.envers.audit_strategy_validity_store_revend_timestamp
|
false
|
This property defines whether the timestamp of the end revision, where the data was last valid, should be stored in addition to the end revision itself. This is useful to be able to purge old audit records out of a relational database by using table partitioning. Partitioning requires a column that exists within the table. This property is only evaluated if the
ValidityAuditStrategy is used.
|
org.hibernate.envers.audit_strategy_validity_revend_timestamp_field_name
|
REVEND_TSTMP
|
Column name of the timestamp of the end revision at which point the data was still valid. Only used if the
ValidityAuditStrategy is used, and org.hibernate.envers.audit_strategy_validity_store_revend_timestamp evaluates to true.
|
2.5.6. Queries
2.5.6.1. Retrieve Auditing Information
Hibernate Envers provides the functionality to retrieve audit information through queries. This topic provides examples of those queries.
Note
live
data, as they involve correlated subselects.
Example 2.4. Querying for Entities of a Class at a Given Revision
AuditQuery query = getAuditReader() .createQuery() .forEntitiesAtRevision(MyEntity.class, revisionNumber);
AuditEntity
factory class. The query below only selects entities where the name
property is equal to John
:
query.add(AuditEntity.property("name").eq("John"));
query.add(AuditEntity.property("address").eq(relatedEntityInstance)); // or query.add(AuditEntity.relatedId("address").eq(relatedEntityId));
List personsAtAddress = getAuditReader().createQuery() .forEntitiesAtRevision(Person.class, 12) .addOrder(AuditEntity.property("surname").desc()) .add(AuditEntity.relatedId("address").eq(addressId)) .setFirstResult(4) .setMaxResults(2) .getResultList();
Example 2.5. Query Revisions where Entities of a Given Class Changed
AuditQuery query = getAuditReader().createQuery() .forRevisionsOfEntity(MyEntity.class, false, true);
AuditEntity.revisionNumber()
- Specify constraints, projections and order on the revision number in which the audited entity was modified.
AuditEntity.revisionProperty(propertyName)
- Specify constraints, projections and order on a property of the revision entity, corresponding to the revision in which the audited entity was modified.
AuditEntity.revisionType()
- Provides accesses to the type of the revision (ADD, MOD, DEL).
MyEntity
class, with the entityId
ID has changed, after revision number 42:
Number revision = (Number) getAuditReader().createQuery() .forRevisionsOfEntity(MyEntity.class, false, true) .setProjection(AuditEntity.revisionNumber().min()) .add(AuditEntity.id().eq(entityId)) .add(AuditEntity.revisionNumber().gt(42)) .getSingleResult();
actualDate
for a given entity was larger than a given value, but as small as possible:
Number revision = (Number) getAuditReader().createQuery() .forRevisionsOfEntity(MyEntity.class, false, true) // We are only interested in the first revision .setProjection(AuditEntity.revisionNumber().min()) .add(AuditEntity.property("actualDate").minimize() .add(AuditEntity.property("actualDate").ge(givenDate)) .add(AuditEntity.id().eq(givenEntityId))) .getSingleResult();
minimize()
and maximize()
methods return a criteria, to which constraints can be added, which must be met by the entities with the maximized/minimized properties.
selectEntitiesOnly
- This parameter is only valid when an explicit projection is not set.If true, the result of the query will be a list of entities that changed at revisions satisfying the specified constraints.If false, the result will be a list of three element arrays. The first element will be the changed entity instance. The second will be an entity containing revision data. If no custom entity is used, this will be an instance of
DefaultRevisionEntity
. The third element array will be the type of the revision (ADD, MOD, DEL). selectDeletedEntities
- This parameter specifies if revisions in which the entity was deleted must be included in the results. If true, the entities will have the revision type
DEL
, and all fields, except id, will have the valuenull
.
Example 2.6. Query Revisions of an Entity that Modified a Given Property
MyEntity
with a given id, where the actualDate
property has been changed.
AuditQuery query = getAuditReader().createQuery() .forRevisionsOfEntity(MyEntity.class, false, true) .add(AuditEntity.id().eq(id)); .add(AuditEntity.property("actualDate").hasChanged())
hasChanged
condition can be combined with additional criteria. The query below will return a horizontal slice for MyEntity
at the time the revisionNumber was generated. It will be limited to the revisions that modified prop1
, but not prop2
.
AuditQuery query = getAuditReader().createQuery() .forEntitiesAtRevision(MyEntity.class, revisionNumber) .add(AuditEntity.property("prop1").hasChanged()) .add(AuditEntity.property("prop2").hasNotChanged());
MyEntities
changed in revisionNumber with prop1
modified and prop2
untouched."
forEntitiesModifiedAtRevision
query:
AuditQuery query = getAuditReader().createQuery() .forEntitiesModifiedAtRevision(MyEntity.class, revisionNumber) .add(AuditEntity.property("prop1").hasChanged()) .add(AuditEntity.property("prop2").hasNotChanged());
Example 2.7. Query Entities Modified in a Given Revision
Set<Pair<String, Class>> modifiedEntityTypes = getAuditReader() .getCrossTypeRevisionChangesReader().findEntityTypes(revisionNumber);
org.hibernate.envers.CrossTypeRevisionChangesReader
:
List<Object> findEntities(Number)
- Returns snapshots of all audited entities changed (added, updated and removed) in a given revision. Executes
n+1
SQL queries, wheren
is a number of different entity classes modified within the specified revision. List<Object> findEntities(Number, RevisionType)
- Returns snapshots of all audited entities changed (added, updated or removed) in a given revision filtered by modification type. Executes
n+1
SQL queries, wheren
is a number of different entity classes modified within specified revision. Map<RevisionType, List<Object>> findEntitiesGroupByRevisionType(Number)
- Returns a map containing lists of entity snapshots grouped by modification operation (e.g. addition, update and removal). Executes
3n+1
SQL queries, wheren
is a number of different entity classes modified within specified revision.
Chapter 3. Hibernate Architecture
3.1. Overview



- SessionFactory (
org.hibernate.SessionFactory
) - A threadsafe, immutable cache of compiled mappings for a single database. A factory for
Session
and a client ofConnectionProvider
,SessionFactory
can hold an optional (second-level) cache of data that is reusable between transactions at a process, or cluster, level. - Session (
org.hibernate.Session
) - A single-threaded, short-lived object representing a conversation between the application and the persistent store. It wraps a JDBC connection and is a factory for
Transaction
.Session
holds a mandatory first-level cache of persistent objects that are used when navigating the object graph or looking up objects by identifier. - Persistent objects and collections
- Short-lived, single threaded objects containing persistent state and business function. These can be ordinary JavaBeans/POJOs. They are associated with exactly one
Session
. Once theSession
is closed, they will be detached and free to use in any application layer (for example, directly as data transfer objects to and from presentation). - Transient and detached objects and collections
- Instances of persistent classes that are not currently associated with a
Session
. They may have been instantiated by the application and not yet persisted, or they may have been instantiated by a closedSession
. - Transaction (
org.hibernate.Transaction
) - (Optional) A single-threaded, short-lived object used by the application to specify atomic units of work. It abstracts the application from the underlying JDBC, JTA or CORBA transaction. A
Session
might span severalTransaction
s in some cases. However, transaction demarcation, either using the underlying API orTransaction
, is never optional. - ConnectionProvider (
org.hibernate.connection.ConnectionProvider
) - (Optional) A factory for, and pool of, JDBC connections. It abstracts the application from underlying
Datasource
orDriverManager
. It is not exposed to application, but it can be extended and/or implemented by the developer. - TransactionFactory (
org.hibernate.TransactionFactory
) - (Optional) A factory for
Transaction
instances. It is not exposed to the application, but it can be extended and/or implemented by the developer. - Extension Interfaces
- Hibernate offers a range of optional extension interfaces you can implement to customize the behavior of your persistence layer. See the API documentation for details.
Transaction
/TransactionFactory
and/or ConnectionProvider
APIs to communicate with JTA or JDBC directly.
3.2. Instance States
Session
object is the persistence context. The three different states are as follows:
- transient
- The instance is not associated with any persistence context. It has no persistent identity or primary key value.
- persistent
- The instance is currently associated with a persistence context. It has a persistent identity (primary key value) and can have a corresponding row in the database. For a particular persistence context, Hibernate guarantees that persistent identity is equivalent to Java identity in relation to the in-memory location of the object.
- detached
- The instance was once associated with a persistence context, but that context was closed, or the instance was serialized to another process. It has a persistent identity and can have a corresponding row in the database. For detached instances, Hibernate does not guarantee the relationship between persistent identity and Java identity.
3.3. JMX Integration
org.hibernate.jmx.HibernateService
.
- Session Management: the Hibernate
Session
's life cycle can be automatically bound to the scope of a JTA transaction. This means that you no longer have to manually open and close theSession
; this becomes the job of a JBoss EJB interceptor. You also do not have to worry about transaction demarcation in your code (if you would like to write a portable persistence layer use the optional HibernateTransaction
API for this). You call theHibernateContext
to access aSession
. - HAR deployment: the Hibernate JMX service is deployed using a JBoss service deployment descriptor in an EAR and/or SAR file, as it supports all the usual configuration options of a Hibernate
SessionFactory
. However, you still need to name all your mapping files in the deployment descriptor. If you use the optional HAR deployment, JBoss will automatically detect all mapping files in your HAR file.
3.4. JCA Support
3.5. Contextual Sessions
ThreadLocal
-based contextual sessions, helper classes such as HibernateUtil
, or utilized third-party frameworks, such as Spring or Pico, which provided proxy/interception-based contextual sessions.
SessionFactory.getCurrentSession()
method. Initially, this assumed usage of JTA
transactions, where the JTA
transaction defined both the scope and context of a current session. Given the maturity of the numerous stand-alone JTA TransactionManager
implementations, most, if not all, applications should be using JTA
transaction management, whether or not they are deployed into a J2EE
container. Based on that, the JTA
-based contextual sessions are all you need to use.
SessionFactory.getCurrentSession()
is now pluggable. To that end, a new extension interface, org.hibernate.context.CurrentSessionContext
, and a new configuration parameter, hibernate.current_session_context_class
, have been added to allow pluggability of the scope and context of defining current sessions.
org.hibernate.context.CurrentSessionContext
interface for a detailed discussion of its contract. It defines a single method, currentSession()
, by which the implementation is responsible for tracking the current contextual session. Out-of-the-box, Hibernate comes with three implementations of this interface:
org.hibernate.context.JTASessionContext
: current sessions are tracked and scoped by aJTA
transaction. The processing here is exactly the same as in the older JTA-only approach. See the Javadocs for details.org.hibernate.context.ThreadLocalSessionContext
:current sessions are tracked by thread of execution. See the Javadocs for details.org.hibernate.context.ManagedSessionContext
: current sessions are tracked by thread of execution. However, you are responsible to bind and unbind aSession
instance with static methods on this class: it does not open, flush, or close aSession
.
Transaction
API to hide the underlying transaction system from your code. If you use JTA, you can utilize the JTA interfaces to demarcate transactions. If you execute in an EJB container that supports CMT, transaction boundaries are defined declaratively and you do not need any transaction or session demarcation operations in your code. Refer to Chapter 11, Transactions and Concurrency for more information and code examples.
hibernate.current_session_context_class
configuration parameter defines which org.hibernate.context.CurrentSessionContext
implementation should be used. For backwards compatibility, if this configuration parameter is not set but a org.hibernate.transaction.TransactionManagerLookup
is configured, Hibernate will use the org.hibernate.context.JTASessionContext
. Typically, the value of this parameter would just name the implementation class to use. For the three out-of-the-box implementations, however, there are three corresponding short names: "jta", "thread", and "managed".
Chapter 4. Persistent Classes
4.1. About Persistent Classes
Map
instances, for example).
4.2. POJO Example
4.2.1. A Simple POJO Example
package eg; import java.util.Set; import java.util.Date; public class Cat { private Long id; // identifier private Date birthdate; private Color color; private char sex; private float weight; private int litterId; private Cat mother; private Set kittens = new HashSet(); private void setId(Long id) { this.id=id; } public Long getId() { return id; } void setBirthdate(Date date) { birthdate = date; } public Date getBirthdate() { return birthdate; } void setWeight(float weight) { this.weight = weight; } public float getWeight() { return weight; } public Color getColor() { return color; } void setColor(Color color) { this.color = color; } void setSex(char sex) { this.sex=sex; } public char getSex() { return sex; } void setLitterId(int id) { this.litterId = id; } public int getLitterId() { return litterId; } void setMother(Cat mother) { this.mother = mother; } public Cat getMother() { return mother; } void setKittens(Set kittens) { this.kittens = kittens; } public Set getKittens() { return kittens; } // addKitten not needed by Hibernate public void addKitten(Cat kitten) { kitten.setMother(this); kitten.setLitterId( kittens.size() ); kittens.add(kitten); } }
4.2.2. Implement a No-argument Constructor
Cat
has a no-argument constructor. All persistent classes must have a default constructor (which can be non-public) so that Hibernate can instantiate them using Constructor.newInstance()
. It is recommended that you have a default constructor with at least package visibility for runtime proxy generation in Hibernate.
4.2.3. Provide an Optional Identifier Property
Cat
has a property called id
. This property maps to the primary key column of a database table. The property might have been called anything, and its type might have been any primitive type, any primitive "wrapper" type, java.lang.String
or java.util.Date
. If your legacy database table has composite keys, you can use a user-defined class with properties of these types (see the section on composite identifiers later in the chapter.)
- Transitive reattachment for detached objects (cascade update or cascade merge).
Session.saveOrUpdate()
Session.merge()
4.2.4. Prefer Optional Non-final Classes
final
classes that do not implement an interface with Hibernate. You will not, however, be able to use proxies for lazy association fetching which will ultimately limit your options for performance tuning.
public final
methods on the non-final classes. If you want to use a class with a public final
method, you must explicitly disable proxying by setting lazy="false"
.
4.2.5. Declare Optional Accessors and Mutators for Persistent Fields
Cat
declares accessor methods for all its persistent fields. Many other ORM tools directly persist instance variables. It is better to provide an indirection between the relational schema and internal data structures of the class. By default, Hibernate persists JavaBeans style properties and recognizes method names of the form getFoo
, isFoo
and setFoo
. If required, you can switch to direct field access for particular properties.
protected
or private
get / set pair.
4.3. Additional Information
4.3.1. Implementing Inheritance
Cat
. For example:
package eg; public class DomesticCat extends Cat { private String name; public String getName() { return name; } protected void setName(String name) { this.name=name; } }
4.3.2. Implementing equals() and hashCode()
equals()
and hashCode()
methods if you:
- intend to put instances of persistent classes in a
Set
(the recommended way to represent many-valued associations); and - intend to use reattachment of detached instances
equals()
and hashCode()
if you wish to have meaningful semantics for Set
s.
equals()
/hashCode()
by comparing the identifier value of both objects. If the value is the same, both must be the same database row, because they are equal. If both are added to a Set
, you will only have one element in the Set
). Unfortunately, you cannot use that approach with generated identifiers. Hibernate will only assign identifier values to objects that are persistent; a newly created instance will not have any identifier value. Furthermore, if an instance is unsaved and currently in a Set
, saving it will assign an identifier value to the object. If equals()
and hashCode()
are based on the identifier value, the hash code would change, breaking the contract of the Set
. See the Hibernate website for a full discussion of this problem. This is not a Hibernate issue, but normal Java semantics of object identity and equality.
equals()
and hashCode()
using Business key equality. Business key equality means that the equals()
method compares only the properties that form the business key. It is a key that would identify our instance in the real world (a natural candidate key):
public class Cat { ... public boolean equals(Object other) { if (this == other) return true; if ( !(other instanceof Cat) ) return false; final Cat cat = (Cat) other; if ( !cat.getLitterId().equals( getLitterId() ) ) return false; if ( !cat.getMother().equals( getMother() ) ) return false; return true; } public int hashCode() { int result; result = getMother().hashCode(); result = 29 * result + getLitterId(); return result; } }
4.3.3. Dynamic Models
Note
Map
s of Map
s at runtime) and the representation of entities as DOM4J trees. With this approach, you do not write persistent classes, only mapping files.
SessionFactory
using the default_entity_mode
configuration option.
Map
s. First, in the mapping file an entity-name
has to be declared instead of, or in addition to, a class name:
<hibernate-mapping> <class entity-name="Customer"> <id name="id" type="long" column="ID"> <generator class="sequence"/> </id> <property name="name" column="NAME" type="string"/> <property name="address" column="ADDRESS" type="string"/> <many-to-one name="organization" column="ORGANIZATION_ID" class="Organization"/> <bag name="orders" inverse="true" lazy="false" cascade="all"> <key column="CUSTOMER_ID"/> <one-to-many class="Order"/> </bag> </class> </hibernate-mapping>
dynamic-map
for the SessionFactory
, you can, at runtime, work with Map
s of Map
s:
Session s = openSession(); Transaction tx = s.beginTransaction(); // Create a customer Map david = new HashMap(); david.put("name", "David"); // Create an organization Map foobar = new HashMap(); foobar.put("name", "Foobar Inc."); // Link both david.put("organization", foobar); // Save both s.save("Customer", david); s.save("Organization", foobar); tx.commit(); s.close();
Session
basis:
Session dynamicSession = pojoSession.getSession(EntityMode.MAP); // Create a customer Map david = new HashMap(); david.put("name", "David"); dynamicSession.save("Customer", david); ... dynamicSession.flush(); dynamicSession.close(); ... // Continue on pojoSession
getSession()
using an EntityMode
is on the Session
API, not the SessionFactory
. That way, the new Session
shares the underlying JDBC connection, transaction, and other context information. This means you do not have to call flush()
and close()
on the secondary Session
, and also leave the transaction and connection handling to the primary unit of work.
4.3.4. Tuplizers
org.hibernate.tuple.Tuplizer
, and its sub-interfaces, are responsible for managing a particular representation of a piece of data given that representation's org.hibernate.EntityMode
. If a given piece of data is thought of as a data structure, then a tuplizer is the thing that knows how to create such a data structure and how to extract values from and inject values into such a data structure. For example, for the POJO entity mode, the corresponding tuplizer knows how create the POJO through its constructor. It also knows how to access the POJO properties using the defined property accessors.
org.hibernate.tuple.entity.EntityTuplizer
and org.hibernate.tuple.component.ComponentTuplizer
interfaces. EntityTuplizer
s are responsible for managing the above mentioned contracts in regards to entities, while ComponentTuplizer
s do the same for components.
java.util.Map
implementation other than java.util.HashMap
be used while in the dynamic-map entity-mode. Or perhaps you need to define a different proxy generation strategy than the one used by default. Both would be achieved by defining a custom tuplizer implementation. Tuplizer definitions are attached to the entity or component mapping they are meant to manage. Going back to the example of our customer entity:
<hibernate-mapping> <class entity-name="Customer"> <!-- Override the dynamic-map entity-mode tuplizer for the customer entity --> <tuplizer entity-mode="dynamic-map" class="CustomMapTuplizerImpl"/> <id name="id" type="long" column="ID"> <generator class="sequence"/> </id> <!-- other properties --> ... </class> </hibernate-mapping> public class CustomMapTuplizerImpl extends org.hibernate.tuple.entity.DynamicMapEntityTuplizer { // override the buildInstantiator() method to plug in our custom map... protected final Instantiator buildInstantiator( org.hibernate.mapping.PersistentClass mappingInfo) { return new CustomMapInstantiator( mappingInfo ); } private static final class CustomMapInstantiator extends org.hibernate.tuple.DynamicMapInstantitor { // override the generateMap() method to return our custom map... protected final Map generateMap() { return new CustomMap(); } } }
4.3.5. EntityNameResolvers
org.hibernate.EntityNameResolver
interface is a contract for resolving the entity name of a given entity instance. The interface defines a single method resolveEntityName
which is passed the entity instance and is expected to return the appropriate entity name (null is allowed and would indicate that the resolver does not know how to resolve the entity name of the given entity instance). Generally speaking, an org.hibernate.EntityNameResolver
is going to be most useful in the case of dynamic models. One example might be using proxied interfaces as your domain model. The hibernate test suite has an example of this exact style of usage under the org.hibernate.test.dynamicentity.tuplizer2. Here is some of the code from that package for illustration.
/** * A very trivial JDK Proxy InvocationHandler implementation where we proxy an interface as * the domain model and simply store persistent state in an internal Map. This is an extremely * trivial example meant only for illustration. */ public final class DataProxyHandler implements InvocationHandler { private String entityName; private HashMap data = new HashMap(); public DataProxyHandler(String entityName, Serializable id) { this.entityName = entityName; data.put( "Id", id ); } public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { String methodName = method.getName(); if ( methodName.startsWith( "set" ) ) { String propertyName = methodName.substring( 3 ); data.put( propertyName, args[0] ); } else if ( methodName.startsWith( "get" ) ) { String propertyName = methodName.substring( 3 ); return data.get( propertyName ); } else if ( "toString".equals( methodName ) ) { return entityName + "#" + data.get( "Id" ); } else if ( "hashCode".equals( methodName ) ) { return new Integer( this.hashCode() ); } return null; } public String getEntityName() { return entityName; } public HashMap getData() { return data; } } /** * */ public class ProxyHelper { public static String extractEntityName(Object object) { // Our custom java.lang.reflect.Proxy instances actually bundle // their appropriate entity name, so we simply extract it from there // if this represents one of our proxies; otherwise, we return null if ( Proxy.isProxyClass( object.getClass() ) ) { InvocationHandler handler = Proxy.getInvocationHandler( object ); if ( DataProxyHandler.class.isAssignableFrom( handler.getClass() ) ) { DataProxyHandler myHandler = ( DataProxyHandler ) handler; return myHandler.getEntityName(); } } return null; } // various other utility methods .... } /** * The EntityNameResolver implementation. * IMPL NOTE : An EntityNameResolver really defines a strategy for how entity names should be * resolved. Since this particular impl can handle resolution for all of our entities we want to * take advantage of the fact that SessionFactoryImpl keeps these in a Set so that we only ever * have one instance registered. Why? Well, when it comes time to resolve an entity name, * Hibernate must iterate over all the registered resolvers. So keeping that number down * helps that process be as speedy as possible. Hence the equals and hashCode impls */ public class MyEntityNameResolver implements EntityNameResolver { public static final MyEntityNameResolver INSTANCE = new MyEntityNameResolver(); public String resolveEntityName(Object entity) { return ProxyHelper.extractEntityName( entity ); } public boolean equals(Object obj) { return getClass().equals( obj.getClass() ); } public int hashCode() { return getClass().hashCode(); } } public class MyEntityTuplizer extends PojoEntityTuplizer { public MyEntityTuplizer(EntityMetamodel entityMetamodel, PersistentClass mappedEntity) { super( entityMetamodel, mappedEntity ); } public EntityNameResolver[] getEntityNameResolvers() { return new EntityNameResolver[] { MyEntityNameResolver.INSTANCE }; } public String determineConcreteSubclassEntityName(Object entityInstance, SessionFactoryImplementor factory) { String entityName = ProxyHelper.extractEntityName( entityInstance ); if ( entityName == null ) { entityName = super.determineConcreteSubclassEntityName( entityInstance, factory ); } return entityName; } ... }
org.hibernate.EntityNameResolver
users must either:
- Implement a custom tupilizer, implementing the
getEntityNameResolvers
method. - Register it with the
org.hibernate.impl.SessionFactoryImpl
(which is the implementation class fororg.hibernate.SessionFactory
) using theregisterEntityNameResolver
method.
Chapter 5. Basic O/R Mapping
5.1. Mapping Declaration
5.1.1. About Mapping Declaration
<?xml version="1.0"?> <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> <hibernate-mapping package="eg"> <class name="Cat" table="cats" discriminator-value="C"> <id name="id"> <generator class="native"/> </id> <discriminator column="subclass" type="character"/> <property name="weight"/> <property name="birthdate" type="date" not-null="true" update="false"/> <property name="color" type="eg.types.ColorUserType" not-null="true" update="false"/> <property name="sex" not-null="true" update="false"/> <property name="litterId" column="litterId" update="false"/> <many-to-one name="mother" column="mother_id" update="false"/> <set name="kittens" inverse="true" order-by="litter_id"> <key column="mother_id"/> <one-to-many class="Cat"/> </set> <subclass name="DomesticCat" discriminator-value="D"> <property name="name" type="string"/> </subclass> </class> <class name="Dog"> <!-- mapping for Dog could go here --> </class> </hibernate-mapping>
not-null
attribute).
5.1.2. Doctype
hibernate-x.x.x/src/org/hibernate
, or in hibernate3.jar
. Hibernate will always look for the DTD in its classpath first. If you experience lookups of the DTD using an Internet connection, check the DTD declaration against the contents of your classpath.
5.1.3. EntityResolver
org.xml.sax.EntityResolver
implementation with the SAXReader it uses to read in the xml files. This custom EntityResolver
recognizes two different systemId namespaces:
- a
hibernate namespace
is recognized whenever the resolver encounters a systemId starting withhttp://hibernate.sourceforge.net/
. The resolver attempts to resolve these entities via the classloader which loaded the Hibernate classes. - a
user namespace
is recognized whenever the resolver encounters a systemId using aclasspath://
URL protocol. The resolver will attempt to resolve these entities via (1) the current thread context classloader and (2) the classloader which loaded the Hibernate classes.
<?xml version="1.0"?> <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" [ <!ENTITY types SYSTEM "classpath://your/domain/types.xml"> ]> <hibernate-mapping package="your.domain"> <class name="MyEntity"> <id name="id" type="my-custom-id-type"> ... </id> <class> &types; </hibernate-mapping>
types.xml
is a resource in the your.domain
package and contains a custom mapping type.
5.1.4. Hibernate-mapping
schema
and catalog
attributes specify that tables referred to in this mapping belong to the named schema and/or catalog. If they are specified, tablenames will be qualified by the given schema and catalog names. If they are missing, tablenames will be unqualified. The default-cascade
attribute specifies what cascade style should be assumed for properties and collections that do not specify a cascade
attribute. By default, the auto-import
attribute allows you to use unqualified class names in the query language.
<hibernate-mapping schema="schemaName" catalog="catalogName" default-cascade="cascade_style" default-access="field|property|ClassName" default-lazy="true|false" auto-import="true|false" package="package.name" />
schema
(optional): the name of a database schema.
catalog
(optional): the name of a database catalog.
default-cascade
(optional - defaults to none
): a default cascade style.
default-access
(optional - defaults to property
): the strategy Hibernate should use for accessing all properties. It can be a custom implementation of PropertyAccessor
.
default-lazy
(optional - defaults to true
): the default value for unspecified lazy
attributes of class and collection mappings.
auto-import
(optional - defaults to true
): specifies whether we can use unqualified class names of classes in this mapping in the query language.
package
(optional): specifies a package prefix to use for unqualified class names in the mapping document.
auto-import="false"
. An exception will result if you attempt to assign two classes to the same "imported" name.
hibernate-mapping
element allows you to nest several persistent <class>
mappings, as shown above. It is, however, good practice (and expected by some tools) to map only a single persistent class, or a single class hierarchy, in one mapping file and name it after the persistent superclass. For example, Cat.hbm.xml
, Dog.hbm.xml
, or if using inheritance, Animal.hbm.xml
.
5.1.5. Class
class
element. For example:
<class name="ClassName" table="tableName" discriminator-value="discriminator_value" mutable="true|false" schema="owner" catalog="catalog" proxy="ProxyInterface" dynamic-update="true|false" dynamic-insert="true|false" select-before-update="true|false" polymorphism="implicit|explicit" where="arbitrary sql where condition" persister="PersisterClass" batch-size="N" optimistic-lock="none|version|dirty|all" lazy="true|false" entity-name="EntityName" check="arbitrary sql check condition" rowid="rowid" subselect="SQL expression" abstract="true|false" node="element-name" />
name
(optional): the fully qualified Java class name of the persistent class or interface. If this attribute is missing, it is assumed that the mapping is for a non-POJO entity.
table
(optional - defaults to the unqualified class name): the name of its database table.
discriminator-value
(optional - defaults to the class name): a value that distinguishes individual subclasses that is used for polymorphic behavior. Acceptable values include null
and not null
.
mutable
(optional - defaults to true
): specifies that instances of the class are (not) mutable.
schema
(optional): overrides the schema name specified by the root <hibernate-mapping>
element.
catalog
(optional): overrides the catalog name specified by the root <hibernate-mapping>
element.
proxy
(optional): specifies an interface to use for lazy initializing proxies. You can specify the name of the class itself.
dynamic-update
(optional - defaults to false
): specifies that UPDATE
SQL should be generated at runtime and can contain only those columns whose values have changed.
dynamic-insert
(optional - defaults to false
): specifies that INSERT
SQL should be generated at runtime and contain only the columns whose values are not null.
select-before-update
(optional - defaults to false
): specifies that Hibernate should never perform an SQL UPDATE
unless it is certain that an object is actually modified. Only when a transient object has been associated with a new session using update()
, will Hibernate perform an extra SQL SELECT
to determine if an UPDATE
is actually required.
polymorphism
(optional - defaults to implicit
): determines whether implicit or explicit query polymorphism is used.
where
(optional): specifies an arbitrary SQL WHERE
condition to be used when retrieving objects of this class.
persister
(optional): specifies a custom ClassPersister
.
batch-size
(optional - defaults to 1
): specifies a "batch size" for fetching instances of this class by identifier.
optimistic-lock
(optional - defaults to version
): determines the optimistic locking strategy.
lazy
(optional): lazy fetching can be disabled by setting lazy="false"
.
entity-name
(optional - defaults to the class name): Hibernate3 allows a class to be mapped multiple times, potentially to different tables. It also allows entity mappings that are represented by Maps or XML at the Java level. In these cases, you should provide an explicit arbitrary name for the entity.
check
(optional): an SQL expression used to generate a multi-row check constraint for automatic schema generation.
rowid
(optional): Hibernate can use ROWIDs on databases. On Oracle, for example, Hibernate can use the rowid
extra column for fast updates once this option has been set to rowid
. A ROWID is an implementation detail and represents the physical location of a stored tuple.
subselect
(optional): maps an immutable and read-only entity to a database subselect. This is useful if you want to have a view instead of a base table. See below for more information.
abstract
(optional): is used to mark abstract superclasses in <union-subclass>
hierarchies.
<subclass>
element. You can persist any static inner class. Specify the class name using the standard form i.e. e.g.Foo$Bar
.
mutable="false"
, cannot be updated or deleted by the application. This allows Hibernate to make some minor performance optimizations.
proxy
attribute enables lazy initialization of persistent instances of the class. Hibernate will initially return CGLIB proxies that implement the named interface. The persistent object will load when a method of the proxy is invoked. See "Initializing collections and proxies" below.
<class>
declaration as a <subclass>
or <joined-subclass>
. For most purposes, the default polymorphism="implicit"
is appropriate. Explicit polymorphism is useful when two different classes are mapped to the same table This allows a "lightweight" class that contains a subset of the table columns.
persister
attribute lets you customize the persistence strategy used for the class. You can, for example, specify your own subclass of org.hibernate.persister.EntityPersister
, or you can even provide a completely new implementation of the interface org.hibernate.persister.ClassPersister
that implements, for example, persistence via stored procedure calls, serialization to flat files or LDAP. See org.hibernate.test.CustomPersister
for a simple example of "persistence" to a Hashtable
.
dynamic-update
and dynamic-insert
settings are not inherited by subclasses, so they can also be specified on the <subclass>
or <joined-subclass>
elements. Although these settings can increase performance in some cases, they can actually decrease performance in others.
select-before-update
will usually decrease performance. It is useful to prevent a database update trigger being called unnecessarily if you reattach a graph of detached instances to a Session
.
dynamic-update
, you will have a choice of optimistic locking strategies:
version
: check the version/timestamp columnsall
: check all columnsdirty
: check the changed columns, allowing some concurrent updatesnone
: do not use optimistic locking
Session.merge()
is used).
<class name="Summary"> <subselect> select item.name, max(bid.amount), count(*) from item join bid on bid.item_id = item.id group by item.name </subselect> <synchronize table="item"/> <synchronize table="bid"/> <id name="name"/> ... </class>
<subselect>
is available both as an attribute and a nested mapping element.
5.1.6. id
<id>
element defines the mapping from that property to the primary key column.
<id name="propertyName" type="typename" column="column_name" unsaved-value="null|any|none|undefined|id_value" access="field|property|ClassName"> node="element-name|@attribute-name|element/@attribute|." <generator class="generatorClass"/> </id>
name
(optional): the name of the identifier property.
type
(optional): a name that indicates the Hibernate type.
column
(optional - defaults to the property name): the name of the primary key column.
unsaved-value
(optional - defaults to a "sensible" value): an identifier property value that indicates an instance is newly instantiated (unsaved), distinguishing it from detached instances that were saved or loaded in a previous session.
access
(optional - defaults to property
): the strategy Hibernate should use for accessing the property value.
name
attribute is missing, it is assumed that the class has no identifier property.
unsaved-value
attribute is almost never needed in Hibernate3.
<composite-id>
declaration that allows access to legacy data with composite keys. Its use is strongly discouraged for anything else.
5.1.7. Generator
<generator>
child element names a Java class used to generate unique identifiers for instances of the persistent class. If any parameters are required to configure or initialize the generator instance, they are passed using the <param>
element.
<id name="id" type="long" column="cat_id"> <generator class="org.hibernate.id.TableHiLoGenerator"> <param name="table">uid_table</param> <param name="column">next_hi_value_column</param> </generator> </id>
org.hibernate.id.IdentifierGenerator
. This is a very simple interface. Some applications can choose to provide their own specialized implementations, however, Hibernate provides a range of built-in implementations. The shortcut names for the built-in generators are as follows:
increment
- generates identifiers of type
long
,short
orint
that are unique only when no other process is inserting data into the same table. Do not use in a cluster. identity
- supports identity columns in DB2, MySQL, MS SQL Server, Sybase and HypersonicSQL. The returned identifier is of type
long
,short
orint
. sequence
- uses a sequence in DB2, PostgreSQL, Oracle, SAP DB, McKoi or a generator in Interbase. The returned identifier is of type
long
,short
orint
hilo
- uses a hi/lo algorithm to efficiently generate identifiers of type
long
,short
orint
, given a table and column (by defaulthibernate_unique_key
andnext_hi
respectively) as a source of hi values. The hi/lo algorithm generates identifiers that are unique only for a particular database. seqhilo
- uses a hi/lo algorithm to efficiently generate identifiers of type
long
,short
orint
, given a named database sequence. uuid
- uses a 128-bit UUID algorithm to generate identifiers of type string that are unique within a network (the IP address is used). The UUID is encoded as a string of 32 hexadecimal digits in length.
guid
- uses a database-generated GUID string on MS SQL Server and MySQL.
native
- selects
identity
,sequence
orhilo
depending upon the capabilities of the underlying database. assigned
- lets the application assign an identifier to the object before
save()
is called. This is the default strategy if no<generator>
element is specified. select
- retrieves a primary key, assigned by a database trigger, by selecting the row by some unique key and retrieving the primary key value.
foreign
- uses the identifier of another associated object. It is usually used in conjunction with a
<one-to-one>
primary key association. sequence-identity
- a specialized sequence generation strategy that utilizes a database sequence for the actual value generation, but combines this with JDBC3 getGeneratedKeys to return the generated identifier value as part of the insert statement execution. This strategy is only supported on Oracle 10g drivers targeted for JDK 1.4. Comments on these insert statements are disabled due to a bug in the Oracle drivers.
5.1.8. Hi/Lo Algorithm
hilo
and seqhilo
generators provide two alternate implementations of the hi/lo algorithm. The first implementation requires a "special" database table to hold the next available "hi" value. Where supported, the second uses an Oracle-style sequence.
<id name="id" type="long" column="cat_id"> <generator class="hilo"> <param name="table">hi_value</param> <param name="column">next_value</param> <param name="max_lo">100</param> </generator> </id>
<id name="id" type="long" column="cat_id"> <generator class="seqhilo"> <param name="sequence">hi_value</param> <param name="max_lo">100</param> </generator> </id>
hilo
when supplying your own Connection
to Hibernate. When Hibernate uses an application server datasource to obtain connections enlisted with JTA, you must configure the hibernate.transaction.manager_lookup_class
.
5.1.9. UUID Algorithm
5.1.10. Identity Columns and Sequences
identity
key generation. For databases that support sequences (DB2, Oracle, PostgreSQL, Interbase, McKoi, SAP DB) you can use sequence
style key generation. Both of these strategies require two SQL queries to insert a new object. For example:
<id name="id" type="long" column="person_id"> <generator class="sequence"> <param name="sequence">person_id_sequence</param> </generator> </id>
<id name="id" type="long" column="person_id" unsaved-value="0"> <generator class="identity"/> </id>
native
strategy will, depending on the capabilities of the underlying database, choose from the identity
, sequence
and hilo
strategies.
5.1.11. Assigned Identifiers
assigned
generator. This special generator uses the identifier value already assigned to the object's identifier property. The generator is used when the primary key is a natural key instead of a surrogate key. This is the default behavior if you do not specify a <generator>
element.
assigned
generator makes Hibernate use unsaved-value="undefined"
. This forces Hibernate to go to the database to determine if an instance is transient or detached, unless there is a version or timestamp property, or you define Interceptor.isUnsaved()
.
5.1.12. Primary Keys Assigned by Triggers
<id name="id" type="long" column="person_id"> <generator class="select"> <param name="key">socialSecurityNumber</param> </generator> </id>
socialSecurityNumber
. It is defined by the class, as a natural key and a surrogate key named person_id
, whose value is generated by a trigger.
5.1.13. Enhanced Identifier Generators
org.hibernate.id.enhanced.SequenceStyleGenerator
which is intended, firstly, as a replacement for the sequence
generator and, secondly, as a better portability generator than native
. This is because native
generally chooses between identity
and sequence
which have largely different semantics that can cause subtle issues in applications eyeing portability. org.hibernate.id.enhanced.SequenceStyleGenerator
, however, achieves portability in a different manner. It chooses between a table or a sequence in the database to store its incrementing values, depending on the capabilities of the dialect being used. The difference between this and native
is that table-based and sequence-based storage have the same exact semantic. In fact, sequences are exactly what Hibernate tries to emulate with its table-based generators. This generator has a number of configuration parameters:
sequence_name
(optional, defaults tohibernate_sequence
): the name of the sequence or table to be used.initial_value
(optional, defaults to1
): the initial value to be retrieved from the sequence/table. In sequence creation terms, this is analogous to the clause typically named "STARTS WITH".increment_size
(optional - defaults to1
): the value by which subsequent calls to the sequence/table should differ. In sequence creation terms, this is analogous to the clause typically named "INCREMENT BY".force_table_use
(optional - defaults tofalse
): should we force the use of a table as the backing structure even though the dialect might support sequence?value_column
(optional - defaults tonext_val
): only relevant for table structures, it is the name of the column on the table which is used to hold the value.optimizer
(optional - defaults tonone
).
org.hibernate.id.enhanced.TableGenerator
, which is intended, firstly, as a replacement for the table
generator, even though it actually functions much more like org.hibernate.id.MultipleHiLoPerTableGenerator
, and secondly, as a re-implementation of org.hibernate.id.MultipleHiLoPerTableGenerator
that utilizes the notion of pluggable optimizers. Essentially this generator defines a table capable of holding a number of different increment values simultaneously by using multiple distinctly keyed rows. This generator has a number of configuration parameters:
table_name
(optional - defaults tohibernate_sequences
): the name of the table to be used.value_column_name
(optional - defaults tonext_val
): the name of the column on the table that is used to hold the value.segment_column_name
(optional - defaults tosequence_name
): the name of the column on the table that is used to hold the "segment key". This is the value which identifies which increment value to use.segment_value
(optional - defaults todefault
): The "segment key" value for the segment from which we want to pull increment values for this generator.segment_value_length
(optional - defaults to255
): Used for schema generation; the column size to create this segment key column.initial_value
(optional - defaults to1
): The initial value to be retrieved from the table.increment_size
(optional - defaults to1
): The value by which subsequent calls to the table should differ.optimizer
(optional - defaults to): Refer to Section 5.1.14, “Identifier Generator Optimization” for further information.
5.1.14. Identifier Generator Optimization
none
(generally this is the default if no optimizer was specified): this will not perform any optimizations and hit the database for each and every request.hilo
: applies a hi/lo algorithm around the database retrieved values. The values from the database for this optimizer are expected to be sequential. The values retrieved from the database structure for this optimizer indicates the "group number". Theincrement_size
is multiplied by that value in memory to define a group "hi value".pooled
: as with the case ofhilo
, this optimizer attempts to minimize the number of hits to the database. Here, however, we simply store the starting value for the "next group" into the database structure rather than a sequential value in combination with an in-memory grouping algorithm. Here,increment_size
refers to the values coming from the database.
5.1.15. composite-id
<composite-id name="propertyName" class="ClassName" mapped="true|false" access="field|property|ClassName"> node="element-name|." <key-property name="propertyName" type="typename" column="column_name"/> <key-many-to-one name="propertyName class="ClassName" column="column_name"/> ...... </composite-id>
<composite-id>
element accepts <key-property>
property mappings and <key-many-to-one>
mappings as child elements.
<composite-id> <key-property name="medicareNumber"/> <key-property name="dependent"/> </composite-id>
equals()
and hashCode()
to implement composite identifier equality. It must also implement Serializable
.
load()
the persistent state associated with a composite key. We call this approach an embedded composite identifier, and discourage it for serious applications.
<composite-id>
element are duplicated on both the persistent class and a separate identifier class.
<composite-id class="MedicareId" mapped="true"> <key-property name="medicareNumber"/> <key-property name="dependent"/> </composite-id>
MedicareId
, and the entity class itself have properties named medicareNumber
and dependent
. The identifier class must override equals()
and hashCode()
and implement Serializable
. The main disadvantage of this approach is code duplication.
mapped
(optional - defaults tofalse
): indicates that a mapped composite identifier is used, and that the contained property mappings refer to both the entity class and the composite identifier class.class
(optional - but required for a mapped composite identifier): the class used as a composite identifier.
name
(optional - required for this approach): a property of component type that holds the composite identifier. Please see chapter 9 for more information.access
(optional - defaults toproperty
): the strategy Hibernate uses for accessing the property value.class
(optional - defaults to the property type determined by reflection): the component class used as a composite identifier. Please see the next section for more information.
5.1.16. Discriminator
<discriminator>
element is required for polymorphic persistence using the table-per-class-hierarchy mapping strategy. It declares a discriminator column of the table. The discriminator column contains marker values that tell the persistence layer what subclass to instantiate for a particular row. A restricted set of types can be used: string
, character
, integer
, byte
, short
, boolean
, yes_no
, true_false
.
<discriminator column="discriminator_column" type="discriminator_type" force="true|false" insert="true|false" formula="arbitrary sql expression" />
column
(optional - defaults to class
): the name of the discriminator column.
type
(optional - defaults to string
): a name that indicates the Hibernate type
force
(optional - defaults to false
): "forces" Hibernate to specify the allowed discriminator values, even when retrieving all instances of the root class.
insert
(optional - defaults to true
): set this to false
if your discriminator column is also part of a mapped composite identifier. It tells Hibernate not to include the column in SQL INSERTs
.
formula
(optional): an arbitrary SQL expression that is executed when a type has to be evaluated. It allows content-based discrimination.
discriminator-value
attribute of the <class>
and <subclass>
elements.
force
attribute is only useful if the table contains rows with "extra" discriminator values that are not mapped to a persistent class. This will not usually be the case.
formula
attribute allows you to declare an arbitrary SQL expression that will be used to evaluate the type of a row. For example:
<discriminator formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end" type="integer"/>
5.1.17. Version (optional)
<version>
element is optional and indicates that the table contains versioned data. This is particularly useful if you plan to use long transactions. See below for more information:
<version column="version_column" name="propertyName" type="typename" access="field|property|ClassName" unsaved-value="null|negative|undefined" generated="never|always" insert="true|false" node="element-name|@attribute-name|element/@attribute|." />
column
(optional - defaults to the property name): the name of the column holding the version number.
name
: the name of a property of the persistent class.
type
(optional - defaults to integer
): the type of the version number.
access
(optional - defaults to property
): the strategy Hibernate uses to access the property value.
unsaved-value
(optional - defaults to undefined
): a version property value that indicates that an instance is newly instantiated (unsaved), distinguishing it from detached instances that were saved or loaded in a previous session. Undefined
specifies that the identifier property value should be used.
generated
(optional - defaults to never
): specifies that this version property value is generated by the database. See the discussion of generated properties for more information.
insert
(optional - defaults to true
): specifies whether the version column should be included in SQL insert statements. It can be set to false
if the database column is defined with a default value of 0
.
long
, integer
, short
, timestamp
or calendar
.
unsaved-value
strategies are specified. Declaring a nullable version or timestamp property is an easy way to avoid problems with transitive reattachment in Hibernate. It is especially useful for people using assigned identifiers or composite keys.
5.1.18. Timestamp (optional)
<timestamp>
element indicates that the table contains timestamped data. This provides an alternative to versioning. Timestamps are a less safe implementation of optimistic locking. However, sometimes the application might use the timestamps in other ways.
<timestamp column="timestamp_column" name="propertyName" access="field|property|ClassName" unsaved-value="null|undefined" source="vm|db" generated="never|always" node="element-name|@attribute-name|element/@attribute|." />
column
(optional - defaults to the property name): the name of a column holding the timestamp.
name
: the name of a JavaBeans style property of Java type Date
or Timestamp
of the persistent class.
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the property value.
unsaved-value
(optional - defaults to null
): a version property value that indicates that an instance is newly instantiated (unsaved), distinguishing it from detached instances that were saved or loaded in a previous session. Undefined
specifies that the identifier property value should be used.
source
(optional - defaults to vm
): Where should Hibernate retrieve the timestamp value from? From the database, or from the current JVM? Database-based timestamps incur an overhead because Hibernate must hit the database in order to determine the "next value". It is safer to use in clustered environments. Not all Dialects
are known to support the retrieval of the database's current timestamp. Others may also be unsafe for usage in locking due to lack of precision (Oracle 8, for example).
generated
(optional - defaults to never
): specifies that this timestamp property value is actually generated by the database.
Note
<Timestamp>
is equivalent to <version type="timestamp">
. And <timestamp source="db">
is equivalent to <version type="dbtimestamp">
5.1.19. Property
<property>
element declares a persistent JavaBean style property of the class.
<property name="propertyName" column="column_name" type="typename" update="true|false" insert="true|false" formula="arbitrary SQL expression" access="field|property|ClassName" lazy="true|false" unique="true|false" not-null="true|false" optimistic-lock="true|false" generated="never|insert|always" node="element-name|@attribute-name|element/@attribute|." index="index_name" unique_key="unique_key_id" length="L" precision="P" scale="S" />
name
: the name of the property, with an initial lowercase letter.
column
(optional - defaults to the property name): the name of the mapped database table column. This can also be specified by nested <column>
element(s).
type
(optional): a name that indicates the Hibernate type.
update, insert
(optional - defaults to true
): specifies that the mapped columns should be included in SQL UPDATE
and/or INSERT
statements. Setting both to false
allows a pure "derived" property whose value is initialized from some other property that maps to the same column(s), or by a trigger or other application.
formula
(optional): an SQL expression that defines the value for a computed property. Computed properties do not have a column mapping of their own.
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the property value.
lazy
(optional - defaults to false
): specifies that this property should be fetched lazily when the instance variable is first accessed. It requires build-time bytecode instrumentation.
unique
(optional): enables the DDL generation of a unique constraint for the columns. Also, allow this to be the target of a property-ref
.
not-null
(optional): enables the DDL generation of a nullability constraint for the columns.
optimistic-lock
(optional - defaults to true
): specifies that updates to this property do or do not require acquisition of the optimistic lock. In other words, it determines if a version increment should occur when this property is dirty.
generated
(optional - defaults to never
): specifies that this property value is actually generated by the database.
- The name of a Hibernate basic type:
integer, string, character, date, timestamp, float, binary, serializable, object, blob
etc. - The name of a Java class with a default basic type:
int, float, char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob
etc. - The name of a serializable Java class.
- The class name of a custom type:
com.illflow.type.MyCustomType
etc.
type
attribute. For example, to distinguish between Hibernate.DATE
and Hibernate.TIMESTAMP
, or to specify a custom type.
access
attribute allows you to control how Hibernate accesses the property at runtime. By default, Hibernate will call the property get/set pair. If you specify access="field"
, Hibernate will bypass the get/set pair and access the field directly using reflection. You can specify your own strategy for property access by naming a class that implements the interface org.hibernate.property.PropertyAccessor
.
SELECT
clause subquery in the SQL query that loads an instance:
<property name="totalPrice" formula="( SELECT SUM (li.quantity*p.price) FROM LineItem li, Product p WHERE li.productId = p.productId AND li.customerId = customerId AND li.orderNumber = orderNumber )"/>
customerId
in the given example. You can also use the nested <formula>
mapping element if you do not want to use the attribute.
5.1.20. Many-to-one
many-to-one
element. The relational model is a many-to-one association; a foreign key in one table is referencing the primary key column(s) of the target table.
<many-to-one name="propertyName" column="column_name" class="ClassName" cascade="cascade_style" fetch="join|select" update="true|false" insert="true|false" property-ref="propertyNameFromAssociatedClass" access="field|property|ClassName" unique="true|false" not-null="true|false" optimistic-lock="true|false" lazy="proxy|no-proxy|false" not-found="ignore|exception" entity-name="EntityName" formula="arbitrary SQL expression" node="element-name|@attribute-name|element/@attribute|." embed-xml="true|false" index="index_name" unique_key="unique_key_id" foreign-key="foreign_key_name" />
name
: the name of the property.
column
(optional): the name of the foreign key column. This can also be specified by nested <column>
element(s).
class
(optional - defaults to the property type determined by reflection): the name of the associated class.
cascade
(optional): specifies which operations should be cascaded from the parent object to the associated object.
fetch
(optional - defaults to select
): chooses between outer-join fetching or sequential select fetching.
update, insert
(optional - defaults to true
): specifies that the mapped columns should be included in SQL UPDATE
and/or INSERT
statements. Setting both to false
allows a pure "derived" association whose value is initialized from another property that maps to the same column(s), or by a trigger or other application.
property-ref
(optional): the name of a property of the associated class that is joined to this foreign key. If not specified, the primary key of the associated class is used.
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the property value.
unique
(optional): enables the DDL generation of a unique constraint for the foreign-key column. By allowing this to be the target of a property-ref
, you can make the association multiplicity one-to-one.
not-null
(optional): enables the DDL generation of a nullability constraint for the foreign key columns.
optimistic-lock
(optional - defaults to true
): specifies that updates to this property do or do not require acquisition of the optimistic lock. In other words, it determines if a version increment should occur when this property is dirty.
lazy
(optional - defaults to proxy
): by default, single point associations are proxied. lazy="no-proxy"
specifies that the property should be fetched lazily when the instance variable is first accessed. This requires build-time bytecode instrumentation. lazy="false"
specifies that the association will always be eagerly fetched.
not-found
(optional - defaults to exception
): specifies how foreign keys that reference missing rows will be handled. ignore
will treat a missing row as a null association.
entity-name
(optional): the entity name of the associated class.
formula
(optional): an SQL expression that defines the value for a computed foreign key.
cascade
attribute to any meaningful value other than none
will propagate certain operations to the associated object. The meaningful values are divided into three categories. First, basic operations, which include: persist, merge, delete, save-update, evict, replicate, lock and refresh
; second, special values: delete-orphan
; and third,all
comma-separated combinations of operation names: cascade="persist,merge,evict"
or cascade="all,delete-orphan"
. Note that single valued, many-to-one and one-to-one, associations do not support orphan delete.
many-to-one
declaration:
<many-to-one name="product" class="Product" column="PRODUCT_ID"/>
property-ref
attribute should only be used for mapping legacy data where a foreign key refers to a unique key of the associated table other than the primary key. This is a complicated and confusing relational model. For example, if the Product
class had a unique serial number that is not the primary key. The unique
attribute controls Hibernate's DDL generation with the SchemaExport tool.
<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>
OrderItem
might use:
<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>
<properties>
element.
<many-to-one name="owner" property-ref="identity.ssn" column="OWNER_SSN"/>
5.1.21. One-to-one
one-to-one
element.
<one-to-one name="propertyName" class="ClassName" cascade="cascade_style" constrained="true|false" fetch="join|select" property-ref="propertyNameFromAssociatedClass" access="field|property|ClassName" formula="any SQL expression" lazy="proxy|no-proxy|false" entity-name="EntityName" node="element-name|@attribute-name|element/@attribute|." embed-xml="true|false" foreign-key="foreign_key_name" />
name
: the name of the property.
class
(optional - defaults to the property type determined by reflection): the name of the associated class.
cascade
(optional): specifies which operations should be cascaded from the parent object to the associated object.
constrained
(optional): specifies that a foreign key constraint on the primary key of the mapped table and references the table of the associated class. This option affects the order in which save()
and delete()
are cascaded, and determines whether the association can be proxied. It is also used by the schema export tool.
fetch
(optional - defaults to select
): chooses between outer-join fetching or sequential select fetching.
property-ref
(optional): the name of a property of the associated class that is joined to the primary key of this class. If not specified, the primary key of the associated class is used.
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the property value.
formula
(optional): almost all one-to-one associations map to the primary key of the owning entity. If this is not the case, you can specify another column, columns or expression to join on using an SQL formula. See org.hibernate.test.onetooneformula
for an example.
lazy
(optional - defaults to proxy
): by default, single point associations are proxied. lazy="no-proxy"
specifies that the property should be fetched lazily when the instance variable is first accessed. It requires build-time bytecode instrumentation. lazy="false"
specifies that the association will always be eagerly fetched. Note that if constrained="false"
, proxying is impossible and Hibernate will eagerly fetch the association.
entity-name
(optional): the entity name of the associated class.
- primary key associations
- unique foreign key associations
Employee
and Person
respectively:
<one-to-one name="person" class="Person"/>
<one-to-one name="employee" class="Employee" constrained="true"/>
foreign
:
<class name="person" table="PERSON"> <id name="id" column="PERSON_ID"> <generator class="foreign"> <param name="property">employee</param> </generator> </id> ... <one-to-one name="employee" class="Employee" constrained="true"/> </class>
Person
is assigned the same primary key value as the Employee
instance referred with the employee
property of that Person
.
Employee
to Person
, can be expressed as:
<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>
Person
mapping:
<one-to-one name="employee" class="Employee" property-ref="person"/>
5.1.22. Natural-id
<natural-id mutable="true|false"/> <property ... /> <many-to-one ... /> ...... </natural-id>
<natural-id>
element. Hibernate will generate the necessary unique key and nullability constraints and, as a result, your mapping will be more self-documenting.
equals()
and hashCode()
to compare the natural key properties of the entity.
mutable
(optional - defaults tofalse
): by default, natural identifier properties are assumed to be immutable (constant).
5.1.23. Component and Dynamic-component
<component>
element maps properties of a child object to columns of the table of a parent class. Components can, in turn, declare their own properties, components or collections. See the "Component" examples below:
<component name="propertyName" class="className" insert="true|false" update="true|false" access="field|property|ClassName" lazy="true|false" optimistic-lock="true|false" unique="true|false" node="element-name|." > <property ...../> <many-to-one .... /> ........ </component>
name
: the name of the property.
class
(optional - defaults to the property type determined by reflection): the name of the component (child) class.
insert
: do the mapped columns appear in SQL INSERTs
?
update
: do the mapped columns appear in SQL UPDATEs
?
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the property value.
lazy
(optional - defaults to false
): specifies that this component should be fetched lazily when the instance variable is first accessed. It requires build-time bytecode instrumentation.
optimistic-lock
(optional - defaults to true
): specifies that updates to this component either do or do not require acquisition of the optimistic lock. It determines if a version increment should occur when this property is dirty.
unique
(optional - defaults to false
): specifies that a unique constraint exists upon all mapped columns of the component.
<property>
tags map properties of the child class to table columns.
<component>
element allows a <parent>
subelement that maps a property of the component class as a reference back to the containing entity.
<dynamic-component>
element allows a Map
to be mapped as a component, where the property names refer to keys of the map.
5.1.24. Properties
<properties>
element allows the definition of a named, logical grouping of the properties of a class. The most important use of the construct is that it allows a combination of properties to be the target of a property-ref
. It is also a convenient way to define a multi-column unique constraint. For example:
<properties name="logicalName" insert="true|false" update="true|false" optimistic-lock="true|false" unique="true|false" > <property ...../> <many-to-one .... /> ........ </properties>
name
: the logical name of the grouping. It is not an actual property name.
insert
: do the mapped columns appear in SQL INSERTs
?
update
: do the mapped columns appear in SQL UPDATEs
?
optimistic-lock
(optional - defaults to true
): specifies that updates to these properties either do or do not require acquisition of the optimistic lock. It determines if a version increment should occur when these properties are dirty.
unique
(optional - defaults to false
): specifies that a unique constraint exists upon all mapped columns of the component.
<properties>
mapping:
<class name="Person"> <id name="personNumber"/> ... <properties name="name" unique="true" update="false"> <property name="firstName"/> <property name="initial"/> <property name="lastName"/> </properties> </class>
Person
table, instead of to the primary key:
<many-to-one name="person" class="Person" property-ref="name"> <column name="firstName"/> <column name="initial"/> <column name="lastName"/> </many-to-one>
5.1.25. Subclass
<subclass>
declaration is used. For example:
<subclass name="ClassName" discriminator-value="discriminator_value" proxy="ProxyInterface" lazy="true|false" dynamic-update="true|false" dynamic-insert="true|false" entity-name="EntityName" node="element-name" extends="SuperclassName"> <property .... /> ..... </subclass>
name
: the fully qualified class name of the subclass.
discriminator-value
(optional - defaults to the class name): a value that distinguishes individual subclasses.
proxy
(optional): specifies a class or interface used for lazy initializing proxies.
lazy
(optional - defaults to true
): setting lazy="false"
disables the use of lazy fetching.
<version>
and <id>
properties are assumed to be inherited from the root class. Each subclass in a hierarchy must define a unique discriminator-value
. If this is not specified, the fully qualified Java class name is used.
5.1.26. Joined-subclass
<joined-subclass>
element. For example:
<joined-subclass name="ClassName" table="tablename" proxy="ProxyInterface" lazy="true|false" dynamic-update="true|false" dynamic-insert="true|false" schema="schema" catalog="catalog" extends="SuperclassName" persister="ClassName" subselect="SQL expression" entity-name="EntityName" node="element-name"> <key .... > <property .... /> ..... </joined-subclass>
name
: the fully qualified class name of the subclass.
table
: the name of the subclass table.
proxy
(optional): specifies a class or interface to use for lazy initializing proxies.
lazy
(optional, defaults to true
): setting lazy="false"
disables the use of lazy fetching.
<key>
element. The mapping at the start of the chapter would then be re-written as:
<?xml version="1.0"?> <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> <hibernate-mapping package="eg"> <class name="Cat" table="CATS"> <id name="id" column="uid" type="long"> <generator class="hilo"/> </id> <property name="birthdate" type="date"/> <property name="color" not-null="true"/> <property name="sex" not-null="true"/> <property name="weight"/> <many-to-one name="mate"/> <set name="kittens"> <key column="MOTHER"/> <one-to-many class="Cat"/> </set> <joined-subclass name="DomesticCat" table="DOMESTIC_CATS"> <key column="CAT"/> <property name="name" type="string"/> </joined-subclass> </class> <class name="eg.Dog"> <!-- mapping for Dog could go here --> </class> </hibernate-mapping>
5.1.27. Union-subclass
<class>
declaration. However, if you wish use polymorphic associations (e.g. an association to the superclass of your hierarchy), you need to use the <union-subclass>
mapping. For example:
<union-subclass name="ClassName" table="tablename" proxy="ProxyInterface" lazy="true|false" dynamic-update="true|false" dynamic-insert="true|false" schema="schema" catalog="catalog" extends="SuperclassName" abstract="true|false" persister="ClassName" subselect="SQL expression" entity-name="EntityName" node="element-name"> <property .... /> ..... </union-subclass>
name
: the fully qualified class name of the subclass.
table
: the name of the subclass table.
proxy
(optional): specifies a class or interface to use for lazy initializing proxies.
lazy
(optional, defaults to true
): setting lazy="false"
disables the use of lazy fetching.
5.1.28. Join
<join>
element, it is possible to map properties of one class to several tables that have a one-to-one relationship. For example:
<join table="tablename" schema="owner" catalog="catalog" fetch="join|select" inverse="true|false" optional="true|false"> <key ... /> <property ... /> ... </join>
table
: the name of the joined table.
schema
(optional): overrides the schema name specified by the root <hibernate-mapping>
element.
catalog
(optional): overrides the catalog name specified by the root <hibernate-mapping>
element.
fetch
(optional - defaults to join
): if set to join
, the default, Hibernate will use an inner join to retrieve a <join>
defined by a class or its superclasses. It will use an outer join for a <join>
defined by a subclass. If set to select
then Hibernate will use a sequential select for a <join>
defined on a subclass. This will be issued only if a row represents an instance of the subclass. Inner joins will still be used to retrieve a <join>
defined by the class and its superclasses.
inverse
(optional - defaults to false
): if enabled, Hibernate will not insert or update the properties defined by this join.
optional
(optional - defaults to false
): if enabled, Hibernate will insert a row only if the properties defined by this join are non-null. It will always use an outer join to retrieve the properties.
<class name="Person" table="PERSON"> <id name="id" column="PERSON_ID">...</id> <join table="ADDRESS"> <key column="ADDRESS_ID"/> <property name="address"/> <property name="zip"/> <property name="country"/> </join> ...
5.1.29. Key
<key>
element has featured a few times within this guide. It appears anywhere the parent mapping element defines a join to a new table that references the primary key of the original table. It also defines the foreign key in the joined table:
<key column="columnname" on-delete="noaction|cascade" property-ref="propertyName" not-null="true|false" update="true|false" unique="true|false" />
column
(optional): the name of the foreign key column. This can also be specified by nested <column>
element(s).
on-delete
(optional - defaults to noaction
): specifies whether the foreign key constraint has database-level cascade delete enabled.
property-ref
(optional): specifies that the foreign key refers to columns that are not the primary key of the original table. It is provided for legacy data.
not-null
(optional): specifies that the foreign key columns are not nullable. This is implied whenever the foreign key is also part of the primary key.
update
(optional): specifies that the foreign key should never be updated. This is implied whenever the foreign key is also part of the primary key.
unique
(optional): specifies that the foreign key should have a unique constraint. This is implied whenever the foreign key is also the primary key.
on-delete="cascade"
. Hibernate uses a database-level ON CASCADE DELETE
constraint, instead of many individual DELETE
statements. Be aware that this feature bypasses Hibernate's usual optimistic locking strategy for versioned data.
not-null
and update
attributes are useful when mapping a unidirectional one-to-many association. If you map a unidirectional one-to-many association to a non-nullable foreign key, you must declare the key column using <key not-null="true">
.
5.1.30. Column and Formula Elements
column
attribute will alternatively accept a <column>
subelement. Likewise, <formula>
is an alternative to the formula
attribute. For example:
<column name="column_name" length="N" precision="N" scale="N" not-null="true|false" unique="true|false" unique-key="multicolumn_unique_key_name" index="index_name" sql-type="sql_type_name" check="SQL expression" default="SQL expression"/>
<formula>SQL expression</formula>
column
and formula
attributes can even be combined within the same property or association mapping to express, for example, exotic join conditions.
<many-to-one name="homeAddress" class="Address" insert="false" update="false"> <column name="person_id" not-null="true" length="10"/> <formula>'MAILING'</formula> </many-to-one>
5.1.31. Import
auto-import="true"
. You can also import classes and interfaces that are not explicitly mapped:
<import class="java.lang.Object" rename="Universe"/>
<import class="ClassName" rename="ShortName" />
class
: the fully qualified class name of any Java class.
rename
(optional - defaults to the unqualified class name): a name that can be used in the query language.
5.1.32. Any
<any>
mapping element defines a polymorphic association to classes from multiple tables. This type of mapping requires more than one column. The first column contains the type of the associated entity. The remaining columns contain the identifier. It is impossible to specify a foreign key constraint for this kind of association. This is not the usual way of mapping polymorphic associations and you should use this only in special cases. For example, for audit logs, user session data, etc.
meta-type
attribute allows the application to specify a custom type that maps database column values to persistent classes that have identifier properties of the type specified by id-type
. You must specify the mapping from values of the meta-type to class names.
<any name="being" id-type="long" meta-type="string"> <meta-value value="TBL_ANIMAL" class="Animal"/> <meta-value value="TBL_HUMAN" class="Human"/> <meta-value value="TBL_ALIEN" class="Alien"/> <column name="table_name"/> <column name="id"/> </any>
<any name="propertyName" id-type="idtypename" meta-type="metatypename" cascade="cascade_style" access="field|property|ClassName" optimistic-lock="true|false" > <meta-value ... /> <meta-value ... /> ..... <column .... /> <column .... /> ..... </any>
name
: the property name.
id-type
: the identifier type.
meta-type
(optional - defaults to string
): any type that is allowed for a discriminator mapping.
cascade
(optional- defaults to none
): the cascade style.
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the property value.
optimistic-lock
(optional - defaults to true
): specifies that updates to this property either do or do not require acquisition of the optimistic lock. It defines whether a version increment should occur if this property is dirty.
5.2. Hibernate Types
5.2.1. Entities and Values
java.lang.String
also has value semantics. Given this definition, all types (classes) provided by the JDK have value type semantics in Java, while user-defined types can be mapped with entity or value type semantics. This decision is up to the application developer. An entity class in a domain model will normally have shared references to a single instance of that class, while composition or aggregation usually translates to a value type.
<class>
, <subclass>
and so on are used. For value types we use <property>
, <component>
etc., that usually have a type
attribute. The value of this attribute is the name of a Hibernate mapping type. Hibernate provides a range of mappings for standard JDK value types out of the box. You can write your own mapping types and implement your own custom conversion strategies.
5.2.2. Basic Value Types
integer, long, short, float, double, character, byte, boolean, yes_no, true_false
- Type mappings from Java primitives or wrapper classes to appropriate (vendor-specific) SQL column types.
boolean, yes_no
andtrue_false
are all alternative encodings for a Javaboolean
orjava.lang.Boolean
. string
- A type mapping from
java.lang.String
toVARCHAR
(or OracleVARCHAR2
). date, time, timestamp
- Type mappings from
java.util.Date
and its subclasses to SQL typesDATE
,TIME
andTIMESTAMP
(or equivalent). calendar, calendar_date
- Type mappings from
java.util.Calendar
to SQL typesTIMESTAMP
andDATE
(or equivalent). big_decimal, big_integer
- Type mappings from
java.math.BigDecimal
andjava.math.BigInteger
toNUMERIC
(or OracleNUMBER
). locale, timezone, currency
- Type mappings from
java.util.Locale
,java.util.TimeZone
andjava.util.Currency
toVARCHAR
(or OracleVARCHAR2
). Instances ofLocale
andCurrency
are mapped to their ISO codes. Instances ofTimeZone
are mapped to theirID
. class
- A type mapping from
java.lang.Class
toVARCHAR
(or OracleVARCHAR2
). AClass
is mapped to its fully qualified name. binary
- Maps byte arrays to an appropriate SQL binary type.
text
- Maps long Java strings to a SQL
CLOB
orTEXT
type. serializable
- Maps serializable Java types to an appropriate SQL binary type. You can also indicate the Hibernate type
serializable
with the name of a serializable Java class or interface that does not default to a basic type. clob, blob
- Type mappings for the JDBC classes
java.sql.Clob
andjava.sql.Blob
. These types can be inconvenient for some applications, since the blob or clob object cannot be reused outside of a transaction. Driver support is patchy and inconsistent. imm_date, imm_time, imm_timestamp, imm_calendar, imm_calendar_date, imm_serializable, imm_binary
- Type mappings for what are considered mutable Java types. This is where Hibernate makes certain optimizations appropriate only for immutable Java types, and the application treats the object as immutable. For example, you should not call
Date.setTime()
for an instance mapped asimm_timestamp
. To change the value of the property, and have that change made persistent, the application must assign a new, nonidentical, object to the property.
binary
, blob
and clob
. Composite identifiers are also allowed. See below for more information.
Type
constants defined on org.hibernate.Hibernate
. For example, Hibernate.STRING
represents the string
type.
5.2.3. Custom Value Types
java.lang.BigInteger
to VARCHAR
columns. Hibernate does not provide a built-in type for this. Custom types are not limited to mapping a property, or collection element, to a single table column. So, for example, you might have a Java property getName()
/setName()
of type java.lang.String
that is persisted to the columns FIRST_NAME
, INITIAL
, SURNAME
.
org.hibernate.UserType
or org.hibernate.CompositeUserType
and declare properties using the fully qualified classname of the type. View org.hibernate.test.DoubleStringType
to see the kind of things that are possible.
<property name="twoStrings" type="org.hibernate.test.DoubleStringType"> <column name="first_string"/> <column name="second_string"/> </property>
<column>
tags to map a property to multiple columns.
CompositeUserType
, EnhancedUserType
, UserCollectionType
, and UserVersionType
interfaces provide support for more specialized uses.
UserType
in the mapping file. To do this, your UserType
must implement the org.hibernate.usertype.ParameterizedType
interface. To supply parameters to your custom type, you can use the <type>
element in your mapping files.
<property name="priority"> <type name="com.mycompany.usertypes.DefaultValueIntegerType"> <param name="default">0</param> </type> </property>
UserType
can now retrieve the value for the parameter named default
from the Properties
object passed to it.
UserType
, it is useful to define a shorter name for it. You can do this using the <typedef>
element. Typedefs assign a name to a custom type, and can also contain a list of default parameter values if the type is parameterized.
<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero"> <param name="default">0</param> </typedef>
<property name="priority" type="default_zero"/>
MonetaryAmount
class is a good candidate for a CompositeUserType
, even though it could be mapped as a component. One reason for this is abstraction. With a custom type, your mapping documents would be protected against changes to the way monetary values are represented.
5.3. Additional Information
5.3.1. Mapping a Class Multiple Times
<class name="Contract" table="Contracts" entity-name="CurrentContract"> ... <set name="history" inverse="true" order-by="effectiveEndDate desc"> <key column="currentContractId"/> <one-to-many entity-name="HistoricalContract"/> </set> </class> <class name="Contract" table="ContractHistory" entity-name="HistoricalContract"> ... <many-to-one name="currentContract" column="currentContractId" entity-name="CurrentContract"/> </class>
entity-name
instead of class
.
5.3.2. SQL Quoted Identifiers
Dialect
. This is usually double quotes, but the SQL Server uses brackets and MySQL uses backticks.
<class name="LineItem" table="`Line Item`"> <id name="id" column="`Item Id`"/><generator class="assigned"/></id> <property name="itemNumber" column="`Item #`"/> ... </class>
5.4. Metadata Alternatives
5.4.1. About Metadata Alternatives
5.4.2. Using XDoclet Markup
@hibernate.tags
. We do not cover this approach in this reference guide since it is considered part of XDoclet. However, we include the following example of the Cat
class with XDoclet mappings:
package eg; import java.util.Set; import java.util.Date; /** * @hibernate.class * table="CATS" */ public class Cat { private Long id; // identifier private Date birthdate; private Cat mother; private Set kittens; private Color color; private char sex; private float weight; /* * @hibernate.id * generator-class="native" * column="CAT_ID" */ public Long getId() { return id; } private void setId(Long id) { this.id=id; } /** * @hibernate.many-to-one * column="PARENT_ID" */ public Cat getMother() { return mother; } void setMother(Cat mother) { this.mother = mother; } /** * @hibernate.property * column="BIRTH_DATE" */ public Date getBirthdate() { return birthdate; } void setBirthdate(Date date) { birthdate = date; } /** * @hibernate.property * column="WEIGHT" */ public float getWeight() { return weight; } void setWeight(float weight) { this.weight = weight; } /** * @hibernate.property * column="COLOR" * not-null="true" */ public Color getColor() { return color; } void setColor(Color color) { this.color = color; } /** * @hibernate.set * inverse="true" * order-by="BIRTH_DATE" * @hibernate.collection-key * column="PARENT_ID" * @hibernate.collection-one-to-many */ public Set getKittens() { return kittens; } void setKittens(Set kittens) { this.kittens = kittens; } // addKitten not needed by Hibernate public void addKitten(Cat kitten) { kittens.add(kitten); } /** * @hibernate.property * column="SEX" * not-null="true" * update="false" */ public char getSex() { return sex; } void setSex(char sex) { this.sex=sex; } }
5.4.3. Using JDK 5.0 Annotations
EntityManager
of JSR-220 (the persistence API). Support for mapping metadata is available via the Hibernate Annotations package as a separate download. Both EJB3 (JSR-220) and Hibernate3 metadata is supported.
@Entity public class Customer implements Serializable { @Id Long id; String firstName; String lastName; Date birthday; @Transient Integer age; @Embedded private Address homeAddress; @OneToMany(cascade=CascadeType.ALL) @JoinColumn(name="CUSTOMER_ID") Set<Order> orders; // Getter/setter and business methods }
5.4.4. Generated Properties
refresh
objects that contain any properties for which the database was generating values. Marking properties as generated, however, lets the application delegate this responsibility to Hibernate. When Hibernate issues an SQL INSERT or UPDATE for an entity that has defined generated properties, it immediately issues a select afterwards to retrieve the generated values.
never
(the default): the given property value is not generated within the database.
insert
: the given property value is generated on insert, but is not regenerated on subsequent updates. Properties like created-date fall into this category. Even though the version and timestamp properties can be marked as generated, this option is not available.
always
: the property value is generated both on insert and on update.
5.4.5. Auxiliary Database Objects
java.sql.Statement.execute()
method is valid (for example, ALTERs, INSERTS, etc.). There are essentially two modes for defining auxiliary database objects:
<hibernate-mapping> ... <database-object> <create>CREATE TRIGGER my_trigger ...</create> <drop>DROP TRIGGER my_trigger</drop> </database-object> </hibernate-mapping>
org.hibernate.mapping.AuxiliaryDatabaseObject
interface.
<hibernate-mapping> ... <database-object> <definition class="MyTriggerDefinition"/> </database-object> </hibernate-mapping>
<hibernate-mapping> ... <database-object> <definition class="MyTriggerDefinition"/> <dialect-scope name="org.hibernate.dialect.Oracle9iDialect"/> <dialect-scope name="org.hibernate.dialect.Oracle10gDialect"/> </database-object> </hibernate-mapping>
Chapter 6. Collection Mapping
6.1. Persistent Collections
public class Product { private String serialNumber; private Set parts = new HashSet(); public Set getParts() { return parts; } void setParts(Set parts) { this.parts = parts; } public String getSerialNumber() { return serialNumber; } void setSerialNumber(String sn) { serialNumber = sn; } }
java.util.Set
, java.util.Collection
, java.util.List
, java.util.Map
, java.util.SortedSet
, java.util.SortedMap
or anything you like ("anything you like" means you will have to write an implementation of org.hibernate.usertype.UserCollectionType
.)
HashSet
. This is the best way to initialize collection valued properties of newly instantiated (non-persistent) instances. When you make the instance persistent, by calling persist()
for example, Hibernate will actually replace the HashSet
with an instance of Hibernate's own implementation of Set
. Be aware of the following errors:
Cat cat = new DomesticCat(); Cat kitten = new DomesticCat(); .... Set kittens = new HashSet(); kittens.add(kitten); cat.setKittens(kittens); session.persist(cat); kittens = cat.getKittens(); // Okay, kittens collection is a Set (HashSet) cat.getKittens(); // Error!
HashMap
, HashSet
, TreeMap
, TreeSet
or ArrayList
, depending on the interface type.
6.2. Collection Mappings
6.2.1. About Collection Mappings
Note
<set>
element is used for mapping properties of type Set
.
<class name="Product"> <id name="serialNumber" column="productSerialNumber"/> <set name="parts"> <key column="productSerialNumber" not-null="true"/> <one-to-many class="Part"/> </set> </class>
<set>
, there is also <list>
, <map>
, <bag>
, <array>
and <primitive-array>
mapping elements. The <map>
element is representative:
<map name="propertyName" table="table_name" schema="schema_name" lazy="true|extra|false" inverse="true|false" cascade="all|none|save-update|delete|all-delete-orphan|delete-orphan" sort="unsorted|natural|comparatorClass" order-by="column_name asc|desc" where="arbitrary sql where condition" fetch="join|select|subselect" batch-size="N" access="field|property|ClassName" optimistic-lock="true|false" mutable="true|false" node="element-name|." embed-xml="true|false" > <key .... /> <map-key .... /> <element .... /> </map>
name
: the collection property name
table
(optional - defaults to property name): the name of the collection table. It is not used for one-to-many associations.
schema
(optional): the name of a table schema to override the schema declared on the root element
lazy
(optional - defaults to true
): disables lazy fetching and specifies that the association is always eagerly fetched. It can also be used to enable "extra-lazy" fetching where most operations do not initialize the collection. This is suitable for large collections.
inverse
(optional - defaults to false
): marks this collection as the "inverse" end of a bidirectional association.
cascade
(optional - defaults to none
): enables operations to cascade to child entities.
sort
(optional): specifies a sorted collection with natural
sort order or a given comparator class.
order-by
(optional, JDK1.4 only): specifies a table column or columns that define the iteration order of the Map
, Set
or bag, together with an optional asc
or desc
.
where
(optional): specifies an arbitrary SQL WHERE
condition that is used when retrieving or removing the collection. This is useful if the collection needs to contain only a subset of the available data.
fetch
(optional, defaults to select
): chooses between outer-join fetching, fetching by sequential select, and fetching by sequential subselect.
batch-size
(optional, defaults to 1
): specifies a "batch size" for lazily fetching instances of this collection.
access
(optional - defaults to property
): the strategy Hibernate uses for accessing the collection property value.
optimistic-lock
(optional - defaults to true
): specifies that changes to the state of the collection results in increments of the owning entity's version. For one-to-many associations you may want to disable this setting.
mutable
(optional - defaults to true
): a value of false
specifies that the elements of the collection never change. This allows for minor performance optimization in some cases.
6.2.2. Collection Foreign Keys
<key>
element.
not-null="true"
.
<key column="productSerialNumber" not-null="true"/>
ON DELETE CASCADE
.
<key column="productSerialNumber" on-delete="cascade"/>
<key>
element.
6.2.3. Collection Elements
<element>
or <composite-element>
, or in the case of entity references, with <one-to-many>
or <many-to-many>
. The first two map elements with value semantics, the next two are used to map entity associations.
6.2.4. Indexed Collections
List
index, or Map
key. The index of a Map
may be of any basic type, mapped with <map-key>
. It can be an entity reference mapped with <map-key-many-to-many>
, or it can be a composite type mapped with <composite-map-key>
. The index of an array or list is always of type integer
and is mapped using the <list-index>
element. The mapped column contains sequential integers that are numbered from zero by default.
<list-index column="column_name" base="0|1|..."/>
column_name
(required): the name of the column holding the collection index values.
base
(optional - defaults to 0
): the value of the index column that corresponds to the first element of the list or array.
<map-key column="column_name" formula="any SQL expression" type="type_name" node="@attribute-name" length="N"/>
column
(optional): the name of the column holding the collection index values.
formula
(optional): a SQL formula used to evaluate the key of the map.
type
(required): the type of the map keys.
<map-key-many-to-many column="column_name" formula="any SQL expression" class="ClassName" />
column
(optional): the name of the foreign key column for the collection index values.
formula
(optional): a SQ formula used to evaluate the foreign key of the map key.
class
(required): the entity class used as the map key.
List
as the property type, you can map the property as a Hibernate <bag>. A bag does not retain its order when it is persisted to the database, but it can be optionally sorted or ordered when it is retrieved from the database.
6.2.5. Collections of Values and Many-to-many Associations
<element>
tag. For example:
<element column="column_name" formula="any SQL expression" type="typename" length="L" precision="P" scale="S" not-null="true|false" unique="true|false" node="element-name" />
column
(optional): the name of the column holding the collection element values.
formula
(optional): an SQL formula used to evaluate the element.
type
(required): the type of the collection element.
<many-to-many>
element.
<many-to-many column="column_name" formula="any SQL expression" class="ClassName" fetch="select|join" unique="true|false" not-found="ignore|exception" entity-name="EntityName" property-ref="propertyNameFromAssociatedClass" node="element-name" embed-xml="true|false" />
column
(optional): the name of the element foreign key column.
formula
(optional): an SQL formula used to evaluate the element foreign key value.
class
(required): the name of the associated class.
fetch
(optional - defaults to join
): enables outer-join or sequential select fetching for this association. This is a special case; for full eager fetching in a single SELECT
of an entity and its many-to-many relationships to other entities, you would enable join
fetching,not only of the collection itself, but also with this attribute on the <many-to-many>
nested element.
unique
(optional): enables the DDL generation of a unique constraint for the foreign-key column. This makes the association multiplicity effectively one-to-many.
not-found
(optional - defaults to exception
): specifies how foreign keys that reference missing rows will be handled: ignore
will treat a missing row as a null association.
entity-name
(optional): the entity name of the associated class, as an alternative to class
.
property-ref
(optional): the name of a property of the associated class that is joined to this foreign key. If not specified, the primary key of the associated class is used.
<set name="names" table="person_names"> <key column="person_id"/> <element column="person_name" type="string"/> </set>
order-by
attribute:
<bag name="sizes" table="item_sizes" order-by="size asc"> <key column="item_id"/> <element column="size" type="integer"/> </bag>
<array name="addresses" table="PersonAddress" cascade="persist"> <key column="personId"/> <list-index column="sortOrder"/> <many-to-many column="addressId" class="Address"/> </array>
<map name="holidays" table="holidays" schema="dbo" order-by="hol_name asc"> <key column="id"/> <map-key column="hol_name" type="string"/> <element column="hol_date" type="date"/> </map>
<list name="carComponents" table="CarComponents"> <key column="carId"/> <list-index column="sortOrder"/> <composite-element class="CarComponent"> <property name="price"/> <property name="type"/> <property name="serialNumber" column="serialNum"/> </composite-element> </list>
6.2.6. One-to-many Associations
- An instance of the contained entity class cannot belong to more than one instance of the collection.
- An instance of the contained entity class cannot appear at more than one value of the collection index.
Product
to Part
requires the existence of a foreign key column and possibly an index column to the Part
table. A <one-to-many>
tag indicates that this is a one-to-many association.
<one-to-many class="ClassName" not-found="ignore|exception" entity-name="EntityName" node="element-name" embed-xml="true|false" />
class
(required): the name of the associated class.
not-found
(optional - defaults to exception
): specifies how cached identifiers that reference missing rows will be handled. ignore
will treat a missing row as a null association.
entity-name
(optional): the entity name of the associated class, as an alternative to class
.
<one-to-many>
element does not need to declare any columns. Nor is it necessary to specify the table
name anywhere.
Warning
<one-to-many>
association is declared NOT NULL
, you must declare the <key>
mapping not-null="true"
or use a bidirectional association with the collection mapping marked inverse="true"
. See the discussion of bidirectional associations later in this chapter for more information.
Part
entities by name, where partName
is a persistent property of Part
. Notice the use of a formula-based index:
<map name="parts" cascade="all"> <key column="productId" not-null="true"/> <map-key formula="partName"/> <one-to-many class="Part"/> </map>
6.3. Advanced collection Mappings
6.3.1. Sorted Collections
java.util.SortedMap
and java.util.SortedSet
. You must specify a comparator in the mapping file:
<set name="aliases" table="person_aliases" sort="natural"> <key column="person"/> <element column="name" type="string"/> </set> <map name="holidays" sort="my.custom.HolidayComparator"> <key column="year_id"/> <map-key column="hol_name" type="string"/> <element column="hol_date" type="date"/> </map>
sort
attribute are unsorted
, natural
and the name of a class implementing java.util.Comparator
.
java.util.TreeSet
or java.util.TreeMap
.
order-by
attribute of set
, bag
or map
mappings. This solution is only available under JDK 1.4 or higher and is implemented using LinkedHashSet
or LinkedHashMap
. This performs the ordering in the SQL query and not in the memory.
<set name="aliases" table="person_aliases" order-by="lower(name) asc"> <key column="person"/> <element column="name" type="string"/> </set> <map name="holidays" order-by="hol_date, hol_name"> <key column="year_id"/> <map-key column="hol_name" type="string"/> <element column="hol_date type="date"/> </map>
Note
order-by
attribute is an SQL ordering, not an HQL ordering.
filter()
:
sortedUsers = s.createFilter( group.getUsers(), "order by this.name" ).list();
6.3.2. Bidirectional Associations
- one-to-many
- set or bag valued at one end and single-valued at the other
- many-to-many
- set or bag valued at both ends
<class name="Category"> <id name="id" column="CATEGORY_ID"/> ... <bag name="items" table="CATEGORY_ITEM"> <key column="CATEGORY_ID"/> <many-to-many class="Item" column="ITEM_ID"/> </bag> </class> <class name="Item"> <id name="id" column="ITEM_ID"/> ... <!-- inverse end --> <bag name="categories" table="CATEGORY_ITEM" inverse="true"> <key column="ITEM_ID"/> <many-to-many class="Category" column="CATEGORY_ID"/> </bag> </class>
category.getItems().add(item); // The category now "knows" about the relationship item.getCategories().add(category); // The item now "knows" about the relationship session.persist(item); // The relationship won't be saved! session.persist(category); // The relationship will be saved
inverse="true"
.
<class name="Parent"> <id name="id" column="parent_id"/> .... <set name="children" inverse="true"> <key column="parent_id"/> <one-to-many class="Child"/> </set> </class> <class name="Child"> <id name="id" column="child_id"/> .... <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> </class>
inverse="true"
does not affect the operation of cascades as these are orthogonal concepts.
6.3.3. Bidirectional Associations with Indexed Collections
<list>
or <map>
, requires special consideration. If there is a property of the child class that maps to the index column you can use inverse="true"
on the collection mapping:
<class name="Parent"> <id name="id" column="parent_id"/> .... <map name="children" inverse="true"> <key column="parent_id"/> <map-key column="name" type="string"/> <one-to-many class="Child"/> </map> </class> <class name="Child"> <id name="id" column="child_id"/> .... <property name="name" not-null="true"/> <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> </class>
inverse="true"
. Instead, you could use the following mapping:
<class name="Parent"> <id name="id" column="parent_id"/> .... <map name="children"> <key column="parent_id" not-null="true"/> <map-key column="name" type="string"/> <one-to-many class="Child"/> </map> </class> <class name="Child"> <id name="id" column="child_id"/> .... <many-to-one name="parent" class="Parent" column="parent_id" insert="false" update="false" not-null="true"/> </class>
6.3.4. Ternary Associations
Map
with an association as its index:
<map name="contracts"> <key column="employer_id" not-null="true"/> <map-key-many-to-many column="employee_id" class="Employee"/> <one-to-many class="Contract"/> </map>
<map name="connections"> <key column="incoming_node_id"/> <map-key-many-to-many column="outgoing_node_id" class="Node"/> <many-to-many column="connection_id" class="Connection"/> </map>
6.3.5. Using an idbag
<idbag>
element lets you map a List
(or Collection
) with bag semantics. For example:
<idbag name="lovers" table="LOVERS"> <collection-id column="ID" type="long"> <generator class="sequence"/> </collection-id> <key column="PERSON1"/> <many-to-many column="PERSON2" class="Person" fetch="join"/> </idbag>
<idbag>
has a synthetic id generator, just like an entity class. A different surrogate key is assigned to each collection row. Hibernate does not, however, provide any mechanism for discovering the surrogate key value of a particular row.
<idbag>
supersedes a regular <bag>
. Hibernate can locate individual rows efficiently and update or delete them individually, similar to a list, map or set.
native
identifier generation strategy is not supported for <idbag>
collection identifiers.
6.4. Collection Example
6.4.1. Collection Examples
Child
instances:
package eg; import java.util.Set; public class Parent { private long id; private Set children; public long getId() { return id; } private void setId(long id) { this.id=id; } private Set getChildren() { return children; } private void setChildren(Set children) { this.children=children; } .... .... }
<hibernate-mapping> <class name="Parent"> <id name="id"> <generator class="sequence"/> </id> <set name="children"> <key column="parent_id"/> <one-to-many class="Child"/> </set> </class> <class name="Child"> <id name="id"> <generator class="sequence"/> </id> <property name="name"/> </class> </hibernate-mapping>
create table parent ( id bigint not null primary key ) create table child ( id bigint not null primary key, name varchar(255), parent_id bigint ) alter table child add constraint childfk0 (parent_id) references parent
<hibernate-mapping> <class name="Parent"> <id name="id"> <generator class="sequence"/> </id> <set name="children" inverse="true"> <key column="parent_id"/> <one-to-many class="Child"/> </set> </class> <class name="Child"> <id name="id"> <generator class="sequence"/> </id> <property name="name"/> <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> </class> </hibernate-mapping>
NOT NULL
constraint:
create table parent ( id bigint not null primary key ) create table child ( id bigint not null primary key, name varchar(255), parent_id bigint not null ) alter table child add constraint childfk0 (parent_id) references parent
NOT NULL
constraint on the <key>
mapping:
<hibernate-mapping> <class name="Parent"> <id name="id"> <generator class="sequence"/> </id> <set name="children"> <key column="parent_id" not-null="true"/> <one-to-many class="Child"/> </set> </class> <class name="Child"> <id name="id"> <generator class="sequence"/> </id> <property name="name"/> </class> </hibernate-mapping>
<hibernate-mapping> <class name="Parent"> <id name="id"> <generator class="sequence"/> </id> <set name="children" table="childset"> <key column="parent_id"/> <many-to-many class="Child" column="child_id"/> </set> </class> <class name="Child"> <id name="id"> <generator class="sequence"/> </id> <property name="name"/> </class> </hibernate-mapping>
create table parent ( id bigint not null primary key ) create table child ( id bigint not null primary key, name varchar(255) ) create table childset ( parent_id bigint not null, child_id bigint not null, primary key ( parent_id, child_id ) ) alter table childset add constraint childsetfk0 (parent_id) references parent alter table childset add constraint childsetfk1 (child_id) references child
Chapter 7. Association Mappings
7.1. About Association Mappings
Person
and Address
in all the examples.
7.2. Unidirectional Associations
7.2.1. Unidirectional Many-to-one
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <many-to-one name="address" column="addressId" not-null="true"/> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key, addressId bigint not null ) create table Address ( addressId bigint not null primary key )
7.2.2. Unidirectional One-to-one
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <many-to-one name="address" column="addressId" unique="true" not-null="true"/> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key, addressId bigint not null unique ) create table Address ( addressId bigint not null primary key )
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> </class> <class name="Address"> <id name="id" column="personId"> <generator class="foreign"> <param name="property">person</param> </generator> </id> <one-to-one name="person" constrained="true"/> </class>
create table Person ( personId bigint not null primary key ) create table Address ( personId bigint not null primary key )
7.2.3. Unidirectional One-to-many
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <set name="addresses"> <key column="personId" not-null="true"/> <one-to-many class="Address"/> </set> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key ) create table Address ( addressId bigint not null primary key, personId bigint not null )
7.3. Unidirectional Associations with Join Tables
7.3.1. Unidirectional One-to-many with Join Tables
unique="true"
, changes the multiplicity from many-to-many to one-to-many.
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <set name="addresses" table="PersonAddress"> <key column="personId"/> <many-to-many column="addressId" unique="true" class="Address"/> </set> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId not null, addressId bigint not null primary key ) create table Address ( addressId bigint not null primary key )
7.3.2. Unidirectional Many-to-one with Join Tables
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <join table="PersonAddress" optional="true"> <key column="personId" unique="true"/> <many-to-one name="address" column="addressId" not-null="true"/> </join> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId bigint not null primary key, addressId bigint not null ) create table Address ( addressId bigint not null primary key )
7.3.3. Unidirectional One-to-one with Join Tables
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <join table="PersonAddress" optional="true"> <key column="personId" unique="true"/> <many-to-one name="address" column="addressId" not-null="true" unique="true"/> </join> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) create table Address ( addressId bigint not null primary key )
7.3.4. Unidirectional Many-to-many with Join Tables
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <set name="addresses" table="PersonAddress"> <key column="personId"/> <many-to-many column="addressId" class="Address"/> </set> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) create table Address ( addressId bigint not null primary key )
7.4. Bidirectional Associations
7.4.1. Bidirectional One-to-many and Many-to-one
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <many-to-one name="address" column="addressId" not-null="true"/> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> <set name="people" inverse="true"> <key column="addressId"/> <one-to-many class="Person"/> </set> </class>
create table Person ( personId bigint not null primary key, addressId bigint not null ) create table Address ( addressId bigint not null primary key )
List
, or other indexed collection, set the key
column of the foreign key to not null
. Hibernate will manage the association from the collections side to maintain the index of each element, making the other side virtually inverse by setting update="false"
and insert="false"
:
<class name="Person"> <id name="id"/> ... <many-to-one name="address" column="addressId" not-null="true" insert="false" update="false"/> </class> <class name="Address"> <id name="id"/> ... <list name="people"> <key column="addressId" not-null="true"/> <list-index column="peopleIdx"/> <one-to-many class="Person"/> </list> </class>
NOT NULL
, it is important that you define not-null="true"
on the <key>
element of the collection mapping. Do not only declare not-null="true"
on a possible nested <column>
element, but on the <key>
element.
7.4.2. Bidirectional One-to-one
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <many-to-one name="address" column="addressId" unique="true" not-null="true"/> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> <one-to-one name="person" property-ref="address"/> </class>
create table Person ( personId bigint not null primary key, addressId bigint not null unique ) create table Address ( addressId bigint not null primary key )
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <one-to-one name="address"/> </class> <class name="Address"> <id name="id" column="personId"> <generator class="foreign"> <param name="property">person</param> </generator> </id> <one-to-one name="person" constrained="true"/> </class>
create table Person ( personId bigint not null primary key ) create table Address ( personId bigint not null primary key )
7.5. Bidirectional Associations with Join Tables
7.5.1. Bidirectional One-to-many and Many-to-one with Join Tables
inverse="true"
can go on either end of the association, on the collection, or on the join.
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <set name="addresses" table="PersonAddress"> <key column="personId"/> <many-to-many column="addressId" unique="true" class="Address"/> </set> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> <join table="PersonAddress" inverse="true" optional="true"> <key column="addressId"/> <many-to-one name="person" column="personId" not-null="true"/> </join> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId bigint not null, addressId bigint not null primary key ) create table Address ( addressId bigint not null primary key )
7.5.2. Bidirectional One to one with Join Tables
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <join table="PersonAddress" optional="true"> <key column="personId" unique="true"/> <many-to-one name="address" column="addressId" not-null="true" unique="true"/> </join> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> <join table="PersonAddress" optional="true" inverse="true"> <key column="addressId" unique="true"/> <many-to-one name="person" column="personId" not-null="true" unique="true"/> </join> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) create table Address ( addressId bigint not null primary key )
7.5.3. Bidirectional Many-to-many with Join Tables
<class name="Person"> <id name="id" column="personId"> <generator class="native"/> </id> <set name="addresses" table="PersonAddress"> <key column="personId"/> <many-to-many column="addressId" class="Address"/> </set> </class> <class name="Address"> <id name="id" column="addressId"> <generator class="native"/> </id> <set name="people" inverse="true" table="PersonAddress"> <key column="addressId"/> <many-to-many column="personId" class="Person"/> </set> </class>
create table Person ( personId bigint not null primary key ) create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) create table Address ( addressId bigint not null primary key )
7.6. Other Association Mappings
7.6.1. Complex Association Mappings
accountNumber
, effectiveEndDate
and effectiveStartDate
columns, it would be mapped as follows:
<properties name="currentAccountKey"> <property name="accountNumber" type="string" not-null="true"/> <property name="currentAccount" type="boolean"> <formula>case when effectiveEndDate is null then 1 else 0 end</formula> </property> </properties> <property name="effectiveEndDate" type="date"/> <property name="effectiveStateDate" type="date" not-null="true"/>
effectiveEndDate
, by using:
<many-to-one name="currentAccountInfo" property-ref="currentAccountKey" class="AccountInfo"> <column name="accountNumber"/> <formula>'1'</formula> </many-to-one>
Employee
and Organization
is maintained in an Employment
table full of historical employment data. An association to the employee's most recent employer, the one with the most recent startDate
, could be mapped in the following way:
<join> <key column="employeeId"/> <subselect> select employeeId, orgId from Employments group by orgId having startDate = max(startDate) </subselect> <many-to-one name="mostRecentEmployer" class="Organization" column="orgId"/> </join>
Chapter 8. Component Mapping
8.1. About Component Mapping
8.2. Dependent Objects
public class Person { private java.util.Date birthday; private Name name; private String key; public String getKey() { return key; } private void setKey(String key) { this.key=key; } public java.util.Date getBirthday() { return birthday; } public void setBirthday(java.util.Date birthday) { this.birthday = birthday; } public Name getName() { return name; } public void setName(Name name) { this.name = name; } ...... ...... }
public class Name { char initial; String first; String last; public String getFirst() { return first; } void setFirst(String first) { this.first = first; } public String getLast() { return last; } void setLast(String last) { this.last = last; } public char getInitial() { return initial; } void setInitial(char initial) { this.initial = initial; } }
Name
can be persisted as a component of Person
. Name
defines getter and setter methods for its persistent properties, but it does not need to declare any interfaces or identifier properties.
<class name="eg.Person" table="person"> <id name="Key" column="pid" type="string"> <generator class="uuid"/> </id> <property name="birthday" type="date"/> <component name="Name" class="eg.Name"> <!-- class attribute optional --> <property name="initial"/> <property name="first"/> <property name="last"/> </component> </class>
pid
, birthday
, initial
, first
and last
.
<component>
element allows a <parent>
subelement that maps a property of the component class as a reference back to the containing entity.
<class name="eg.Person" table="person"> <id name="Key" column="pid" type="string"> <generator class="uuid"/> </id> <property name="birthday" type="date"/> <component name="Name" class="eg.Name" unique="true"> <parent name="namedPerson"/> <!-- reference back to the Person --> <property name="initial"/> <property name="first"/> <property name="last"/> </component> </class>
8.3. Collections of Dependent Objects
Name
). Declare your component collection by replacing the <element>
tag with a <composite-element>
tag:
<set name="someNames" table="some_names" lazy="true"> <key column="id"/> <composite-element class="eg.Name"> <!-- class attribute required --> <property name="initial"/> <property name="first"/> <property name="last"/> </composite-element> </set>
Important
Set
of composite elements, it is important to implement equals()
and hashCode()
correctly.
<nested-composite-element>
tag. This case is a collection of components which themselves have components. You may want to consider if a one-to-many association is more appropriate. Remodel the composite element as an entity, but be aware that even though the Java model is the same, the relational model and persistence semantics are still slightly different.
<set>
. There is no separate primary key column in the composite element table. Hibernate uses each column's value to identify a record when deleting objects, which is not possible with null values. You have to either use only not-null properties in a composite-element or choose a <list>
, <map>
, <bag>
or <idbag>
.
<many-to-one>
element. This mapping allows you to map extra columns of a many-to-many association table to the composite element class. The following is a many-to-many association from Order
to Item
, where purchaseDate
, price
and quantity
are properties of the association:
<class name="eg.Order" .... > .... <set name="purchasedItems" table="purchase_items" lazy="true"> <key column="order_id"> <composite-element class="eg.Purchase"> <property name="purchaseDate"/> <property name="price"/> <property name="quantity"/> <many-to-one name="item" class="eg.Item"/> <!-- class attribute is optional --> </composite-element> </set> </class>
Purchase
can be in the set of an Order
, but it cannot be referenced by the Item
at the same time.
<class name="eg.Order" .... > .... <set name="purchasedItems" table="purchase_items" lazy="true"> <key column="order_id"> <composite-element class="eg.OrderLine"> <many-to-one name="purchaseDetails class="eg.Purchase"/> <many-to-one name="item" class="eg.Item"/> </composite-element> </set> </class>
8.4. Components as Map Indices
<composite-map-key>
element allows you to map a component class as the key of a Map
. Ensure that you override hashCode()
and equals()
correctly on the component class.
8.5. Components as Composite Identifiers
- It must implement
java.io.Serializable
. - It must re-implement
equals()
andhashCode()
consistently with the database's notion of composite key equality.
Note
IdentifierGenerator
to generate composite keys. Instead the application must assign its own identifiers.
<composite-id>
tag, with nested <key-property>
elements, in place of the usual <id>
declaration. For example, the OrderLine
class has a primary key that depends upon the (composite) primary key of Order
.
<class name="OrderLine"> <composite-id name="id" class="OrderLineId"> <key-property name="lineId"/> <key-property name="orderId"/> <key-property name="customerId"/> </composite-id> <property name="name"/> <many-to-one name="order" class="Order" insert="false" update="false"> <column name="orderId"/> <column name="customerId"/> </many-to-one> .... </class>
OrderLine
table are now composite. Declare this in your mappings for other classes. An association to OrderLine
is mapped like this:
<many-to-one name="orderLine" class="OrderLine"> <!-- the "class" attribute is optional, as usual --> <column name="lineId"/> <column name="orderId"/> <column name="customerId"/> </many-to-one>
Note
<column>
tag is an alternative to the column
attribute everywhere.
many-to-many
association to OrderLine
also uses the composite foreign key:
<set name="undeliveredOrderLines"> <key column name="warehouseId"/> <many-to-many class="OrderLine"> <column name="lineId"/> <column name="orderId"/> <column name="customerId"/> </many-to-many> </set>
OrderLine
s in Order
would use:
<set name="orderLines" inverse="true"> <key> <column name="orderId"/> <column name="customerId"/> </key> <one-to-many class="OrderLine"/> </set>
<one-to-many>
element declares no columns.
OrderLine
itself owns a collection, it also has a composite foreign key.
<class name="OrderLine"> .... .... <list name="deliveryAttempts"> <key> <!-- a collection inherits the composite key type --> <column name="lineId"/> <column name="orderId"/> <column name="customerId"/> </key> <list-index column="attemptId" base="1"/> <composite-element class="DeliveryAttempt"> ... </composite-element> </set> </class>
8.6. Dynamic Components
Map
:
<dynamic-component name="userAttributes"> <property name="foo" column="FOO" type="string"/> <property name="bar" column="BAR" type="integer"/> <many-to-one name="baz" class="Baz" column="BAZ_ID"/> </dynamic-component>
<dynamic-component>
mapping are identical to <component>
. The advantage of this kind of mapping is the ability to determine the actual properties of the bean at deployment time just by editing the mapping document. Runtime manipulation of the mapping document is also possible, using a DOM parser. You can also access, and change, Hibernate's configuration-time metamodel via the Configuration
object.
Chapter 9. Inheritance Mapping
9.1. Inheritance Mapping Strategies
9.1.1. About Inheritance Mapping Strategies
- table per class hierarchy
- table per subclass
- table per concrete class
- implicit polymorphism
<subclass>
, <joined-subclass>
and <union-subclass>
mappings under the same root <class>
element. It is possible to mix together the table per class hierarchy and table per subclass strategies under the the same <class>
element, by combining the <subclass>
and <join>
elements (see below for an example).
subclass
, union-subclass
, and joined-subclass
mappings in separate mapping documents directly beneath hibernate-mapping
. This allows you to extend a class hierarchy by adding a new mapping file. You must specify an extends
attribute in the subclass mapping, naming a previously mapped superclass. Previously this feature made the ordering of the mapping documents important. Since Hibernate3, the ordering of mapping files is irrelevant when using the extends keyword. The ordering inside a single mapping file still needs to be defined as superclasses before subclasses.
<hibernate-mapping> <subclass name="DomesticCat" extends="Cat" discriminator-value="D"> <property name="name" type="string"/> </subclass> </hibernate-mapping>
9.1.2. Table Per Class Hierarchy
Payment
with the implementors CreditCardPayment
, CashPayment
, and ChequePayment
. The table per class hierarchy mapping would display in the following way:
<class name="Payment" table="PAYMENT"> <id name="id" type="long" column="PAYMENT_ID"> <generator class="native"/> </id> <discriminator column="PAYMENT_TYPE" type="string"/> <property name="amount" column="AMOUNT"/> ... <subclass name="CreditCardPayment" discriminator-value="CREDIT"> <property name="creditCardType" column="CCTYPE"/> ... </subclass> <subclass name="CashPayment" discriminator-value="CASH"> ... </subclass> <subclass name="ChequePayment" discriminator-value="CHEQUE"> ... </subclass> </class>
CCTYPE
, cannot have NOT NULL
constraints.
9.1.3. Table Per Subclass
<class name="Payment" table="PAYMENT"> <id name="id" type="long" column="PAYMENT_ID"> <generator class="native"/> </id> <property name="amount" column="AMOUNT"/> ... <joined-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> <key column="PAYMENT_ID"/> <property name="creditCardType" column="CCTYPE"/> ... </joined-subclass> <joined-subclass name="CashPayment" table="CASH_PAYMENT"> <key column="PAYMENT_ID"/> ... </joined-subclass> <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> <key column="PAYMENT_ID"/> ... </joined-subclass> </class>
9.1.4. Table Per Subclass: Using a Discriminator
<subclass>
and <join>
, as follows:
<class name="Payment" table="PAYMENT"> <id name="id" type="long" column="PAYMENT_ID"> <generator class="native"/> </id> <discriminator column="PAYMENT_TYPE" type="string"/> <property name="amount" column="AMOUNT"/> ... <subclass name="CreditCardPayment" discriminator-value="CREDIT"> <join table="CREDIT_PAYMENT"> <key column="PAYMENT_ID"/> <property name="creditCardType" column="CCTYPE"/> ... </join> </subclass> <subclass name="CashPayment" discriminator-value="CASH"> <join table="CASH_PAYMENT"> <key column="PAYMENT_ID"/> ... </join> </subclass> <subclass name="ChequePayment" discriminator-value="CHEQUE"> <join table="CHEQUE_PAYMENT" fetch="select"> <key column="PAYMENT_ID"/> ... </join> </subclass> </class>
fetch="select"
declaration tells Hibernate not to fetch the ChequePayment
subclass data using an outer join when querying the superclass.
9.1.5. Mixing Table Per Class Hierarchy with Table Per Subclass
<class name="Payment" table="PAYMENT"> <id name="id" type="long" column="PAYMENT_ID"> <generator class="native"/> </id> <discriminator column="PAYMENT_TYPE" type="string"/> <property name="amount" column="AMOUNT"/> ... <subclass name="CreditCardPayment" discriminator-value="CREDIT"> <join table="CREDIT_PAYMENT"> <property name="creditCardType" column="CCTYPE"/> ... </join> </subclass> <subclass name="CashPayment" discriminator-value="CASH"> ... </subclass> <subclass name="ChequePayment" discriminator-value="CHEQUE"> ... </subclass> </class>
Payment
class is mapped using <many-to-one>
.
<many-to-one name="payment" column="PAYMENT_ID" class="Payment"/>
9.1.6. Table Per Concrete Class
<union-subclass>
.
<class name="Payment"> <id name="id" type="long" column="PAYMENT_ID"> <generator class="sequence"/> </id> <property name="amount" column="AMOUNT"/> ... <union-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> <property name="creditCardType" column="CCTYPE"/> ... </union-subclass> <union-subclass name="CashPayment" table="CASH_PAYMENT"> ... </union-subclass> <union-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> ... </union-subclass> </class>
abstract="true"
. If it is not abstract, an additional table (it defaults to PAYMENT
in the example above), is needed to hold instances of the superclass.
9.1.7. Table Per Concrete Class Using Implicit Polymorphism
<class name="CreditCardPayment" table="CREDIT_PAYMENT"> <id name="id" type="long" column="CREDIT_PAYMENT_ID"> <generator class="native"/> </id> <property name="amount" column="CREDIT_AMOUNT"/> ... </class> <class name="CashPayment" table="CASH_PAYMENT"> <id name="id" type="long" column="CASH_PAYMENT_ID"> <generator class="native"/> </id> <property name="amount" column="CASH_AMOUNT"/> ... </class> <class name="ChequePayment" table="CHEQUE_PAYMENT"> <id name="id" type="long" column="CHEQUE_PAYMENT_ID"> <generator class="native"/> </id> <property name="amount" column="CHEQUE_AMOUNT"/> ... </class>
Payment
interface is not mentioned explicitly. Also notice that properties of Payment
are mapped in each of the subclasses. If you want to avoid duplication, consider using XML entities (for example, [ <!ENTITY allproperties SYSTEM "allproperties.xml"> ]
in the DOCTYPE
declaration and &allproperties;
in the mapping).
UNION
s when performing polymorphic queries.
Payment
is usually mapped using <any>
.
<any name="payment" meta-type="string" id-type="long"> <meta-value value="CREDIT" class="CreditCardPayment"/> <meta-value value="CASH" class="CashPayment"/> <meta-value value="CHEQUE" class="ChequePayment"/> <column name="PAYMENT_CLASS"/> <column name="PAYMENT_ID"/> </any>
9.1.8. Mixing Implicit Polymorphism With Other Inheritance Mappings
<class>
element, and since Payment
is just an interface, each of the subclasses could easily be part of another inheritance hierarchy. You can still use polymorphic queries against the Payment
interface.
<class name="CreditCardPayment" table="CREDIT_PAYMENT"> <id name="id" type="long" column="CREDIT_PAYMENT_ID"> <generator class="native"/> </id> <discriminator column="CREDIT_CARD" type="string"/> <property name="amount" column="CREDIT_AMOUNT"/> ... <subclass name="MasterCardPayment" discriminator-value="MDC"/> <subclass name="VisaPayment" discriminator-value="VISA"/> </class> <class name="NonelectronicTransaction" table="NONELECTRONIC_TXN"> <id name="id" type="long" column="TXN_ID"> <generator class="native"/> </id> ... <joined-subclass name="CashPayment" table="CASH_PAYMENT"> <key column="PAYMENT_ID"/> <property name="amount" column="CASH_AMOUNT"/> ... </joined-subclass> <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> <key column="PAYMENT_ID"/> <property name="amount" column="CHEQUE_AMOUNT"/> ... </joined-subclass> </class>
Payment
is not mentioned explicitly. If we execute a query against the Payment
interface, for example from Payment
, Hibernate automatically returns instances of CreditCardPayment
(and its subclasses, since they also implement Payment
), CashPayment
and ChequePayment
, but not instances of NonelectronicTransaction
.
9.2. Limitations
9.2.1. Inheritance Mapping Limitations
<union-subclass>
mappings.
- table per class-heirarchy, table per subclass
- Polymorphic many-to-one:
<many-to-one>
- Polymorphic one-to-one:
<one-to-one>
- Polymorphic one-to-many:
<one-to-many>
- Polymorphic many-to-many:
<many-to-many>
- Polymorphic
load()
orget()
:s.get(Payment.class, id)
- Polymorphic queries:
from Payment p
- Polymorphic joins:
from Order o join o.payment p
Outer join fetching is supported.- table per concrete-class (union-subclass)
- Polymorphic many-to-one:
<many-to-one>
- Polymorphic one-to-one:
<one-to-one>
- Polymorphic one-to-many:
<one-to-many>
(forinverse="true"
only) - Polymorphic many-to-many:
<many-to-many>
- Polymorphic
load()
orget()
:s.get(Payment.class, id)
- Polymorphic queries:
from Payment p
- Polymorphic joins:
from Order o join o.payment p
Outer join fetching is supported.- table per concrete class (implicit polymorphism
- Polymorphic many-to-one:
<any>
- Polymorphic many-to-many:
<many-to-many>
- Polymorphic
load()
orget()
:s.createCriteria(Payment.class).add( Restrictions.idEq(id) ).uniqueResult()
- Polymorphic queries:
from Payment p
Polymorphic one-to-one, polymorphic one-to-many, polymorphic joins, and outer join fetching are not supported.
Chapter 10. Working with Objects
10.1. About Working with Objects
statements
in common JDBC/SQL persistence layers, a natural object-oriented view of persistence in Java applications.
10.2. Hibernate Object States
- Transient - an object is transient if it has just been instantiated using the
new
operator, and it is not associated with a HibernateSession
. It has no persistent representation in the database and no identifier value has been assigned. Transient instances will be destroyed by the garbage collector if the application does not hold a reference anymore. Use the HibernateSession
to make an object persistent (and let Hibernate take care of the SQL statements that need to be executed for this transition). - Persistent - a persistent instance has a representation in the database and an identifier value. It might just have been saved or loaded, however, it is by definition in the scope of a
Session
. Hibernate will detect any changes made to an object in persistent state and synchronize the state with the database when the unit of work completes. Developers do not execute manualUPDATE
statements, orDELETE
statements when an object should be made transient. - Detached - a detached instance is an object that has been persistent, but its
Session
has been closed. The reference to the object is still valid, of course, and the detached instance might even be modified in this state. A detached instance can be reattached to a newSession
at a later point in time, making it (and all the modifications) persistent again. This feature enables a programming model for long running units of work that require user think-time. We call them application transactions, i.e., a unit of work from the point of view of the user.
10.3. Making Objects Persistent
DomesticCat fritz = new DomesticCat(); fritz.setColor(Color.GINGER); fritz.setSex('M'); fritz.setName("Fritz"); Long generatedId = (Long) sess.save(fritz);
Cat
has a generated identifier, the identifier is generated and assigned to the cat
when save()
is called. If Cat
has an assigned
identifier, or a composite key, the identifier should be assigned to the cat
instance before calling save()
. You can also use persist()
instead of save()
, with the semantics defined in the JPA early draft.
persist()
makes a transient instance persistent. However, it does not guarantee that the identifier value will be assigned to the persistent instance immediately, the assignment might happen at flush time.persist()
also guarantees that it will not execute anINSERT
statement if it is called outside of transaction boundaries. This is useful in long-running conversations with an extended Session/persistence context.save()
does guarantee to return an identifier. If an INSERT has to be executed to get the identifier ( e.g. "identity" generator, not "sequence"), this INSERT happens immediately, no matter if you are inside or outside of a transaction. This is problematic in a long-running conversation with an extended Session/persistence context.
save()
.
DomesticCat pk = new DomesticCat(); pk.setColor(Color.TABBY); pk.setSex('F'); pk.setName("PK"); pk.setKittens( new HashSet() ); pk.addKitten(fritz);
kittens
collection in the previous example), these objects can be made persistent in any order you like unless you have a NOT NULL
constraint upon a foreign key column. There is never a risk of violating foreign key constraints. However, you might violate a NOT NULL
constraint if you save()
the objects in the wrong order.
NOT NULL
constraint violations do not occur - Hibernate will take care of everything. Transitive persistence is discussed later in this chapter.
10.4. Loading an Object
load()
methods of Session
provide a way of retrieving a persistent instance if you know its identifier. load()
takes a class object and loads the state into a newly instantiated instance of that class in a persistent state.
Cat fritz = (Cat) sess.load(Cat.class, generatedId);
// you need to wrap primitive identifiers long id = 1234; DomesticCat pk = (DomesticCat) sess.load( DomesticCat.class, new Long(id) );
Cat cat = new DomesticCat(); // load pk's state into cat sess.load( cat, new Long(pkId) ); Set kittens = cat.getKittens();
load()
will throw an unrecoverable exception if there is no matching database row. If the class is mapped with a proxy, load()
just returns an uninitialized proxy and does not actually hit the database until you invoke a method of the proxy. This is useful if you wish to create an association to an object without actually loading it from the database. It also allows multiple instances to be loaded as a batch if batch-size
is defined for the class mapping.
get()
method which hits the database immediately and returns null if there is no matching row.
Cat cat = (Cat) sess.get(Cat.class, id); if (cat==null) { cat = new Cat(); } return cat;
SELECT ... FOR UPDATE
, using a LockMode
.
Cat cat = (Cat) sess.get(Cat.class, id, LockMode.UPGRADE);
FOR UPDATE
, unless you decide to specify lock
or all
as a cascade style for the association.
refresh()
method. This is useful when database triggers are used to initialize some of the properties of the object.
sess.save(cat); sess.flush(); //force the SQL INSERT sess.refresh(cat); //re-read the state (after the trigger executes)
SELECT
s it will use will depend on the fetching strategy. See Section 19.1.1, “About Fetching Strategies”
10.5. Querying
10.5.1. About Querying
10.5.2. Executing Queries
org.hibernate.Query
. This interface offers methods for parameter binding, result set handling, and for the execution of the actual query. You always obtain a Query
using the current Session
:
List cats = session.createQuery( "from Cat as cat where cat.birthdate < ?") .setDate(0, date) .list(); List mothers = session.createQuery( "select mother from Cat as cat join cat.mother as mother where cat.name = ?") .setString(0, name) .list(); List kittens = session.createQuery( "from Cat as cat where cat.mother = ?") .setEntity(0, pk) .list(); Cat mother = (Cat) session.createQuery( "select cat.mother from Cat as cat where cat = ?") .setEntity(0, izi) .uniqueResult(); Query mothersWithKittens = session.createQuery( "select mother from Cat as mother left join fetch mother.kittens"); Set uniqueMothers = new HashSet(mothersWithKittens.list());
list()
. The result of the query will be loaded completely into a collection in memory. Entity instances retrieved by a query are in a persistent state. The uniqueResult()
method offers a shortcut if you know your query will only return a single object. Queries that make use of eager fetching of collections usually return duplicates of the root objects, but with their collections initialized. You can filter these duplicates through a Set
.
10.5.3. Iterating Results
iterate()
method. This will usually be the case if you expect that the actual entity instances returned by the query will already be in the session or second-level cache. If they are not already cached, iterate()
will be slower than list()
and might require many database hits for a simple query, usually 1 for the initial select which only returns identifiers, and n additional selects to initialize the actual instances.
// fetch ids Iterator iter = sess.createQuery("from eg.Qux q order by q.likeliness").iterate(); while ( iter.hasNext() ) { Qux qux = (Qux) iter.next(); // fetch the object // something we couldn't express in the query if ( qux.calculateComplicatedAlgorithm() ) { // delete the current instance iter.remove(); // don't need to process the rest break; } }
10.5.4. Queries that Return Tuples
Iterator kittensAndMothers = sess.createQuery( "select kitten, mother from Cat kitten join kitten.mother mother") .list() .iterator(); while ( kittensAndMothers.hasNext() ) { Object[] tuple = (Object[]) kittensAndMothers.next(); Cat kitten = (Cat) tuple[0]; Cat mother = (Cat) tuple[1]; .... }
10.5.5. Scalar Results
select
clause. They can even call SQL aggregate functions. Properties or aggregates are considered "scalar" results and not entities in persistent state.
Iterator results = sess.createQuery( "select cat.color, min(cat.birthdate), count(cat) from Cat cat " + "group by cat.color") .list() .iterator(); while ( results.hasNext() ) { Object[] row = (Object[]) results.next(); Color type = (Color) row[0]; Date oldest = (Date) row[1]; Integer count = (Integer) row[2]; ..... }
10.5.6. Bind Parameters
Query
are provided for binding values to named parameters or JDBC-style ?
parameters. Contrary to JDBC, Hibernate numbers parameters from zero. Named parameters are identifiers of the form :name
in the query string. The advantages of named parameters are as follows:
- named parameters are insensitive to the order they occur in the query string
- they can occur multiple times in the same query
- they are self-documenting
//named parameter (preferred) Query q = sess.createQuery("from DomesticCat cat where cat.name = :name"); q.setString("name", "Fritz"); Iterator cats = q.iterate();
//positional parameter Query q = sess.createQuery("from DomesticCat cat where cat.name = ?"); q.setString(0, "Izi"); Iterator cats = q.iterate();
//named parameter list List names = new ArrayList(); names.add("Izi"); names.add("Fritz"); Query q = sess.createQuery("from DomesticCat cat where cat.name in (:namesList)"); q.setParameterList("namesList", names); List cats = q.list();
10.5.7. Pagination
Query
interface:
Query q = sess.createQuery("from DomesticCat cat"); q.setFirstResult(20); q.setMaxResults(10); List cats = q.list();
10.5.8. Scrollable Iteration
ResultSet
s, the Query
interface can be used to obtain a ScrollableResults
object that allows flexible navigation of the query results.
Query q = sess.createQuery("select cat.name, cat from DomesticCat cat " + "order by cat.name"); ScrollableResults cats = q.scroll(); if ( cats.first() ) { // find the first name on each page of an alphabetical list of cats by name firstNamesOfPages = new ArrayList(); do { String name = cats.getString(0); firstNamesOfPages.add(name); } while ( cats.scroll(PAGE_SIZE) ); // Now get the first page of cats pageOfCats = new ArrayList(); cats.beforeFirst(); int i=0; while( ( PAGE_SIZE > i++ ) && cats.next() ) pageOfCats.add( cats.get(1) ); } cats.close();
setMaxResult()
/setFirstResult()
if you need offline pagination functionality.
10.5.9. Externalizing Named Queries
CDATA
section if your query contains characters that could be interpreted as markup.
<query name="ByNameAndMaximumWeight"><![CDATA[ from eg.DomesticCat as cat where cat.name = ? and cat.weight > ? ] ]></query>
Query q = sess.getNamedQuery("ByNameAndMaximumWeight"); q.setString(0, name); q.setInteger(1, minWeight); List cats = q.list();
<hibernate-mapping>
element requires a global unique name for the query, while a query declaration inside a <class>
element is made unique automatically by prepending the fully qualified name of the class. For example eg.Cat.ByNameAndMaximumWeight
.
10.5.10. Filtering Collections
this
, meaning the current collection element.
Collection blackKittens = session.createFilter( pk.getKittens(), "where this.color = ?") .setParameter( Color.BLACK, Hibernate.custom(ColorUserType.class) ) .list()
from
clause, although they can have one if required. Filters are not limited to returning the collection elements themselves.
Collection blackKittenMates = session.createFilter( pk.getKittens(), "select this.mate where this.color = eg.Color.BLACK.intValue") .list();
Collection tenKittens = session.createFilter( mother.getKittens(), "") .setFirstResult(0).setMaxResults(10) .list();
10.5.11. Criteria Queries
Criteria
query API for these cases:
Criteria crit = session.createCriteria(Cat.class); crit.add( Restrictions.eq( "color", eg.Color.BLACK ) ); crit.setMaxResults(10); List cats = crit.list();
10.5.12. Queries in Native SQL
createSQLQuery()
and let Hibernate manage the mapping from result sets to objects. You can at any time call session.connection()
and use the JDBC Connection
directly. If you choose to use the Hibernate API, you must enclose SQL aliases in braces:
List cats = session.createSQLQuery("SELECT {cat.*} FROM CAT {cat} WHERE ROWNUM<10") .addEntity("cat", Cat.class) .list();
List cats = session.createSQLQuery( "SELECT {cat}.ID AS {cat.id}, {cat}.SEX AS {cat.sex}, " + "{cat}.MATE AS {cat.mate}, {cat}.SUBCLASS AS {cat.class}, ... " + "FROM CAT {cat} WHERE ROWNUM<10") .addEntity("cat", Cat.class) .list();
10.6. Modifying Objects
10.6.1. Modifying Persistent Objects
Session
) can be manipulated by the application, and any changes to persistent state will be persisted when the Session
is flushed. This is discussed later in this chapter. There is no need to call a particular method (like update()
, which has a different purpose) to make your modifications persistent. The most straightforward way to update the state of an object is to load()
it and then manipulate it directly while the Session
is open:
DomesticCat cat = (DomesticCat) sess.load( Cat.class, new Long(69) ); cat.setName("PK"); sess.flush(); // changes to cat are automatically detected and persisted
SELECT
to load an object and an SQL UPDATE
to persist its updated state. Hibernate offers an alternate approach by using detached instances.
Important
UPDATE
or DELETE
statements. Hibernate is a state management service, you do not have to think in statements to use it. JDBC is a perfect API for executing SQL statements, you can get a JDBC Connection
at any time by calling session.connection()
. Furthermore, the notion of mass operations conflicts with object/relational mapping for online transaction processing-oriented applications. Future versions of Hibernate can, however, provide special mass operation functions.
10.6.2. Modifying Detached Objects
Session.update()
or Session.merge()
methods:
// in the first session Cat cat = (Cat) firstSession.load(Cat.class, catId); Cat potentialMate = new Cat(); firstSession.save(potentialMate); // in a higher layer of the application cat.setMate(potentialMate); // later, in a new session secondSession.update(cat); // update cat secondSession.update(mate); // update mate
Cat
with identifier catId
had already been loaded by secondSession
when the application tried to reattach it, an exception would have been thrown.
update()
if you are certain that the session does not contain an already persistent instance with the same identifier. Use merge()
if you want to merge your modifications at any time without consideration of the state of the session. In other words, update()
is usually the first method you would call in a fresh session, ensuring that the reattachment of your detached instances is the first operation that is executed.
update()
detached instances that are reachable from the given detached instance only if it wants their state to be updated. This can be automated using transitive persistence. See Section 10.7.5, “Transitive Persistence” for further information.
lock()
method also allows an application to reassociate an object with a new session. However, the detached instance has to be unmodified.
//just reassociate: sess.lock(fritz, LockMode.NONE); //do a version check, then reassociate: sess.lock(izi, LockMode.READ); //do a version check, using SELECT ... FOR UPDATE, then reassociate: sess.lock(pk, LockMode.UPGRADE);
lock()
can be used with various LockMode
s. See the API documentation and the chapter on transaction handling for more information. Reattachment is not the only usecase for lock()
.
10.7. Other Object Operations
10.7.1. Automatic State Detection
saveOrUpdate()
method implements this functionality.
// in the first session Cat cat = (Cat) firstSession.load(Cat.class, catID); // in a higher tier of the application Cat mate = new Cat(); cat.setMate(mate); // later, in a new session secondSession.saveOrUpdate(cat); // update existing state (cat has a non-null id) secondSession.saveOrUpdate(mate); // save the new instance (mate has a null id)
saveOrUpdate()
seems to be confusing for new users. Firstly, so long as you are not trying to use instances from one session in another new session, you should not need to use update()
, saveOrUpdate()
, or merge()
. Some whole applications will never use either of these methods.
update()
or saveOrUpdate()
are used in the following scenario:
- the application loads an object in the first session
- the object is passed up to the UI tier
- some modifications are made to the object
- the object is passed back down to the business logic tier
- the application persists these modifications by calling
update()
in a second session
saveOrUpdate()
does the following:
- if the object is already persistent in this session, do nothing
- if another object associated with the session has the same identifier, throw an exception
- if the object has no identifier property,
save()
it - if the object's identifier has the value assigned to a newly instantiated object,
save()
it - if the object is versioned by a
<version>
or<timestamp>
, and the version property value is the same value assigned to a newly instantiated object,save()
it - otherwise
update()
the object
merge()
is very different:
- if there is a persistent instance with the same identifier currently associated with the session, copy the state of the given object onto the persistent instance
- if there is no persistent instance currently associated with the session, try to load it from the database, or create a new persistent instance
- the persistent instance is returned
- the given instance does not become associated with the session, it remains detached
10.7.2. Deleting Persistent Objects
Session.delete()
will remove an object's state from the database. Your application, however, can still hold a reference to a deleted object. It is best to think of delete()
as making a persistent instance, transient.
sess.delete(cat);
NOT NULL
constraint on a foreign key column by deleting objects in the wrong order, e.g. if you delete the parent, but forget to delete the children.
10.7.3. Replicating an Object Between Two Datastores
//retrieve a cat from one database Session session1 = factory1.openSession(); Transaction tx1 = session1.beginTransaction(); Cat cat = (Cat) session1.get(Cat.class, catId); tx1.commit(); session1.close(); //reconcile with a second database Session session2 = factory2.openSession(); Transaction tx2 = session2.beginTransaction(); session2.replicate(cat, ReplicationMode.LATEST_VERSION); tx2.commit(); session2.close();
ReplicationMode
determines how replicate()
will deal with conflicts with existing rows in the database:
ReplicationMode.IGNORE
: ignores the object when there is an existing database row with the same identifierReplicationMode.OVERWRITE
: overwrites any existing database row with the same identifierReplicationMode.EXCEPTION
: throws an exception if there is an existing database row with the same identifierReplicationMode.LATEST_VERSION
: overwrites the row if its version number is earlier than the version number of the object, or ignore the object otherwise
10.7.4. Flushing the Session
Session
will execute the SQL statements needed to synchronize the JDBC connection's state with the state of objects held in memory. This process, called flush, occurs by default at the following points:
- before some query executions
- from
org.hibernate.Transaction.commit()
- from
Session.flush()
- all entity insertions in the same order the corresponding objects were saved using
Session.save()
- all entity updates
- all collection deletions
- all collection element deletions, updates and insertions
- all collection insertions
- all entity deletions in the same order the corresponding objects were deleted using
Session.delete()
native
ID generation are inserted when they are saved.
flush()
, there are absolutely no guarantees about when the Session
executes the JDBC calls, only the order in which they are executed. However, Hibernate does guarantee that the Query.list(..)
will never return stale or incorrect data.
FlushMode
class defines three different modes: only flush at commit time when the Hibernate Transaction
API is used, flush automatically using the explained routine, or never flush unless flush()
is called explicitly. The last mode is useful for long running units of work, where a Session
is kept open and disconnected for a long time (see the Section 11.4.3, “Extended Session and Automatic Versioning” for further information).
sess = sf.openSession(); Transaction tx = sess.beginTransaction(); sess.setFlushMode(FlushMode.COMMIT); // allow queries to return stale state Cat izi = (Cat) sess.load(Cat.class, id); izi.setName(iznizi); // might return stale data sess.createQuery("from Cat as cat left outer join cat.kittens kitten"); // change to izi is not flushed! ... tx.commit(); // flush occurs sess.close();
10.7.5. Transitive Persistence
persist(), merge(), saveOrUpdate(), delete(), lock(), refresh(), evict(), replicate()
- there is a corresponding cascade style. Respectively, the cascade styles are named create, merge, save-update, delete, lock, refresh, evict, replicate
. If you want an operation to be cascaded along an association, you must indicate that in the mapping document. For example:
<one-to-one name="person" cascade="persist"/>
<one-to-one name="person" cascade="persist,delete,lock"/>
cascade="all"
to specify that all operations should be cascaded along the association. The default cascade="none"
specifies that no operations are to be cascaded.
delete-orphan
, applies only to one-to-many associations, and indicates that the delete()
operation should be applied to any child object that is removed from the association.
- It does not usually make sense to enable cascade on a
<many-to-one>
or<many-to-many>
association. Cascade is often useful for<one-to-one>
and<one-to-many>
associations. - If the child object's lifespan is bounded by the lifespan of the parent object, make it a life cycle object by specifying
cascade="all,delete-orphan"
. - Otherwise, you might not need cascade at all. But if you think that you will often be working with the parent and children together in the same transaction, and you want to save yourself some typing, consider using
cascade="persist,merge,save-update"
.
cascade="all"
marks the association as a parent/child style relationship where save/update/delete of the parent results in save/update/delete of the child or children.
<one-to-many>
association mapped with cascade="delete-orphan"
. The precise semantics of cascading operations for a parent/child relationship are as follows:
- If a parent is passed to
persist()
, all children are passed topersist()
- If a parent is passed to
merge()
, all children are passed tomerge()
- If a parent is passed to
save()
,update()
orsaveOrUpdate()
, all children are passed tosaveOrUpdate()
- If a transient or detached child becomes referenced by a persistent parent, it is passed to
saveOrUpdate()
- If a parent is deleted, all children are passed to
delete()
- If a child is dereferenced by a persistent parent, nothing special happens - the application should explicitly delete the child if necessary - unless
cascade="delete-orphan"
, in which case the "orphaned" child is deleted.
save-update
and delete-orphan
are transitive for all associated entities reachable during flush of the Session
.
10.7.6. Using Metadata
ClassMetadata
and CollectionMetadata
interfaces and the Type
hierarchy. Instances of the metadata interfaces can be obtained from the SessionFactory
.
Cat fritz = ......; ClassMetadata catMeta = sessionfactory.getClassMetadata(Cat.class); Object[] propertyValues = catMeta.getPropertyValues(fritz, EntityMode.POJO); String[] propertyNames = catMeta.getPropertyNames(); Type[] propertyTypes = catMeta.getPropertyTypes(); // get a Map of all properties which are not collections or associations Map namedValues = new HashMap(); for ( int i=0; i<propertyNames.length; i++ ) { if ( !propertyTypes[i].isEntityType() && !propertyTypes[i].isCollectionType() ) { namedValues.put( propertyNames[i], propertyValues[i] ); } }
Chapter 11. Transactions and Concurrency
11.1. About Transactions and Concurrency
Session
, which is also a transaction-scoped cache, Hibernate provides repeatable reads for lookup by identifier and entity queries and not reporting queries that return scalar values.
SELECT FOR UPDATE
syntax, a (minor) API for pessimistic locking of rows. Optimistic concurrency control and this API are discussed later in this chapter.
Configuration
, SessionFactory
, and Session
, as well as database transactions and long conversations.
11.2. Session and Transaction Scopes
11.2.1. About Session and Transaction Scopes
SessionFactory
is an expensive-to-create, threadsafe object, intended to be shared by all application threads. It is created once, usually on application startup, from a Configuration
instance.
Session
is an inexpensive, non-threadsafe object that should be used once and then discarded for: a single request, a conversation or a single unit of work. A Session
will not obtain a JDBC Connection
, or a Datasource
, unless it is needed. It will not consume any resources until used.
Session
span several database transactions, or is this a one-to-one relationship of scopes? When should you open and close a Session
and how do you demarcate the database transaction boundaries? These questions are addressed in the following sections.
11.2.2. Unit of Work
Session
for every simple database call in a single thread. The same is true for database transactions. Database calls in an application are made using a planned sequence; they are grouped into atomic units of work. This also means that auto-commit after every single SQL statement is useless in an application as this mode is intended for ad-hoc SQL console work. Hibernate disables, or expects the application server to disable, auto-commit mode immediately. Database transactions are never optional. All communication with a database has to occur inside a transaction. Auto-commit behavior for reading data should be avoided, as many small transactions are unlikely to perform better than one clearly defined unit of work. The latter is also more maintainable and extensible.
Session
is opened, and all database operations are executed in this unit of work. On completion of the work, and once the response for the client has been prepared, the session is flushed and closed. Use a single database transaction to serve the clients request, starting and committing it when you open and close the Session
. The relationship between the two is one-to-one and this model is a perfect fit for many applications.
ServletFilter
, AOP interceptor with a pointcut on the service methods, or a proxy/interception container. An EJB container is a standardized way to implement cross-cutting aspects such as transaction demarcation on EJB session beans, declaratively with CMT. If you use programmatic transaction demarcation, for ease of use and code portability use the Hibernate Transaction
API shown later in this chapter.
sessionFactory.getCurrentSession()
. You will always get a Session
scoped to the current database transaction. This has to be configured for either resource-local or JTA environments.
Session
and database transaction until the "view has been rendered". This is especially useful in servlet applications that utilize a separate rendering phase after the request has been processed. Extending the database transaction until view rendering, is achieved by implementing your own interceptor. However, this will be difficult if you rely on EJBs with container-managed transactions. A transaction will be completed when an EJB method returns, before rendering of any view can start.
11.2.3. Long Conversations
- The first screen of a dialog opens. The data seen by the user has been loaded in a particular
Session
and database transaction. The user is free to modify the objects. - The user clicks "Save" after 5 minutes and expects their modifications to be made persistent. The user also expects that they were the only person editing this information and that no conflicting modification has occurred.
Session
and database transaction open during user think time, with locks held in the database to prevent concurrent modification and to guarantee isolation and atomicity. This is an anti-pattern, since lock contention would not allow the application to scale with the number of concurrent users.
- Automatic Versioning: Hibernate can perform automatic optimistic concurrency control for you. It can automatically detect if a concurrent modification occurred during user think time. Check for this at the end of the conversation.
- Detached Objects: if you decide to use the session-per-request pattern, all loaded instances will be in the detached state during user think time. Hibernate allows you to reattach the objects and persist the modifications. The pattern is called session-per-request-with-detached-objects. Automatic versioning is used to isolate concurrent modifications.
- Extended (or Long) Session: the Hibernate
Session
can be disconnected from the underlying JDBC connection after the database transaction has been committed and reconnected when a new client request occurs. This pattern is known as session-per-conversation and makes even reattachment unnecessary. Automatic versioning is used to isolate concurrent modifications and theSession
will not be allowed to be flushed automatically, but explicitly.
11.2.4. Considering Object Identity
Session
s. However, an instance of a persistent class is never shared between two Session
instances. It is for this reason that there are two different notions of identity:
- Database Identity
foo.getId().equals( bar.getId() )
- JVM Identity
foo==bar
Session
(i.e., in the scope of a Session
), the two notions are equivalent and JVM identity for database identity is guaranteed by Hibernate. While the application might concurrently access the "same" (persistent identity) business object in two different sessions, the two instances will actually be "different" (JVM identity). Conflicts are resolved using an optimistic approach and automatic versioning at flush/commit time.
Session
. Within a Session
the application can safely use ==
to compare objects.
==
outside of a Session
might produce unexpected results. This might occur even in some unexpected places. For example, if you put two detached instances into the same Set
, both might have the same database identity (i.e., they represent the same row). JVM identity, however, is by definition not guaranteed for instances in a detached state. The developer has to override the equals()
and hashCode()
methods in persistent classes and implement their own notion of object equality. There is one caveat: never use the database identifier to implement equality. Use a business key that is a combination of unique, usually immutable, attributes. The database identifier will change if a transient object is made persistent. If the transient instance (usually together with detached instances) is held in a Set
, changing the hashcode breaks the contract of the Set
. Attributes for business keys do not have to be as stable as database primary keys; you only have to guarantee stability as long as the objects are in the same Set
. Please note that this is not a Hibernate issue, but simply how Java object identity and equality has to be implemented.
11.2.5. Common Issues
- A
Session
is not thread-safe. Things that work concurrently, like HTTP requests, session beans, or Swing workers, will cause race conditions if aSession
instance is shared. If you keep your HibernateSession
in yourHttpSession
(this is discussed later in the chapter), you should consider synchronizing access to your Http session. Otherwise, a user that clicks reload fast enough can use the sameSession
in two concurrently running threads. - An exception thrown by Hibernate means you have to rollback your database transaction and close the
Session
immediately (this is discussed in more detail later in the chapter). If yourSession
is bound to the application, you have to stop the application. Rolling back the database transaction does not put your business objects back into the state they were at the start of the transaction. This means that the database state and the business objects will be out of sync. Usually this is not a problem, because exceptions are not recoverable and you will have to start over after rollback anyway. - The
Session
caches every object that is in a persistent state (watched and checked for dirty state by Hibernate). If you keep it open for a long time or simply load too much data, it will grow endlessly until you get an OutOfMemoryException. One solution is to callclear()
andevict()
to manage theSession
cache, but you should consider a Stored Procedure if you need mass data operations. Some solutions are shown in Chapter 13, Batch Processing. Keeping aSession
open for the duration of a user session also means a higher probability of stale data.
11.3. Database Transaction Demarcation
11.3.1. About Database Transaction Demarcation
Transaction
that translates into the native transaction system of your deployment environment. This API is actually optional, but we strongly encourage its use unless you are in a CMT session bean.
Session
usually involves four distinct phases:
- flush the session
- commit the transaction
- close the session
- handle exceptions
11.3.2. Non-managed Environment
// Non-managed environment idiom Session sess = factory.openSession(); Transaction tx = null; try { tx = sess.beginTransaction(); // do some work ... tx.commit(); } catch (RuntimeException e) { if (tx != null) tx.rollback(); throw e; // or display error message } finally { sess.close(); }
flush()
the Session
explicitly: the call to commit()
automatically triggers the synchronization depending on the flushing set for the session. A call to close()
marks the end of a session. The main implication of close()
is that the JDBC connection will be relinquished by the session. This Java code is portable and runs in both non-managed and JTA environments.
// Non-managed environment idiom with getCurrentSession() try { factory.getCurrentSession().beginTransaction(); // do some work ... factory.getCurrentSession().getTransaction().commit(); } catch (RuntimeException e) { factory.getCurrentSession().getTransaction().rollback(); throw e; // or display error message }
RuntimeException
(and usually can only clean up and exit), are in different layers. The current context management by Hibernate can significantly simplify this design by accessing a SessionFactory
. Exception handling is discussed later in this chapter.
org.hibernate.transaction.JDBCTransactionFactory
, which is the default, and for the second example select "thread"
as your hibernate.current_session_context_class
.
11.3.3. Using JTA
Transaction
API. The transaction management code is identical to the non-managed environment.
// BMT idiom Session sess = factory.openSession(); Transaction tx = null; try { tx = sess.beginTransaction(); // do some work ... tx.commit(); } catch (RuntimeException e) { if (tx != null) tx.rollback(); throw e; // or display error message } finally { sess.close(); }
Session
, that is, the getCurrentSession()
functionality for easy context propagation, use the JTA UserTransaction
API directly:
// BMT idiom with getCurrentSession() try { UserTransaction tx = (UserTransaction)new InitialContext() .lookup("java:comp/UserTransaction"); tx.begin(); // Do some work on Session bound to transaction factory.getCurrentSession().load(...); factory.getCurrentSession().persist(...); tx.commit(); } catch (RuntimeException e) { tx.rollback(); throw e; // or display error message }
// CMT idiom Session sess = factory.getCurrentSession(); // do some work ...
RuntimeException
thrown by a session bean method tells the container to set the global transaction to rollback. You do not need to use the Hibernate Transaction
API at all with BMT or CMT, and you get automatic propagation of the "current" Session bound to the transaction.
org.hibernate.transaction.JTATransactionFactory
if you use JTA directly (BMT), and org.hibernate.transaction.CMTTransactionFactory
in a CMT session bean. Remember to also set hibernate.transaction.manager_lookup_class
. Ensure that your hibernate.current_session_context_class
is either unset (backwards compatibility), or is set to "jta"
.
getCurrentSession()
operation has one downside in a JTA environment. There is one caveat to the use of after_statement
connection release mode, which is then used by default. Due to a limitation of the JTA spec, it is not possible for Hibernate to automatically clean up any unclosed ScrollableResults
or Iterator
instances returned by scroll()
or iterate()
. You must release the underlying database cursor by calling ScrollableResults.close()
or Hibernate.close(Iterator)
explicitly from a finally
block. Most applications can easily avoid using scroll()
or iterate()
from the JTA or CMT code.
11.3.4. Exception Handling
Session
throws an exception, including any SQLException
, immediately rollback the database transaction, call Session.close()
and discard the Session
instance. Certain methods of Session
will not leave the session in a consistent state. No exception thrown by Hibernate can be treated as recoverable. Ensure that the Session
will be closed by calling close()
in a finally
block.
HibernateException
, which wraps most of the errors that can occur in a Hibernate persistence layer, is an unchecked exception. It was not in older versions of Hibernate. In our opinion, we should not force the application developer to catch an unrecoverable exception at a low layer. In most systems, unchecked and fatal exceptions are handled in one of the first frames of the method call stack (i.e., in higher layers) and either an error message is presented to the application user or some other appropriate action is taken. Note that Hibernate might also throw other unchecked exceptions that are not a HibernateException
. These are not recoverable and appropriate action should be taken.
SQLException
s thrown while interacting with the database in a JDBCException
. In fact, Hibernate will attempt to convert the exception into a more meaningful subclass of JDBCException
. The underlying SQLException
is always available via JDBCException.getCause()
. Hibernate converts the SQLException
into an appropriate JDBCException
subclass using the SQLExceptionConverter
attached to the SessionFactory
. By default, the SQLExceptionConverter
is defined by the configured dialect. However, it is also possible to plug in a custom implementation. See the javadocs for the SQLExceptionConverterFactory
class for details. The standard JDBCException
subtypes are:
JDBCConnectionException
: indicates an error with the underlying JDBC communication.SQLGrammarException
: indicates a grammar or syntax problem with the issued SQL.ConstraintViolationException
: indicates some form of integrity constraint violation.LockAcquisitionException
: indicates an error acquiring a lock level necessary to perform the requested operation.GenericJDBCException
: a generic exception which did not fall into any of the other categories.
11.3.5. Transaction Timeout
Transaction
object.
Session sess = factory.openSession(); try { //set transaction timeout to 3 seconds sess.getTransaction().setTimeout(3); sess.getTransaction().begin(); // do some work ... sess.getTransaction().commit(); } catch (RuntimeException e) { sess.getTransaction().rollback(); throw e; // or display error message } finally { sess.close(); }
setTimeout()
cannot be called in a CMT bean, where transaction timeouts must be defined declaratively.
11.4. Optimistic Concurrency Control
11.4.1. About Optimistic Concurrency Control
11.4.2. Application Version Checking
Session
and the developer is responsible for reloading all persistent instances from the database before manipulating them. The application is forced to carry out its own version checking to ensure conversation transaction isolation. This approach is the least efficient in terms of database access. It is the approach most similar to entity EJBs.
// foo is an instance loaded by a previous Session session = factory.openSession(); Transaction t = session.beginTransaction(); int oldVersion = foo.getVersion(); session.load( foo, foo.getKey() ); // load the current state if ( oldVersion != foo.getVersion() ) throw new StaleObjectStateException("Message", foo.getId()); foo.setProperty("bar"); t.commit(); session.close();
version
property is mapped using <version>
, and Hibernate will automatically increment it during flush if the entity is dirty.
Session
or detached instances as the design paradigm.
11.4.3. Extended Session and Automatic Versioning
Session
instance and its persistent instances that are used for the whole conversation are known as session-per-conversation. Hibernate checks instance versions at flush time, throwing an exception if concurrent modification is detected. It is up to the developer to catch and handle this exception. Common options are the opportunity for the user to merge changes or to restart the business conversation with non-stale data.
Session
is disconnected from any underlying JDBC connection when waiting for user interaction. This approach is the most efficient in terms of database access. The application does not version check or reattach detached instances, nor does it have to reload instances in every database transaction.
// foo is an instance loaded earlier by the old session Transaction t = session.beginTransaction(); // Obtain a new JDBC connection, start transaction foo.setProperty("bar"); session.flush(); // Only for last transaction in conversation t.commit(); // Also return JDBC connection session.close(); // Only for last transaction in conversation
foo
object knows which Session
it was loaded in. Beginning a new database transaction on an old session obtains a new connection and resumes the session. Committing a database transaction disconnects a session from the JDBC connection and returns the connection to the pool. After reconnection, to force a version check on data you are not updating, you can call Session.lock()
with LockMode.READ
on any objects that might have been updated by another transaction. You do not need to lock any data that you are updating. Usually you would set FlushMode.MANUAL
on an extended Session
, so that only the last database transaction cycle is allowed to actually persist all modifications made in this conversation. Only this last database transaction will include the flush()
operation, and then close()
the session to end the conversation.
Session
is too big to be stored during user think time (for example, an HttpSession
should be kept as small as possible). As the Session
is also the first-level cache and contains all loaded objects, we can probably use this strategy only for a few request/response cycles. Use a Session
only for a single conversation as it will soon have stale data.
Note
Session
. These methods are deprecated, as beginning and ending a transaction has the same effect.
Session
close to the persistence layer. Use an EJB stateful session bean to hold the Session
in a three-tier environment. Do not transfer it to the web layer, or even serialize it to a separate tier, to store it in the HttpSession
.
CurrentSessionContext
for this. See the Hibernate Wiki for examples.
11.4.4. Detached Objects and Automatic Versioning
Session
. However, the same persistent instances are reused for each interaction with the database. The application manipulates the state of detached instances originally loaded in another Session
and then reattaches them using Session.update()
, Session.saveOrUpdate()
, or Session.merge()
.
// foo is an instance loaded by a previous Session foo.setProperty("bar"); session = factory.openSession(); Transaction t = session.beginTransaction(); session.saveOrUpdate(foo); // Use merge() if "foo" might have been loaded already t.commit(); session.close();
lock()
instead of update()
, and use LockMode.READ
(performing a version check and bypassing all caches) if you are sure that the object has not been modified.
11.4.5. Customizing Automatic Versioning
optimistic-lock
mapping attribute to false
. Hibernate will then no longer increment versions if the property is dirty.
optimistic-lock="all"
in the <class>
mapping. This conceptually only works if Hibernate can compare the old and the new state (i.e., if you use a single long Session
and not session-per-request-with-detached-objects).
optimistic-lock="dirty"
when mapping the <class>
, Hibernate will only compare dirty fields during flush.
UPDATE
statement, with an appropriate WHERE
clause, per entity to execute the version check and update the information. If you use transitive persistence to cascade reattachment to associated entities, Hibernate may execute unnecessary updates. This is usually not a problem, but on update triggers in the database might be executed even when no changes have been made to detached instances. You can customize this behavior by setting select-before-update="true"
in the <class>
mapping, forcing Hibernate to SELECT
the instance to ensure that changes did occur before updating the row.
11.5. Pessimistic Locking
11.5.1. About Pessimistic Locking
LockMode
class defines the different lock levels that can be acquired by Hibernate. A lock is obtained by the following mechanisms:
LockMode.WRITE
is acquired automatically when Hibernate updates or inserts a row.LockMode.UPGRADE
can be acquired upon explicit user request usingSELECT ... FOR UPDATE
on databases which support that syntax.LockMode.UPGRADE_NOWAIT
can be acquired upon explicit user request using aSELECT ... FOR UPDATE NOWAIT
under Oracle.LockMode.READ
is acquired automatically when Hibernate reads data under Repeatable Read or Serializable isolation level. It can be re-acquired by explicit user request.LockMode.NONE
represents the absence of a lock. All objects switch to this lock mode at the end of aTransaction
. Objects associated with the session via a call toupdate()
orsaveOrUpdate()
also start out in this lock mode.
- A call to
Session.load()
, specifying aLockMode
. - A call to
Session.lock()
. - A call to
Query.setLockMode()
.
Session.load()
is called with UPGRADE
or UPGRADE_NOWAIT
, and the requested object was not yet loaded by the session, the object is loaded using SELECT ... FOR UPDATE
. If load()
is called for an object that is already loaded with a less restrictive lock than the one requested, Hibernate calls lock()
for that object.
Session.lock()
performs a version number check if the specified lock mode is READ
, UPGRADE
or UPGRADE_NOWAIT
. In the case of UPGRADE
or UPGRADE_NOWAIT
, SELECT ... FOR UPDATE
is used.
11.5.2. Connection Release Modes
Session
would obtain a connection when it was first required and then maintain that connection until the session was closed. Hibernate 3.x introduced the notion of connection release modes that would instruct a session how to handle its JDBC connections. The following discussion is pertinent only to connections provided through a configured ConnectionProvider
. User-supplied connections are outside the breadth of this discussion. The different release modes are identified by the enumerated values of org.hibernate.ConnectionReleaseMode
:
ON_CLOSE
: is the legacy behavior described above. The Hibernate session obtains a connection when it first needs to perform some JDBC access and maintains that connection until the session is closed.AFTER_TRANSACTION
: releases connections after aorg.hibernate.Transaction
has been completed.AFTER_STATEMENT
(also referred to as aggressive release): releases connections after every statement execution. This aggressive releasing is skipped if that statement leaves open resources associated with the given session. Currently the only situation where this occurs is through the use oforg.hibernate.ScrollableResults
.
hibernate.connection.release_mode
is used to specify which release mode to use. The possible values are as follows:
auto
(the default): this choice delegates to the release mode returned by theorg.hibernate.transaction.TransactionFactory.getDefaultReleaseMode()
method. For JTATransactionFactory, this returns ConnectionReleaseMode.AFTER_STATEMENT; for JDBCTransactionFactory, this returns ConnectionReleaseMode.AFTER_TRANSACTION. Do not change this default behavior as failures due to the value of this setting tend to indicate bugs and/or invalid assumptions in user code.on_close
: uses ConnectionReleaseMode.ON_CLOSE. This setting is left for backwards compatibility, but its use is discouraged.after_transaction
: uses ConnectionReleaseMode.AFTER_TRANSACTION. This setting should not be used in JTA environments. Also note that with ConnectionReleaseMode.AFTER_TRANSACTION, if a session is considered to be in auto-commit mode, connections will be released as if the release mode were AFTER_STATEMENT.after_statement
: uses ConnectionReleaseMode.AFTER_STATEMENT. Additionally, the configuredConnectionProvider
is consulted to see if it supports this setting (supportsAggressiveRelease()
). If not, the release mode is reset to ConnectionReleaseMode.AFTER_TRANSACTION. This setting is only safe in environments where we can either re-acquire the same underlying JDBC connection each time you make a call intoConnectionProvider.getConnection()
or in auto-commit environments where it does not matter if we re-establish the same connection.
Chapter 12. Interceptors and Events
12.1. Interceptors
Interceptor
interface provides callbacks from the session to the application, allowing the application to inspect and/or manipulate properties of a persistent object before it is saved, updated, deleted or loaded. One possible use for this is to track auditing information. For example, the following Interceptor
automatically sets the createTimestamp
when an Auditable
is created and updates the lastUpdateTimestamp
property when an Auditable
is updated.
Interceptor
directly or extend EmptyInterceptor
.
package org.hibernate.test; import java.io.Serializable; import java.util.Date; import java.util.Iterator; import org.hibernate.EmptyInterceptor; import org.hibernate.Transaction; import org.hibernate.type.Type; public class AuditInterceptor extends EmptyInterceptor { private int updates; private int creates; private int loads; public void onDelete(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) { // do nothing } public boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) { if ( entity instanceof Auditable ) { updates++; for ( int i=0; i < propertyNames.length; i++ ) { if ( "lastUpdateTimestamp".equals( propertyNames[i] ) ) { currentState[i] = new Date(); return true; } } } return false; } public boolean onLoad(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) { if ( entity instanceof Auditable ) { loads++; } return false; } public boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) { if ( entity instanceof Auditable ) { creates++; for ( int i=0; i<propertyNames.length; i++ ) { if ( "createTimestamp".equals( propertyNames[i] ) ) { state[i] = new Date(); return true; } } } return false; } public void afterTransactionCompletion(Transaction tx) { if ( tx.wasCommitted() ) { System.out.println("Creations: " + creates + ", Updates: " + updates + "Loads: " + loads); } updates=0; creates=0; loads=0; } }
Session
-scoped and SessionFactory
-scoped.
Session
-scoped interceptor is specified when a session is opened using one of the overloaded SessionFactory.openSession() methods accepting an Interceptor
.
Session session = sf.openSession( new AuditInterceptor() );
SessionFactory
-scoped interceptor is registered with the Configuration
object prior to building the SessionFactory
. Unless a session is opened explicitly specifying the interceptor to use, the supplied interceptor will be applied to all sessions opened from that SessionFactory
. SessionFactory
-scoped interceptors must be thread safe. Ensure that you do not store session-specific states, since multiple sessions will use this interceptor potentially concurrently.
new Configuration().setInterceptor( new AuditInterceptor() );
12.2. Event System
Session
interface correlate to an event. You have a LoadEvent
, a FlushEvent
, etc. Consult the XML configuration-file DTD or the org.hibernate.event
package for the full list of defined event types. When a request is made of one of these methods, the Hibernate Session
generates an appropriate event and passes it to the configured event listeners for that type. Out-of-the-box, these listeners implement the same processing in which those methods always resulted. However, you are free to implement a customization of one of the listener interfaces (i.e., the LoadEvent
is processed by the registered implementation of the LoadEventListener
interface), in which case their implementation would be responsible for processing any load()
requests made of the Session
.
Configuration
object, or specified in the Hibernate configuration XML. Declarative configuration through the properties file is not supported. Here is an example of a custom load event listener:
public class MyLoadListener implements LoadEventListener { // this is the single method defined by the LoadEventListener interface public void onLoad(LoadEvent event, LoadEventListener.LoadType loadType) throws HibernateException { if ( !MySecurity.isAuthorized( event.getEntityClassName(), event.getEntityId() ) ) { throw new MySecurityException("Unauthorized access"); } } }
<hibernate-configuration> <session-factory> ... <event type="load"> <listener class="com.eg.MyLoadListener"/> <listener class="org.hibernate.event.def.DefaultLoadEventListener"/> </event> </session-factory> </hibernate-configuration>
Configuration cfg = new Configuration(); LoadEventListener[] stack = { new MyLoadListener(), new DefaultLoadEventListener() }; cfg.getEventListeners().setLoadEventListeners(stack);
<listener/>
elements, each reference will result in a separate instance of that class. If you need to share listener instances between listener types you must use the programmatic registration approach.
12.3. Hibernate Declarative Security
<listener type="pre-delete" class="org.hibernate.secure.JACCPreDeleteEventListener"/> <listener type="pre-update" class="org.hibernate.secure.JACCPreUpdateEventListener"/> <listener type="pre-insert" class="org.hibernate.secure.JACCPreInsertEventListener"/> <listener type="pre-load" class="org.hibernate.secure.JACCPreLoadEventListener"/>
<listener type="..." class="..."/>
is shorthand for <event type="..."><listener class="..."/></event>
when there is exactly one listener for a particular event type.
hibernate.cfg.xml
, bind the permissions to roles:
<grant role="admin" entity-name="User" actions="insert,update,read"/> <grant role="su" entity-name="User" actions="*"/>
Chapter 13. Batch Processing
13.1. About Batch Processing
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); for ( int i=0; i<100000; i++ ) { Customer customer = new Customer(.....); session.save(customer); } tx.commit(); session.close();
OutOfMemoryException
. That is because Hibernate caches all the newly inserted Customer
instances in the session-level cache. In this chapter we will show you how to avoid this problem.
hibernate.jdbc.batch_size 20
identity
identifier generator.
hibernate.cache.use_second_level_cache false
CacheMode
to disable interaction with the second-level cache.
13.2. Batch Inserts
flush()
and then clear()
the session regularly in order to control the size of the first-level cache.
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); for ( int i=0; i<100000; i++ ) { Customer customer = new Customer(.....); session.save(customer); if ( i % 20 == 0 ) { //20, same as the JDBC batch size //flush a batch of inserts and release memory: session.flush(); session.clear(); } } tx.commit(); session.close();
13.3. Batch Updates
scroll()
to take advantage of server-side cursors for queries that return many rows of data.
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); ScrollableResults customers = session.getNamedQuery("GetCustomers") .setCacheMode(CacheMode.IGNORE) .scroll(ScrollMode.FORWARD_ONLY); int count=0; while ( customers.next() ) { Customer customer = (Customer) customers.get(0); customer.updateStuff(...); if ( ++count % 20 == 0 ) { //flush a batch of updates and release memory: session.flush(); session.clear(); } } tx.commit(); session.close();
13.4. The StatelessSession Interface
StatelessSession
has no persistence context associated with it and does not provide many of the higher-level life cycle semantics. In particular, a stateless session does not implement a first-level cache nor interact with any second-level or query cache. It does not implement transactional write-behind or automatic dirty checking. Operations performed using a stateless session never cascade to associated instances. Collections are ignored by a stateless session. Operations performed via a stateless session bypass Hibernate's event model and interceptors. Due to the lack of a first-level cache, Stateless sessions are vulnerable to data aliasing effects. A stateless session is a lower-level abstraction that is much closer to the underlying JDBC.
StatelessSession session = sessionFactory.openStatelessSession(); Transaction tx = session.beginTransaction(); ScrollableResults customers = session.getNamedQuery("GetCustomers") .scroll(ScrollMode.FORWARD_ONLY); while ( customers.next() ) { Customer customer = (Customer) customers.get(0); customer.updateStuff(...); session.update(customer); } tx.commit(); session.close();
Customer
instances returned by the query are immediately detached. They are never associated with any persistence context.
insert(), update()
and delete()
operations defined by the StatelessSession
interface are considered to be direct database row-level operations. They result in the immediate execution of a SQL INSERT, UPDATE
or DELETE
respectively. They have different semantics to the save(), saveOrUpdate()
and delete()
operations defined by the Session
interface.
13.5. DML-style Operations
Data Manipulation Language
(DML) the statements: INSERT
, UPDATE
, DELETE
) will not affect in-memory state. However, Hibernate provides methods for bulk SQL-style DML statement execution that is performed through the Hibernate Query Language (Refer to the Section 14.1, “About the Hibernate Query Language” for further information).
UPDATE
and DELETE
statements is: ( UPDATE | DELETE ) FROM? EntityName (WHERE where_conditions)?
.
- In the from-clause, the FROM keyword is optional
- There can only be a single entity named in the from-clause. It can, however, be aliased. If the entity name is aliased, then any property references must be qualified using that alias. If the entity name is not aliased, then it is illegal for any property references to be qualified.
- No join syntax forms, either implicit or explicit, can be specified in a bulk HQL query. Sub-queries can be used in the where-clause, where the subqueries themselves may contain joins.
- The where-clause is also optional.
UPDATE
, use the Query.executeUpdate()
method. The method is named for those familiar with JDBC's PreparedStatement.executeUpdate()
:
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); String hqlUpdate = "update Customer c set c.name = :newName where c.name = :oldName"; // or String hqlUpdate = "update Customer set name = :newName where name = :oldName"; int updatedEntities = session.createQuery( hqlUpdate ) .setString( "newName", newName ) .setString( "oldName", oldName ) .executeUpdate(); tx.commit(); session.close();
UPDATE
statements, by default, do not affect the version or timestamp property values for the relevant entities. However, you can force Hibernate to reset the version
or timestamp
property values through the use of a versioned update
. This is achieved by adding the VERSIONED
keyword after the UPDATE
keyword.
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); String hqlVersionedUpdate = "update versioned Customer set name = :newName where name = :oldName"; int updatedEntities = session.createQuery( hqlVersionedUpdate ) .setString( "newName", newName ) .setString( "oldName", oldName ) .executeUpdate(); tx.commit(); session.close();
org.hibernate.usertype.UserVersionType
, are not allowed in conjunction with a update versioned
statement.
DELETE
, use the same Query.executeUpdate()
method:
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); String hqlDelete = "delete Customer c where c.name = :oldName"; // or String hqlDelete = "delete Customer where name = :oldName"; int deletedEntities = session.createQuery( hqlDelete ) .setString( "oldName", oldName ) .executeUpdate(); tx.commit(); session.close();
int
value returned by the Query.executeUpdate()
method indicates the number of entities effected by the operation. This may or may not correlate to the number of rows effected in the database. An HQL bulk operation might result in multiple actual SQL statements being executed (for joined-subclass, for example). The returned number indicates the number of actual entities affected by the statement. Going back to the example of joined-subclass, a delete against one of the subclasses may actually result in deletes against not just the table to which that subclass is mapped, but also the "root" table and potentially joined-subclass tables further down the inheritance hierarchy.
INSERT
statements is: INSERT INTO EntityName properties_list select_statement
. Some points to note:
- Only the INSERT INTO ... SELECT ... form is supported; not the INSERT INTO ... VALUES ... form.The properties_list is analogous to the
column specification
in the SQLINSERT
statement. For entities involved in mapped inheritance, only properties directly defined on that given class-level can be used in the properties_list. Superclass properties are not allowed and subclass properties do not make sense. In other words,INSERT
statements are inherently non-polymorphic. - select_statement can be any valid HQL select query, with the caveat that the return types must match the types expected by the insert. Currently, this is checked during query compilation rather than allowing the check to relegate to the database. This might, however, cause problems between Hibernate
Type
s which are equivalent as opposed to equal. This might cause issues with mismatches between a property defined as aorg.hibernate.type.DateType
and a property defined as aorg.hibernate.type.TimestampType
, even though the database might not make a distinction or might be able to handle the conversion. - For the id property, the insert statement gives you two options. You can either explicitly specify the id property in the properties_list, in which case its value is taken from the corresponding select expression, or omit it from the properties_list, in which case a generated value is used. This latter option is only available when using id generators that operate in the database; attempting to use this option with any "in memory" type generators will cause an exception during parsing. For the purposes of this discussion, in-database generators are considered to be
org.hibernate.id.SequenceGenerator
(and its subclasses) and any implementers oforg.hibernate.id.PostInsertIdentifierGenerator
. The most notable exception here isorg.hibernate.id.TableHiLoGenerator
, which cannot be used because it does not expose a selectable way to get its values. - For properties mapped as either
version
ortimestamp
, the insert statement gives you two options. You can either specify the property in the properties_list, in which case its value is taken from the corresponding select expressions, or omit it from the properties_list, in which case theseed value
defined by theorg.hibernate.type.VersionType
is used.
INSERT
statement execution:
Session session = sessionFactory.openSession(); Transaction tx = session.beginTransaction(); String hqlInsert = "insert into DelinquentAccount (id, name) select c.id, c.name from Customer c where ..."; int createdEntities = session.createQuery( hqlInsert ) .executeUpdate(); tx.commit(); session.close();
Chapter 14. The Hibernate Query Language (HQL)
14.1. About the Hibernate Query Language
14.2. Case Sensitivity
SeLeCT
is the same as sELEct
is the same as SELECT
, but org.hibernate.eg.FOO
is not org.hibernate.eg.Foo
, and foo.barSet
is not foo.BARSET
.
14.3. The From Clause
from eg.Cat
eg.Cat
. You do not usually need to qualify the class name, since auto-import
is the default. For example:
from Cat
Cat
in other parts of the query, you will need to assign an alias. For example:
from Cat as cat
cat
to Cat
instances, so you can use that alias later in the query. The as
keyword is optional. You could also write:
from Cat cat
from Formula, Parameter
from Formula as form, Parameter as param
domesticCat
).
14.4. Associations and Joins
join
. For example:
from Cat as cat inner join cat.mate as mate left outer join cat.kittens as kitten
from Cat as cat left join cat.mate.kittens as kittens
from Formula form full join form.parameter param
inner join
left outer join
right outer join
full join
(not usually useful)
inner join
, left outer join
and right outer join
constructs may be abbreviated.
from Cat as cat join cat.mate as mate left join cat.kittens as kitten
with
keyword.
from Cat as cat left join cat.kittens as kitten with kitten.bodyWeight > 10.0
from Cat as cat inner join fetch cat.mate left join fetch cat.kittens
where
clause (or any other clause). The associated objects are also not returned directly in the query results. Instead, they may be accessed via the parent object. The only reason you might need an alias is if you are recursively join fetching a further collection:
from Cat as cat inner join fetch cat.mate left join fetch cat.kittens child left join fetch child.kittens
Important
fetch
construct cannot be used in queries called using iterate()
(though scroll()
can be used). Fetch
should not be used together with setMaxResults()
or setFirstResult()
, as these operations are based on the result rows which usually contain duplicates for eager collection fetching, hence, the number of rows is not what you would expect. Fetch
should also not be used together with impromptu with
condition. It is possible to create a cartesian product by join fetching more than one collection in a query, so take care in this case. Join fetching multiple collection roles can produce unexpected results for bag mappings, so user discretion is advised when formulating queries in this case. Finally, note that full join fetch
and right join fetch
are not meaningful.
fetch all properties
.
from Document fetch all properties order by name
from Document doc fetch all properties where lower(doc.name) like '%cats%'
14.5. Forms of Join Syntax
implicit
and explicit
.
explicit
form, that is, where the join
keyword is explicitly used in the from clause. This is the recommended form.
implicit
form does not use the join
keyword. Instead, the associations are "dereferenced" using dot-notation. implicit
joins can appear in any of the HQL clauses. implicit
join result in inner joins in the resulting SQL statement.
from Cat as cat where cat.mate.name like '%s%'
14.6. Referring to Identifier Property
- The special property (lowercase)
id
may be used to reference the identifier property of an entity provided that the entity does not define a non-identifier property named id. - If the entity defines a named identifier property, you can use that property name.
id
property can be used to reference the identifier property.
Important
id
always referred to the identifier property regardless of its actual name. A ramification of that decision was that non-identifier properties named id
could never be referenced in Hibernate queries.
14.7. The Select Clause
select
clause picks which objects and properties to return in the query result set. Consider the following:
select mate from Cat as cat inner join cat.mate as mate
mate
s of other Cat
s. You can express this query more compactly as:
select cat.mate from Cat cat
select cat.name from DomesticCat cat where cat.name like 'fri%'
select cust.name.firstName from Customer as cust
Object[]
:
select mother, offspr, mate.name from DomesticCat as mother inner join mother.mate as mate left outer join mother.kittens as offspr
List
:
select new list(mother, offspr, mate.name) from DomesticCat as mother inner join mother.mate as mate left outer join mother.kittens as offspr
Family
has an appropriate constructor - as an actual typesafe Java object:
select new Family(mother, mate, offspr) from DomesticCat as mother join mother.mate as mate left join mother.kittens as offspr
as
:
select max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n from Cat cat
select new map
:
select new map( max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n ) from Cat cat
Map
from aliases to selected values.
14.8. Aggregate Functions
select avg(cat.weight), sum(cat.weight), max(cat.weight), count(cat) from Cat cat
avg(...), sum(...), min(...), max(...)
count(*)
count(...), count(distinct ...), count(all...)
select cat.weight + sum(kitten.weight) from Cat cat join cat.kittens kitten group by cat.id, cat.weight
select firstName||' '||initial||' '||upper(lastName) from Person
distinct
and all
keywords can be used and have the same semantics as in SQL.
select distinct cat.name from Cat cat select count(distinct cat.name), count(cat) from Cat cat
14.9. Polymorphic Queries
from Cat as cat
Cat
, but also of subclasses like DomesticCat
. Hibernate queries can name any Java class or interface in the from
clause. The query will return instances of all persistent classes that extend that class or implement the interface. The following query would return all persistent objects:
from java.lang.Object o
Named
might be implemented by various persistent classes:
from Named n, Named m where n.name = m.name
SELECT
. This means that the order by
clause does not correctly order the whole result set. It also means you cannot call these queries using Query.scroll()
.
14.10. The Where Clause
where
clause allows you to refine the list of instances returned. If no alias exists, you can refer to properties by name:
from Cat where name='Fritz'
from Cat as cat where cat.name='Fritz'
Cat
named 'Fritz'.
select foo from Foo foo, Bar bar where foo.startDate = bar.date
Foo
with an instance of bar
with a date
property equal to the startDate
property of the Foo
. Compound path expressions make the where
clause extremely powerful. Consider the following:
from Cat cat where cat.mate.name is not null
from Foo foo where foo.bar.baz.customer.address.city is not null
=
operator can be used to compare not only properties, but also instances:
from Cat cat, Cat rival where cat.mate = rival.mate
select cat, mate from Cat cat, Cat mate where cat.mate = mate
id
can be used to reference the unique identifier of an object.
from Cat as cat where cat.id = 123 from Cat as cat where cat.mate.id = 69
Person
has composite identifiers consisting of country
and medicareNumber
:
from bank.Person person where person.id.country = 'AU' and person.id.medicareNumber = 123456
from bank.Account account where account.owner.id.country = 'AU' and account.owner.id.medicareNumber = 123456
class
accesses the discriminator value of an instance in the case of polymorphic persistence. A Java class name embedded in the where clause will be translated to its discriminator value.
from Cat cat where cat.class = DomesticCat
id
and class
that allows you to express a join in the following way (where AuditLog.item
is a property mapped with <any>
):
from AuditLog log, Payment payment where log.item.class = 'Payment' and log.item.id = payment.id
log.item.class
and payment.class
would refer to the values of completely different database columns in the above query.
14.11. Expressions
where
clause include the following:
- mathematical operators:
+, -, *, /
- binary comparison operators:
=, >=, <=, <>, !=, like
- logical operations
and, or, not
- Parentheses
( )
that indicates grouping in
,not in
,between
,is null
,is not null
,is empty
,is not empty
,member of
andnot member of
- "Simple" case,
case ... when ... then ... else ... end
, and "searched" case,case when ... then ... else ... end
- string concatenation
...||...
orconcat(...,...)
current_date()
,current_time()
, andcurrent_timestamp()
second(...)
,minute(...)
,hour(...)
,day(...)
,month(...)
, andyear(...)
- Any function or operator defined by EJB-QL 3.0:
substring(), trim(), lower(), upper(), length(), locate(), abs(), sqrt(), bit_length(), mod()
coalesce()
andnullif()
str()
for converting numeric or temporal values to a readable stringcast(... as ...)
, where the second argument is the name of a Hibernate type, andextract(... from ...)
if ANSIcast()
andextract()
is supported by the underlying database- the HQL
index()
function, that applies to aliases of a joined indexed collection - HQL functions that take collection-valued path expressions:
size(), minelement(), maxelement(), minindex(), maxindex()
, along with the specialelements()
andindices
functions that can be quantified usingsome, all, exists, any, in
. - Any database-supported SQL scalar function like
sign()
,trunc()
,rtrim()
, andsin()
- JDBC-style positional parameters
?
- named parameters
:name
,:start_date
, and:x1
- SQL literals
'foo'
,69
,6.66E+2
,'1970-01-01 10:00:01.0'
- Java
public static final
constantseg.Color.TABBY
in
and between
can be used as follows:
from DomesticCat cat where cat.name between 'A' and 'B'
from DomesticCat cat where cat.name in ( 'Foo', 'Bar', 'Baz' )
from DomesticCat cat where cat.name not between 'A' and 'B'
from DomesticCat cat where cat.name not in ( 'Foo', 'Bar', 'Baz' )
is null
and is not null
can be used to test for null values.
<property name="hibernate.query.substitutions">true 1, false 0</property>
true
and false
with the literals 1
and 0
in the translated SQL from this HQL:
from Cat cat where cat.alive = true
size
or the special size()
function.
from Cat cat where cat.kittens.size > 0
from Cat cat where size(cat.kittens) > 0
minindex
and maxindex
functions. Similarly, you can refer to the minimum and maximum elements of a collection of basic type using the minelement
and maxelement
functions. For example:
from Calendar cal where maxelement(cal.holidays) > current_date
from Order order where maxindex(order.items) > 100
from Order order where minelement(order.items) > 10000
any, some, all, exists, in
are supported when passed the element or index set of a collection (elements
and indices
functions) or the result of a subquery (see below):
select mother from Cat as mother, Cat as kit where kit in elements(foo.kittens)
select p from NameList list, Person p where p.name = some elements(list.names)
from Cat cat where exists elements(cat.kittens)
from Player p where 3 > all elements(p.scores)
from Show show where 'fizard' in indices(show.acts)
size
, elements
, indices
, minindex
, maxindex
, minelement
, maxelement
- can only be used in the where clause in Hibernate3.
from Order order where order.items[0].id = 1234
select person from Person person, Calendar calendar where calendar.holidays['national day'] = person.birthDay and person.nationality.calendar = calendar
select item from Item item, Order order where order.items[ order.deliveredItemIndices[0] ] = item and order.id = 11
select item from Item item, Order order where order.items[ maxindex(order.items) ] = item and order.id = 11
[]
can even be an arithmetic expression:
select item from Item item, Order order where order.items[ size(order.items) - 1 ] = item
index()
function for elements of a one-to-many association or collection of values.
select item, index(item) from Order order join order.items item where index(item) < 5
from DomesticCat cat where upper(cat.name) like 'FRI%'
select cust from Product prod, Store store inner join store.customers cust where prod.name = 'widget' and store.location.name in ( 'Melbourne', 'Sydney' ) and prod = all elements(cust.currentOrder.lineItems)
SELECT cust.name, cust.address, cust.phone, cust.id, cust.current_order FROM customers cust, stores store, locations loc, store_customers sc, product prod WHERE prod.name = 'widget' AND store.loc_id = loc.id AND loc.name IN ( 'Melbourne', 'Sydney' ) AND sc.store_id = store.id AND sc.cust_id = cust.id AND prod.id = ALL( SELECT item.prod_id FROM line_items item, orders o WHERE item.order_id = o.id AND cust.current_order = o.id )
14.12. The Order by Clause
from DomesticCat cat order by cat.name asc, cat.weight desc, cat.birthdate
asc
or desc
indicate ascending or descending order respectively.
14.13. The Group by Clause
select cat.color, sum(cat.weight), count(cat) from Cat cat group by cat.color
select foo.id, avg(name), max(name) from Foo foo join foo.names name group by foo.id
having
clause is also allowed.
select cat.color, sum(cat.weight), count(cat) from Cat cat group by cat.color having cat.color in (eg.Color.TABBY, eg.Color.BLACK)
having
and order by
clauses if they are supported by the underlying database (i.e., not in MySQL).
select cat from Cat cat join cat.kittens kitten group by cat.id, cat.name, cat.other, cat.properties having avg(kitten.weight) > 100 order by count(kitten) asc, sum(kitten.weight) desc
group by
clause nor the order by
clause can contain arithmetic expressions. Hibernate also does not currently expand a grouped entity, so you cannot write group by cat
if all properties of cat
are non-aggregated. You have to list all non-aggregated properties explicitly.
14.14. Subqueries
from Cat as fatcat where fatcat.weight > ( select avg(cat.weight) from DomesticCat cat )
from DomesticCat as cat where cat.name = some ( select name.nickName from Name as name )
from Cat as cat where not exists ( from Cat as mate where mate.mate = cat )
from DomesticCat as cat where cat.name not in ( select name.nickName from Name as name )
select cat.id, (select max(kit.weight) from cat.kitten kit) from Cat as cat
row value constructor
syntax. Refer to Section 14.19, “Row Value Constructor Syntax” for further information.
14.15. HQL Examples
ORDER
, ORDER_LINE
, PRODUCT
, CATALOG
and PRICE
tables has four inner joins and an (uncorrelated) subselect.
select order.id, sum(price.amount), count(item) from Order as order join order.lineItems as item join item.product as product, Catalog as catalog join catalog.prices as price where order.paid = false and order.customer = :customer and price.product = product and catalog.effectiveDate < sysdate and catalog.effectiveDate >= all ( select cat.effectiveDate from Catalog as cat where cat.effectiveDate < sysdate ) group by order having sum(price.amount) > :minAmount order by sum(price.amount) desc
select order.id, sum(price.amount), count(item) from Order as order join order.lineItems as item join item.product as product, Catalog as catalog join catalog.prices as price where order.paid = false and order.customer = :customer and price.product = product and catalog = :currentCatalog group by order having sum(price.amount) > :minAmount order by sum(price.amount) desc
AWAITING_APPROVAL
status where the most recent status change was made by the current user. It translates to an SQL query with two inner joins and a correlated subselect of the PAYMENT
, PAYMENT_STATUS
and PAYMENT_STATUS_CHANGE
tables.
select count(payment), status.name from Payment as payment join payment.currentStatus as status join payment.statusChanges as statusChange where payment.status.name <> PaymentStatus.AWAITING_APPROVAL or ( statusChange.timeStamp = ( select max(change.timeStamp) from PaymentStatusChange change where change.payment = payment ) and statusChange.user <> :currentUser ) group by status.name, status.sortOrder order by status.sortOrder
statusChanges
collection was mapped as a list, instead of a set, the query would have been much simpler to write.
select count(payment), status.name from Payment as payment join payment.currentStatus as status where payment.status.name <> PaymentStatus.AWAITING_APPROVAL or payment.statusChanges[ maxIndex(payment.statusChanges) ].user <> :currentUser group by status.name, status.sortOrder order by status.sortOrder
isNull()
function to return all the accounts and unpaid payments for the organization to which the current user belongs. It translates to an SQL query with three inner joins, an outer join and a subselect from the ACCOUNT
, PAYMENT
, PAYMENT_STATUS
, ACCOUNT_TYPE
, ORGANIZATION
and ORG_USER
tables.
select account, payment from Account as account left outer join account.payments as payment where :currentUser in elements(account.holder.users) and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) order by account.type.sortOrder, account.accountNumber, payment.dueDate
select account, payment from Account as account join account.holder.users as user left outer join account.payments as payment where :currentUser = user and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) order by account.type.sortOrder, account.accountNumber, payment.dueDate
14.16. Bulk Update and Delete
update
, delete
and insert ... select ...
statements. Refer to the the "DML-style Operations" section for further information.
14.17. HQL Tips
( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue()
select usr.id, usr.name from User as usr left join usr.messages as msg group by usr.id, usr.name order by count(msg)
from User usr where size(usr.messages) >= 1
select usr.id, usr.name from User usr join usr.messages msg group by usr.id, usr.name having count(msg) >= 1
User
with zero messages because of the inner join, the following form is also useful:
select usr.id, usr.name from User as usr left join usr.messages as msg group by usr.id, usr.name having count(msg) = 0
Query q = s.createQuery("from foo Foo as foo where foo.name=:name and foo.size=:size"); q.setProperties(fooBean); // fooBean has getName() and getSize() List foos = q.list();
Query
interface with a filter:
Query q = s.createFilter( collection, "" ); // the trivial filter q.setMaxResults(PAGE_SIZE); q.setFirstResult(PAGE_SIZE * pageNumber); List page = q.list();
Collection orderedCollection = s.createFilter( collection, "order by this.amount" ).list(); Collection counts = s.createFilter( collection, "select this.type, count(this) group by this.type" ).list();
( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue();
14.18. Components
select
clause as follows:
select p.name from Person p
select p.name.first from Person p
where
clause:
from Person p where p.name = :name
from Person p where p.name.first = :firstName
order by
clause:
from Person p order by p.name
from Person p order by p.name.first
14.19. Row Value Constructor Syntax
row value constructor
syntax, sometimes referred to AS tuple
syntax, even though the underlying database may not support that notion. Here, we are generally referring to multi-valued comparisons, typically associated with components. Consider an entity Person which defines a name component:
from Person p where p.name.first='John' and p.name.last='Jingleheimer-Schmidt'
row value constructor
syntax:
from Person p where p.name=('John', 'Jingleheimer-Schmidt')
select
clause:
select p.name from Person p
row value constructor
syntax can also be beneficial when using subqueries that need to compare multiple values:
from Cat as cat where not ( cat.name, cat.color ) in ( select cat.name, cat.color from DomesticCat cat )
Chapter 15. Criteria Queries
15.1. Creating a Criteria Instance
org.hibernate.Criteria
represents a query against a particular persistent class. The Session
is a factory for Criteria
instances.
Criteria crit = sess.createCriteria(Cat.class); crit.setMaxResults(50); List cats = crit.list();
15.2. Narrowing the Result Set
org.hibernate.criterion.Criterion
. The class org.hibernate.criterion.Restrictions
defines factory methods for obtaining certain built-in Criterion
types.
List cats = sess.createCriteria(Cat.class) .add( Restrictions.like("name", "Fritz%") ) .add( Restrictions.between("weight", minWeight, maxWeight) ) .list();
List cats = sess.createCriteria(Cat.class) .add( Restrictions.like("name", "Fritz%") ) .add( Restrictions.or( Restrictions.eq( "age", new Integer(0) ), Restrictions.isNull("age") ) ) .list();
List cats = sess.createCriteria(Cat.class) .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) ) .add( Restrictions.disjunction() .add( Restrictions.isNull("age") ) .add( Restrictions.eq("age", new Integer(0) ) ) .add( Restrictions.eq("age", new Integer(1) ) ) .add( Restrictions.eq("age", new Integer(2) ) ) ) .list();
Restrictions
subclasses). One of the most useful allows you to specify SQL directly.
List cats = sess.createCriteria(Cat.class) .add( Restrictions.sqlRestriction("lower({alias}.name) like lower(?)", "Fritz%", Hibernate.STRING) ) .list();
{alias}
placeholder with be replaced by the row alias of the queried entity.
Property
instance. You can create a Property
by calling Property.forName()
:
Property age = Property.forName("age"); List cats = sess.createCriteria(Cat.class) .add( Restrictions.disjunction() .add( age.isNull() ) .add( age.eq( new Integer(0) ) ) .add( age.eq( new Integer(1) ) ) .add( age.eq( new Integer(2) ) ) ) .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) ) .list();
15.3. Ordering the results
org.hibernate.criterion.Order
.
List cats = sess.createCriteria(Cat.class) .add( Restrictions.like("name", "F%") ) .addOrder( Order.asc("name") ) .addOrder( Order.desc("age") ) .setMaxResults(50) .list();
List cats = sess.createCriteria(Cat.class) .add( Property.forName("name").like("F%") ) .addOrder( Property.forName("name").asc() ) .addOrder( Property.forName("age").desc() ) .setMaxResults(50) .list();
15.4. Associations
createCriteria()
you can specify constraints upon related entities:
List cats = sess.createCriteria(Cat.class) .add( Restrictions.like("name", "F%") ) .createCriteria("kittens") .add( Restrictions.like("name", "F%") ) .list();
createCriteria()
returns a new instance of Criteria
that refers to the elements of the kittens
collection.
List cats = sess.createCriteria(Cat.class) .createAlias("kittens", "kt") .createAlias("mate", "mt") .add( Restrictions.eqProperty("kt.name", "mt.name") ) .list();
createAlias()
does not create a new instance of Criteria
.)
Cat
instances returned by the previous two queries are not pre-filtered by the criteria. If you want to retrieve just the kittens that match the criteria, you must use a ResultTransformer
.
List cats = sess.createCriteria(Cat.class) .createCriteria("kittens", "kt") .add( Restrictions.eq("name", "F%") ) .setResultTransformer(Criteria.ALIAS_TO_ENTITY_MAP) .list(); Iterator iter = cats.iterator(); while ( iter.hasNext() ) { Map map = (Map) iter.next(); Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS); Cat kitten = (Cat) map.get("kt"); }
15.5. Dynamic Association Fetching
setFetchMode()
.
List cats = sess.createCriteria(Cat.class) .add( Restrictions.like("name", "Fritz%") ) .setFetchMode("mate", FetchMode.EAGER) .setFetchMode("kittens", FetchMode.EAGER) .list();
mate
and kittens
by outer join.
15.6. Example Queries
org.hibernate.criterion.Example
allows you to construct a query criterion from a given instance.
Cat cat = new Cat(); cat.setSex('F'); cat.setColor(Color.BLACK); List results = session.createCriteria(Cat.class) .add( Example.create(cat) ) .list();
Example
is applied.
Example example = Example.create(cat) .excludeZeroes() //exclude zero valued properties .excludeProperty("color") //exclude the property named "color" .ignoreCase() //perform case insensitive string comparisons .enableLike(); //use like for string comparisons List results = session.createCriteria(Cat.class) .add(example) .list();
List results = session.createCriteria(Cat.class) .add( Example.create(cat) ) .createCriteria("mate") .add( Example.create( cat.getMate() ) ) .list();
15.7. Projections, Aggregation and Grouping
org.hibernate.criterion.Projections
is a factory for Projection
instances. You can apply a projection to a query by calling setProjection()
.
List results = session.createCriteria(Cat.class) .setProjection( Projections.rowCount() ) .add( Restrictions.eq("color", Color.BLACK) ) .list();
List results = session.createCriteria(Cat.class) .setProjection( Projections.projectionList() .add( Projections.rowCount() ) .add( Projections.avg("weight") ) .add( Projections.max("weight") ) .add( Projections.groupProperty("color") ) ) .list();
group by
clause.
List results = session.createCriteria(Cat.class) .setProjection( Projections.alias( Projections.groupProperty("color"), "colr" ) ) .addOrder( Order.asc("colr") ) .list();
List results = session.createCriteria(Cat.class) .setProjection( Projections.groupProperty("color").as("colr") ) .addOrder( Order.asc("colr") ) .list();
alias()
and as()
methods simply wrap a projection instance in another, aliased, instance of Projection
. As a shortcut, you can assign an alias when you add the projection to a projection list:
List results = session.createCriteria(Cat.class) .setProjection( Projections.projectionList() .add( Projections.rowCount(), "catCountByColor" ) .add( Projections.avg("weight"), "avgWeight" ) .add( Projections.max("weight"), "maxWeight" ) .add( Projections.groupProperty("color"), "color" ) ) .addOrder( Order.desc("catCountByColor") ) .addOrder( Order.desc("avgWeight") ) .list();
List results = session.createCriteria(Domestic.class, "cat") .createAlias("kittens", "kit") .setProjection( Projections.projectionList() .add( Projections.property("cat.name"), "catName" ) .add( Projections.property("kit.name"), "kitName" ) ) .addOrder( Order.asc("catName") ) .addOrder( Order.asc("kitName") ) .list();
Property.forName()
to express projections:
List results = session.createCriteria(Cat.class) .setProjection( Property.forName("name") ) .add( Property.forName("color").eq(Color.BLACK) ) .list();
List results = session.createCriteria(Cat.class) .setProjection( Projections.projectionList() .add( Projections.rowCount() ) .add( Property.forName("weight").avg().as("avgWeight") ) .add( Property.forName("weight").max().as("maxWeight") ) .add( Property.forName("color").group().as("color" ) ) ) .addOrder( Order.desc("catCountByColor") ) .addOrder( Order.desc("avgWeight") ) .list();
15.8. Detached Queries and Subqueries
DetachedCriteria
class allows you to create a query outside the scope of a session and then execute it using an arbitrary Session
.
DetachedCriteria query = DetachedCriteria.forClass(Cat.class) .add( Property.forName("sex").eq('F') ); Session session = ....; Transaction txn = session.beginTransaction(); List results = query.getExecutableCriteria(session).setMaxResults(100).list(); txn.commit(); session.close();
DetachedCriteria
can also be used to express a subquery. Criterion instances involving subqueries can be obtained via Subqueries
or Property
.
DetachedCriteria avgWeight = DetachedCriteria.forClass(Cat.class) .setProjection( Property.forName("weight").avg() ); session.createCriteria(Cat.class) .add( Property.forName("weight").gt(avgWeight) ) .list();
DetachedCriteria weights = DetachedCriteria.forClass(Cat.class) .setProjection( Property.forName("weight") ); session.createCriteria(Cat.class) .add( Subqueries.geAll("weight", weights) ) .list();
DetachedCriteria avgWeightForSex = DetachedCriteria.forClass(Cat.class, "cat2") .setProjection( Property.forName("weight").avg() ) .add( Property.forName("cat2.sex").eqProperty("cat.sex") ); session.createCriteria(Cat.class, "cat") .add( Property.forName("weight").gt(avgWeightForSex) ) .list();
15.9. Queries by Natural Identifier
<natural-id>
and enable use of the second-level cache.
<class name="User"> <cache usage="read-write"/> <id name="id"> <generator class="increment"/> </id> <natural-id> <property name="name"/> <property name="org"/> </natural-id> <property name="password"/> </class>
Restrictions.naturalId()
allows you to make use of the more efficient cache algorithm.
session.createCriteria(User.class) .add( Restrictions.naturalId() .set("name", "gavin") .set("org", "hb") ).setCacheable(true) .uniqueResult();
Chapter 16. Native SQL
16.1. About Native SQL
SQLQuery
interface, which is obtained by calling Session.createSQLQuery()
. The following sections describe how to use this API for querying.
16.2. Using SQLQueries
16.2.1. Scalar Queries
sess.createSQLQuery("SELECT * FROM CATS").list(); sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").list();
ResultSetMetadata
, or simply to be more explicit in what is returned, one can use addScalar()
:
sess.createSQLQuery("SELECT * FROM CATS") .addScalar("ID", Hibernate.LONG) .addScalar("NAME", Hibernate.STRING) .addScalar("BIRTHDATE", Hibernate.DATE);
- the SQL query string
- the columns and types to return
ResultSetMetadata
but will instead explicitly get the ID, NAME and BIRTHDATE column as respectively a Long, String and a Short from the underlying resultset. This also means that only these three columns will be returned, even though the query is using *
and could return more than the three listed columns.
sess.createSQLQuery("SELECT * FROM CATS") .addScalar("ID", Hibernate.LONG) .addScalar("NAME") .addScalar("BIRTHDATE");
ResultSetMetaData
is used to determine the type of NAME and BIRTHDATE, where as the type of ID is explicitly specified.
registerHibernateType
in the Dialect.
16.2.2. Entity Queries
addEntity()
.
sess.createSQLQuery("SELECT * FROM CATS").addEntity(Cat.class); sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").addEntity(Cat.class);
- the SQL query string
- the entity returned by the query
many-to-one
to another entity it is required to also return this when performing the native query, otherwise a database specific "column not found" error will occur. The additional columns will automatically be returned when using the * notation, but we prefer to be explicit as in the following example for a many-to-one
to a Dog
:
sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, DOG_ID FROM CATS").addEntity(Cat.class);
16.2.3. Handling Associations and Collections
Dog
to avoid the possible extra roundtrip for initializing the proxy. This is done via the addJoin()
method, which allows you to join in an association or collection.
sess.createSQLQuery("SELECT c.ID, NAME, BIRTHDATE, DOG_ID, D_ID, D_NAME FROM CATS c, DOGS d WHERE c.DOG_ID = d.D_ID") .addEntity("cat", Cat.class) .addJoin("dog", "cat.dog");
Cat
's will have their dog
property fully initialized without any extra roundtrip to the database. Notice that you added an alias name ("cat") to be able to specify the target property path of the join. It is possible to do the same eager joining for collections, e.g. if the Cat
had a one-to-many to Dog
instead.
sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, D_ID, D_NAME, CAT_ID FROM CATS c, DOGS d WHERE c.ID = d.CAT_ID") .addEntity("cat", Cat.class) .addJoin("dog", "cat.dogs");
16.2.4. Returning Multiple Entities
sess.createSQLQuery("SELECT c.*, m.* FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID") .addEntity("cat", Cat.class) .addEntity("mother", Cat.class)
sess.createSQLQuery("SELECT {cat.*}, {mother.*} FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID") .addEntity("cat", Cat.class) .addEntity("mother", Cat.class)
- the SQL query string, with placeholders for Hibernate to inject column aliases
- the entities returned by the query
String sql = "SELECT ID as {c.id}, NAME as {c.name}, " + "BIRTHDATE as {c.birthDate}, MOTHER_ID as {c.mother}, {mother.*} " + "FROM CAT_LOG c, CAT_LOG m WHERE {c.mother} = c.ID"; List loggedCats = sess.createSQLQuery(sql) .addEntity("cat", Cat.class) .addEntity("mother", Cat.class).list()
16.2.5. Returning Non-managed Entities
Table 16.1. Alias injection names
Description | Syntax | Example |
---|---|---|
A simple property | {[aliasname].[propertyname]} | A_NAME as {item.name} |
A composite property | {[aliasname].[componentname].[propertyname]} | CURRENCY as {item.amount.currency}, VALUE as {item.amount.value} |
Discriminator of an entity | {[aliasname].class} | DISC as {item.class} |
All properties of an entity | {[aliasname].*} | {item.*} |
A collection key | {[aliasname].key} | ORGID as {coll.key} |
The id of an collection | {[aliasname].id} | EMPID as {coll.id} |
The element of an collection | {[aliasname].element} | XID as {coll.element} |
property of the element in the collection | {[aliasname].element.[propertyname]} | NAME as {coll.element.name} |
All properties of the element in the collection | {[aliasname].element.*} | {coll.element.*} |
All properties of the the collection | {[aliasname].*} | {coll.*} |
16.2.6. Handling Inheritance
16.2.7. Parameters
Query query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like ?").addEntity(Cat.class); List pusList = query.setString(0, "Pus%").list(); query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like :name").addEntity(Cat.class); List pusList = query.setString("name", "Pus%").list();
16.3. Named SQL Queries
16.3.1. About Named SQL Queries
addEntity()
.
<sql-query name="persons"> <return alias="person" class="eg.Person"/> SELECT person.NAME AS {person.name}, person.AGE AS {person.age}, person.SEX AS {person.sex} FROM PERSON person WHERE person.NAME LIKE :namePattern </sql-query>
List people = sess.getNamedQuery("persons") .setString("namePattern", namePattern) .setMaxResults(50) .list();
<return-join>
element is use to join associations and the <load-collection>
element is used to define queries which initialize collections,
<sql-query name="personsWith"> <return alias="person" class="eg.Person"/> <return-join alias="address" property="person.mailingAddress"/> SELECT person.NAME AS {person.name}, person.AGE AS {person.age}, person.SEX AS {person.sex}, address.STREET AS {address.street}, address.CITY AS {address.city}, address.STATE AS {address.state}, address.ZIP AS {address.zip} FROM PERSON person JOIN ADDRESS address ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' WHERE person.NAME LIKE :namePattern </sql-query>
<return-scalar>
element:
<sql-query name="mySqlQuery"> <return-scalar column="name" type="string"/> <return-scalar column="age" type="long"/> SELECT p.NAME AS name, p.AGE AS age, FROM PERSON p WHERE p.NAME LIKE 'Hiber%' </sql-query>
<resultset>
element which will allow you to either reuse them across several named queries or through the setResultSetMapping()
API.
<resultset name="personAddress"> <return alias="person" class="eg.Person"/> <return-join alias="address" property="person.mailingAddress"/> </resultset> <sql-query name="personsWith" resultset-ref="personAddress"> SELECT person.NAME AS {person.name}, person.AGE AS {person.age}, person.SEX AS {person.sex}, address.STREET AS {address.street}, address.CITY AS {address.city}, address.STATE AS {address.state}, address.ZIP AS {address.zip} FROM PERSON person JOIN ADDRESS address ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' WHERE person.NAME LIKE :namePattern </sql-query>
List cats = sess.createSQLQuery( "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id" ) .setResultSetMapping("catAndKitten") .list();
16.3.2. Using return-property to Explicitly Specify Column/Alias Names
<return-property>
, instead of using the {}
-syntax to let Hibernate inject its own aliases.For example:
<sql-query name="mySqlQuery"> <return alias="person" class="eg.Person"> <return-property name="name" column="myName"/> <return-property name="age" column="myAge"/> <return-property name="sex" column="mySex"/> </return> SELECT person.NAME AS myName, person.AGE AS myAge, person.SEX AS mySex, FROM PERSON person WHERE person.NAME LIKE :name </sql-query>
<return-property>
also works with multiple columns. This solves a limitation with the {}
-syntax which cannot allow fine grained control of multi-column properties.
<sql-query name="organizationCurrentEmployments"> <return alias="emp" class="Employment"> <return-property name="salary"> <return-column name="VALUE"/> <return-column name="CURRENCY"/> </return-property> <return-property name="endDate" column="myEndDate"/> </return> SELECT EMPLOYEE AS {emp.employee}, EMPLOYER AS {emp.employer}, STARTDATE AS {emp.startDate}, ENDDATE AS {emp.endDate}, REGIONCODE as {emp.regionCode}, EID AS {emp.id}, VALUE, CURRENCY FROM EMPLOYMENT WHERE EMPLOYER = :id AND ENDDATE IS NULL ORDER BY STARTDATE ASC </sql-query>
<return-property>
was used in combination with the {}
-syntax for injection. This allows users to choose how they want to refer column and properties.
<return-discriminator>
to specify the discriminator column.
16.3.3. Using Stored Procedures for Querying
CREATE OR REPLACE FUNCTION selectAllEmployments RETURN SYS_REFCURSOR AS st_cursor SYS_REFCURSOR; BEGIN OPEN st_cursor FOR SELECT EMPLOYEE, EMPLOYER, STARTDATE, ENDDATE, REGIONCODE, EID, VALUE, CURRENCY FROM EMPLOYMENT; RETURN st_cursor; END;
<sql-query name="selectAllEmployees_SP" callable="true"> <return alias="emp" class="Employment"> <return-property name="employee" column="EMPLOYEE"/> <return-property name="employer" column="EMPLOYER"/> <return-property name="startDate" column="STARTDATE"/> <return-property name="endDate" column="ENDDATE"/> <return-property name="regionCode" column="REGIONCODE"/> <return-property name="id" column="EID"/> <return-property name="salary"> <return-column name="VALUE"/> <return-column name="CURRENCY"/> </return-property> </return> { ? = call selectAllEmployments() } </sql-query>
<return-join>
and <load-collection>
are not supported.
16.3.4. Rules/limitations for Using Stored Procedures
session.connection()
. The rules are different for each database, since database vendors have different stored procedure semantics/syntax.
setFirstResult()/setMaxResults()
.
{ ? = call functionName(<parameters>) }
or { ? = call procedureName(<parameters>}
. Native call syntax is not supported.
- A function must return a result set. The first parameter of a procedure must be an
OUT
that returns a result set. This is done by using aSYS_REFCURSOR
type in Oracle 9 or 10. In Oracle you need to define aREF CURSOR
type. See Oracle literature for further information.
- The procedure must return a result set. Note that since these servers can return multiple result sets and update counts, Hibernate will iterate the results and take the first result that is a result set as its return value. Everything else will be discarded.
- If you can enable
SET NOCOUNT ON
in your procedure it will probably be more efficient, but this is not a requirement.
16.4. Additional SQL Functions
16.4.1. Custom SQL for Create, Update and Delete
<sql-insert>
, <sql-delete>
, and <sql-update>
override these strings:
<class name="Person"> <id name="id"> <generator class="increment"/> </id> <property name="name" not-null="true"/> <sql-insert>INSERT INTO PERSON (NAME, ID) VALUES ( UPPER(?), ? )</sql-insert> <sql-update>UPDATE PERSON SET NAME=UPPER(?) WHERE ID=?</sql-update> <sql-delete>DELETE FROM PERSON WHERE ID=?</sql-delete> </class>
callable
attribute is set:
<class name="Person"> <id name="id"> <generator class="increment"/> </id> <property name="name" not-null="true"/> <sql-insert callable="true">{call createPerson (?, ?)}</sql-insert> <sql-delete callable="true">{? = call deletePerson (?)}</sql-delete> <sql-update callable="true">{? = call updatePerson (?, ?)}</sql-update> </class>
org.hibernate.persister.entity
level. With this level enabled, Hibernate will print out the static SQL that is used to create, update, delete etc. entities. To view the expected sequence, do not include your custom SQL in the mapping files, as this will override the Hibernate generated static SQL.
CREATE OR REPLACE FUNCTION updatePerson (uid IN NUMBER, uname IN VARCHAR2) RETURN NUMBER IS BEGIN update PERSON set NAME = uname, where ID = uid; return SQL%ROWCOUNT; END updatePerson;
16.4.2. Custom SQL for Loading
<sql-query name="person"> <return alias="pers" class="Person" lock-mode="upgrade"/> SELECT NAME AS {pers.name}, ID AS {pers.id} FROM PERSON WHERE ID=? FOR UPDATE </sql-query>
<class name="Person"> <id name="id"> <generator class="increment"/> </id> <property name="name" not-null="true"/> <loader query-ref="person"/> </class>
<set name="employments" inverse="true"> <key/> <one-to-many class="Employment"/> <loader query-ref="employments"/> </set>
<sql-query name="employments"> <load-collection alias="emp" role="Person.employments"/> SELECT {emp.*} FROM EMPLOYMENT emp WHERE EMPLOYER = :id ORDER BY STARTDATE ASC, EMPLOYEE ASC </sql-query>
<sql-query name="person"> <return alias="pers" class="Person"/> <return-join alias="emp" property="pers.employments"/> SELECT NAME AS {pers.*}, {emp.*} FROM PERSON pers LEFT OUTER JOIN EMPLOYMENT emp ON pers.ID = emp.PERSON_ID WHERE ID=? </sql-query>
Chapter 17. Filtering Data
17.1. About Filtering Data
17.2. About Hibernate Filters
17.3. Using Hibernate Filters
<filter-def/>
element within a <hibernate-mapping/>
element:
<filter-def name="myFilter"> <filter-param name="myFilterParam" type="string"/> </filter-def>
<class name="myClass" ...> ... <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> </class>
<set ...> <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> </set>
Session
are: enableFilter(String filterName)
, getEnabledFilter(String filterName)
, and disableFilter(String filterName)
. By default, filters are not enabled for a given session. Filters must be enabled through use of the Session.enableFilter()
method, which returns an instance of the Filter
interface. If you used the simple filter defined above, it would look like this:
session.enableFilter("myFilter").setParameter("myFilterParam", "some-value");
org.hibernate.Filter
interface do allow the method-chaining common to much of Hibernate.
17.4. Hibernate Filters Example
<filter-def name="effectiveDate"> <filter-param name="asOfDate" type="date"/> </filter-def> <class name="Employee" ...> ... <many-to-one name="department" column="dept_id" class="Department"/> <property name="effectiveStartDate" type="date" column="eff_start_dt"/> <property name="effectiveEndDate" type="date" column="eff_end_dt"/> ... <!-- Note that this assumes non-terminal records have an eff_end_dt set to a max db date for simplicity-sake --> <filter name="effectiveDate" condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> </class> <class name="Department" ...> ... <set name="employees" lazy="true"> <key column="dept_id"/> <one-to-many class="Employee"/> <filter name="effectiveDate" condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> </set> </class>
Session session = ...; session.enableFilter("effectiveDate").setParameter("asOfDate", new Date()); List results = session.createQuery("from Employee as e where e.salary > :targetSalary") .setLong("targetSalary", new Long(1000000)) .list();
<filter-def/>
allows you to definine a default condition, either as an attribute or CDATA:
<filter-def name="myFilter" condition="abc > xyz">...</filter-def> <filter-def name="myOtherFilter">abc=xyz</filter-def>
Chapter 18. XML Mapping
18.1. Working with XML Data
18.1.1. About Working with XML Data
persist(), saveOrUpdate(), merge(), delete(), replicate()
(merging is not yet supported).
18.1.2. Specifying XML and Class Mapping Together
<class name="Account" table="ACCOUNTS" node="account"> <id name="accountId" column="ACCOUNT_ID" node="@id"/> <many-to-one name="customer" column="CUSTOMER_ID" node="customer/@id" embed-xml="false"/> <property name="balance" column="BALANCE" node="balance"/> ... </class>
18.1.3. Specifying Only an XML Mapping
<class entity-name="Account" table="ACCOUNTS" node="account"> <id name="id" column="ACCOUNT_ID" node="@id" type="string"/> <many-to-one name="customerId" column="CUSTOMER_ID" node="customer/@id" embed-xml="false" entity-name="Customer"/> <property name="balance" column="BALANCE" node="balance" type="big_decimal"/> ... </class>
Map
s. The property names are purely logical constructs that can be referred to in HQL queries.
18.2. XML Mapping Metadata
18.2.1. About XML Mapping Metadata
node
attribute. This lets you specify the name of an XML attribute or element that holds the property or entity data. The format of the node
attribute must be one of the following:
"element-name"
: map to the named XML element"@attribute-name"
: map to the named XML attribute"."
: map to the parent element"element-name/@attribute-name"
: map to the named attribute of the named element
embed-xml
attribute. If embed-xml="true"
, the default, the XML tree for the associated entity (or collection of value type) will be embedded directly in the XML tree for the entity that owns the association. Otherwise, if embed-xml="false"
, then only the referenced identifier value will appear in the XML for single point associations and collections will not appear at all.
embed-xml="true"
for too many associations, since XML does not deal well with circularity.
<class name="Customer" table="CUSTOMER" node="customer"> <id name="id" column="CUST_ID" node="@id"/> <map name="accounts" node="." embed-xml="true"> <key column="CUSTOMER_ID" not-null="true"/> <map-key column="SHORT_DESC" node="@short-desc" type="string"/> <one-to-many entity-name="Account" embed-xml="false" node="account"/> </map> <component name="name" node="name"> <property name="firstName" node="first-name"/> <property name="initial" node="initial"/> <property name="lastName" node="last-name"/> </component> ... </class>
from Customer c left join fetch c.accounts where c.lastName like :lastName
<customer id="123456789"> <account short-desc="Savings">987632567</account> <account short-desc="Credit Card">985612323</account> <name> <first-name>Gavin</first-name> <initial>A</initial> <last-name>King</last-name> </name> ... </customer>
embed-xml="true"
on the <one-to-many>
mapping, the data might look more like this:
<customer id="123456789"> <account id="987632567" short-desc="Savings"> <customer id="123456789"/> <balance>100.29</balance> </account> <account id="985612323" short-desc="Credit Card"> <customer id="123456789"/> <balance>-2370.34</balance> </account> <name> <first-name>Gavin</first-name> <initial>A</initial> <last-name>King</last-name> </name> ... </customer>
18.2.2. Manipulating XML Data
Document doc = ....; Session session = factory.openSession(); Session dom4jSession = session.getSession(EntityMode.DOM4J); Transaction tx = session.beginTransaction(); List results = dom4jSession .createQuery("from Customer c left join fetch c.accounts where c.lastName like :lastName") .list(); for ( int i=0; i<results.size(); i++ ) { //add the customer data to the XML document Element customer = (Element) results.get(i); doc.add(customer); } tx.commit(); session.close();
Session session = factory.openSession(); Session dom4jSession = session.getSession(EntityMode.DOM4J); Transaction tx = session.beginTransaction(); Element cust = (Element) dom4jSession.get("Customer", customerId); for ( int i=0; i<results.size(); i++ ) { Element customer = (Element) results.get(i); //change the customer name in the XML and database Element name = customer.element("name"); name.element("first-name").setText(firstName); name.element("initial").setText(initial); name.element("last-name").setText(lastName); } tx.commit(); session.close();
replicate()
operation.
Chapter 19. Improving Performance
19.1. Fetching Strategies
19.1.1. About Fetching Strategies
Criteria
query.
- Join fetching: Hibernate retrieves the associated instance or collection in the same
SELECT
, using anOUTER JOIN
. - Select fetching: a second
SELECT
is used to retrieve the associated entity or collection. Unless you explicitly disable lazy fetching by specifyinglazy="false"
, this second select will only be executed when you access the association. - Subselect fetching: a second
SELECT
is used to retrieve the associated collections for all entities retrieved in a previous query or fetch. Unless you explicitly disable lazy fetching by specifyinglazy="false"
, this second select will only be executed when you access the association. - Batch fetching: an optimization strategy for select fetching. Hibernate retrieves a batch of entity instances or collections in a single
SELECT
by specifying a list of primary or foreign keys.
- Immediate fetching: an association, collection or attribute is fetched immediately when the owner is loaded.
- Lazy collection fetching: a collection is fetched when the application invokes an operation upon that collection. This is the default for collections.
- "Extra-lazy" collection fetching: individual elements of the collection are accessed from the database as needed. Hibernate tries not to fetch the whole collection into memory unless absolutely needed. It is suitable for large collections.
- Proxy fetching: a single-valued association is fetched when a method other than the identifier getter is invoked upon the associated object.
- "No-proxy" fetching: a single-valued association is fetched when the instance variable is accessed. Compared to proxy fetching, this approach is less lazy; the association is fetched even when only the identifier is accessed. It is also more transparent, since no proxy is visible to the application. This approach requires buildtime bytecode instrumentation and is rarely necessary.
- Lazy attribute fetching: an attribute or single valued association is fetched when the instance variable is accessed. This approach requires buildtime bytecode instrumentation and is rarely necessary.
fetch
to tune performance. We can use lazy
to define a contract for what data is always available in any detached instance of a particular class.
19.1.2. Working with Lazy Associations
hibernate.default_batch_fetch_size
, Hibernate will use the batch fetch optimization for lazy fetching. This optimization can also be enabled at a more granular level.
s = sessions.openSession(); Transaction tx = s.beginTransaction(); User u = (User) s.createQuery("from User u where u.name=:userName") .setString("userName", userName).uniqueResult(); Map permissions = u.getPermissions(); tx.commit(); s.close(); Integer accessLevel = (Integer) permissions.get("accounts"); // Error!
Session
was closed, the collection will not be able to load its state. Hibernate does not support lazy initialization for detached objects. This can be fixed by moving the code that reads from the collection to just before the transaction is committed.
lazy="false"
for the association mapping. However, it is intended that lazy initialization be used for almost all collections and associations. If you define too many non-lazy associations in your object model, Hibernate will fetch the entire database into memory in every transaction.
19.1.3. Tuning Fetch Strategies
<set name="permissions" fetch="join"> <key column="userId"/> <one-to-many class="Permission"/> </set
<many-to-one name="mother" class="Cat" fetch="join"/>
fetch
strategy defined in the mapping document affects:
- retrieval via
get()
orload()
- retrieval that happens implicitly when an association is navigated
Criteria
queries- HQL queries if
subselect
fetching is used
left join fetch
in HQL. This tells Hibernate to fetch the association eagerly in the first select, using an outer join. In the Criteria
query API, you would use setFetchMode(FetchMode.JOIN)
.
get()
or load()
, you can use a Criteria
query. For example:
User user = (User) session.createCriteria(User.class) .setFetchMode("permissions", FetchMode.JOIN) .add( Restrictions.idEq(userId) ) .uniqueResult();
19.1.4. Single-ended Association Proxies
many-to-one
and one-to-one
associations.
proxy
attribute. By default, Hibernate uses a subclass of the class. The proxied class must implement a default constructor with at least package visibility. This constructor is recommended for all persistent classes.
<class name="Cat" proxy="Cat"> ...... <subclass name="DomesticCat"> ..... </subclass> </class>
Cat
will never be castable to DomesticCat
, even if the underlying instance is an instance of DomesticCat
:
Cat cat = (Cat) session.load(Cat.class, id); // instantiate a proxy (does not hit the db) if ( cat.isDomesticCat() ) { // hit the db to initialize the proxy DomesticCat dc = (DomesticCat) cat; // Error! .... }
==
:
Cat cat = (Cat) session.load(Cat.class, id); // instantiate a Cat proxy DomesticCat dc = (DomesticCat) session.load(DomesticCat.class, id); // acquire new DomesticCat proxy! System.out.println(cat==dc); // false
cat.setWeight(11.0); // hit the db to initialize the proxy System.out.println( dc.getWeight() ); // 11.0
final
class or a class with any final
methods.
CatImpl
implements the interface Cat
and DomesticCatImpl
implements the interface DomesticCat
. For example:
<class name="CatImpl" proxy="Cat"> ...... <subclass name="DomesticCatImpl" proxy="DomesticCat"> ..... </subclass> </class>
Cat
and DomesticCat
can be returned by load()
or iterate()
.
Cat cat = (Cat) session.load(CatImpl.class, catid); Iterator iter = session.createQuery("from CatImpl as cat where cat.name='fritz'").iterate(); Cat fritz = (Cat) iter.next();
Note
list()
does not usually return proxies.
Cat
, not CatImpl
.
equals()
: if the persistent class does not overrideequals()
hashCode()
: if the persistent class does not overridehashCode()
- The identifier getter method
equals()
or hashCode()
.
lazy="no-proxy"
instead of the default lazy="proxy"
, you can avoid problems associated with typecasting. However, buildtime bytecode instrumentation is required, and all operations will result in immediate proxy initialization.
19.1.5. Initializing Collections and Proxies
LazyInitializationException
will be thrown by Hibernate if an uninitialized collection or proxy is accessed outside of the scope of the Session
, i.e., when the entity owning the collection or having the reference to the proxy is in the detached state.
Session
. You can force initialization by calling cat.getSex()
or cat.getKittens().size()
, for example. However, this can be confusing to readers of the code and it is not convenient for generic code.
Hibernate.initialize()
and Hibernate.isInitialized()
, provide the application with a convenient way of working with lazily initialized collections or proxies. Hibernate.initialize(cat)
will force the initialization of a proxy, cat
, as long as its Session
is still open. Hibernate.initialize( cat.getKittens() )
has a similar effect for the collection of kittens.
Session
open until all required collections and proxies have been loaded. In some application architectures, particularly where the code that accesses data using Hibernate, and the code that uses it are in different application layers or different physical processes, it can be a problem to ensure that the Session
is open when a collection is initialized. There are two basic ways to deal with this issue:
- In a web-based application, a servlet filter can be used to close the
Session
only at the end of a user request, once the rendering of the view is complete (the Open Session in View pattern). Of course, this places heavy demands on the correctness of the exception handling of your application infrastructure. It is vitally important that theSession
is closed and the transaction ended before returning to the user, even when an exception occurs during rendering of the view. - In an application with a separate business tier, the business logic must "prepare" all collections that the web tier needs before returning. This means that the business tier should load all the data and return all the data already initialized to the presentation/web tier that is required for a particular use case. Usually, the application calls
Hibernate.initialize()
for each collection that will be needed in the web tier (this call must occur before the session is closed) or retrieves the collection eagerly using a Hibernate query with aFETCH
clause or aFetchMode.JOIN
inCriteria
. This is usually easier if you adopt the Command pattern instead of a Session Facade. - You can also attach a previously loaded object to a new
Session
withmerge()
orlock()
before accessing uninitialized collections or other proxies. Hibernate does not, and certainly should not, do this automatically since it would introduce impromptu transaction semantics.
( (Integer) s.createFilter( collection, "select count(*)" ).list().get(0) ).intValue()
createFilter()
method is also used to efficiently retrieve subsets of a collection without needing to initialize the whole collection:
s.createFilter( lazyCollection, "").setFirstResult(0).setMaxResults(10).list();
19.1.6. Using Batch Fetching
Cat
instances loaded in a Session
, and each Cat
has a reference to its owner
, a Person
. The Person
class is mapped with a proxy, lazy="true"
. If you now iterate through all cats and call getOwner()
on each, Hibernate will, by default, execute 25 SELECT
statements to retrieve the proxied owners. You can tune this behavior by specifying a batch-size
in the mapping of Person
:
<class name="Person" batch-size="10">...</class>
Person
has a lazy collection of Cat
s, and 10 persons are currently loaded in the Session
, iterating through all persons will generate 10 SELECT
s, one for every call to getCats()
. If you enable batch fetching for the cats
collection in the mapping of Person
, Hibernate can pre-fetch collections:
<class name="Person"> <set name="cats" batch-size="3"> ... </set> </class>
batch-size
of 3, Hibernate will load 3, 3, 3, 1 collections in four SELECT
s. Again, the value of the attribute depends on the expected number of uninitialized collections in a particular Session
.
19.1.7. Using Subselect Fetching
19.1.8. Using Lazy Property Fetching
lazy
attribute on your particular property mappings:
<class name="Document"> <id name="id"> <generator class="native"/> </id> <property name="name" not-null="true" length="50"/> <property name="summary" not-null="true" length="200" lazy="true"/> <property name="text" not-null="true" length="2000" lazy="true"/> </class>
<target name="instrument" depends="compile"> <taskdef name="instrument" classname="org.hibernate.tool.instrument.InstrumentTask"> <classpath path="${jar.path}"/> <classpath path="${classes.dir}"/> <classpath refid="lib.class.path"/> </taskdef> <instrument verbose="true"> <fileset dir="${testclasses.dir}/org/hibernate/auction/model"> <include name="*.class"/> </fileset> </instrument> </target>
fetch all properties
in HQL.
19.2. Understanding Collection Performance
19.2.1. Taxonomy
- collections of values
- one-to-many associations
- many-to-many associations
- indexed collections
- sets
- bags
<key>
and <index>
columns. In this case, collection updates are extremely efficient. The primary key can be efficiently indexed and a particular row can be efficiently located when Hibernate tries to update or delete it.
<key>
and element columns. This can be less efficient for some types of collection element, particularly composite elements or large text or binary fields, as the database may not be able to index a complex primary key as efficiently. However, for one-to-many or many-to-many associations, particularly in the case of synthetic identifiers, it is likely to be just as efficient. If you want SchemaExport
to actually create the primary key of a <set>
, you must declare all columns as not-null="true"
.
<idbag>
mappings define a surrogate key, so they are efficient to update. In fact, they are the best case.
DELETE
and recreating the collection whenever it changes. This can be inefficient.
19.2.2. Lists, Maps, idbags and Sets
Set
, Hibernate does not UPDATE
a row when an element is "changed". Changes to a Set
always work via INSERT
and DELETE
of individual rows. Once again, this consideration does not apply to one-to-many associations.
inverse="true"
. For these associations, the update is handled by the many-to-one end of the association, and so considerations of collection update performance simply do not apply.
19.2.3. Bags and Lists as Inverse Collections
inverse="true"
, the standard bidirectional one-to-many relationship idiom, for example, we can add elements to a bag or list without needing to initialize (fetch) the bag elements. This is because, unlike a set
, Collection.add()
or Collection.addAll()
must always return true for a bag or List
. This can make the following common code much faster:
Parent p = (Parent) sess.load(Parent.class, id); Child c = new Child(); c.setParent(p); p.getChildren().add(c); //no need to fetch the collection! sess.flush();
19.2.4. One Shot Delete
list.clear()
, for example). In this case, Hibernate will issue a single DELETE
.
INSERT
statement and two DELETE
statements, unless the collection is a bag. This is certainly desirable.
- delete eighteen rows one by one and then insert three rows
- remove the whole collection in one SQL
DELETE
and insert all five current elements one by one
inverse="true"
.
19.3. Monitoring Performance
19.3.1. About Monitoring Performance
SessionFactory
.
19.3.2. Monitoring a SessionFactory
SessionFactory
metrics in two ways. Your first option is to call sessionFactory.getStatistics()
and read or display the Statistics
yourself.
StatisticsService
MBean. You can enable a single MBean for all your SessionFactory
or one per factory. See the following code for minimalistic configuration examples:
// MBean service registration for a specific SessionFactory Hashtable tb = new Hashtable(); tb.put("type", "statistics"); tb.put("sessionFactory", "myFinancialApp"); ObjectName on = new ObjectName("hibernate", tb); // MBean object name StatisticsService stats = new StatisticsService(); // MBean implementation stats.setSessionFactory(sessionFactory); // Bind the stats to a SessionFactory server.registerMBean(stats, on); // Register the Mbean on the server
// MBean service registration for all SessionFactory's Hashtable tb = new Hashtable(); tb.put("type", "statistics"); tb.put("sessionFactory", "all"); ObjectName on = new ObjectName("hibernate", tb); // MBean object name StatisticsService stats = new StatisticsService(); // MBean implementation server.registerMBean(stats, on); // Register the MBean on the server
SessionFactory
:
- at configuration time, set
hibernate.generate_statistics
tofalse
- at runtime:
sf.getStatistics().setStatisticsEnabled(true)
orhibernateStatsBean.setStatisticsEnabled(true)
clear()
method. A summary can be sent to a logger (info level) using the logSummary()
method.
19.3.3. Performance Metrics
Statistics
interface API, in three categories:
- Metrics related to the general
Session
usage, such as number of open sessions, retrieved JDBC connections, etc. - Metrics related to the entities, collections, queries, and caches as a whole (aka global metrics).
- Detailed metrics related to a particular entity, collection, query or cache region.
Statistics
, EntityStatistics
, CollectionStatistics
, SecondLevelCacheStatistics
, and QueryStatistics
API Javadoc for more information. The following code is a simple example:
Statistics stats = HibernateUtil.sessionFactory.getStatistics(); double queryCacheHitCount = stats.getQueryCacheHitCount(); double queryCacheMissCount = stats.getQueryCacheMissCount(); double queryCacheHitRatio = queryCacheHitCount / (queryCacheHitCount + queryCacheMissCount); log.info("Query Hit ratio:" + queryCacheHitRatio); EntityStatistics entityStats = stats.getEntityStatistics( Cat.class.getName() ); long changes = entityStats.getInsertCount() + entityStats.getUpdateCount() + entityStats.getDeleteCount(); log.info(Cat.class.getName() + " changed " + changes + "times" );
getQueries()
, getEntityNames()
, getCollectionRoleNames()
, and getSecondLevelCacheRegionNames()
.
Chapter 20. Toolset Guide
20.1. About the Toolset Guide
- Mapping Editor: an editor for Hibernate XML mapping files that supports auto-completion and syntax highlighting. It also supports semantic auto-completion for class names and property/field names, making it more versatile than a normal XML editor.
- Console: the console is a new view in Eclipse. In addition to a tree overview of your console configurations, you are also provided with an interactive view of your persistent classes and their relationships. The console allows you to execute HQL queries against your database and browse the result directly in Eclipse.
- Development Wizards: several wizards are provided with the Hibernate Eclipse tools. You can use a wizard to quickly generate Hibernate configuration (cfg.xml) files, or to reverse engineer an existing database schema into POJO source files and Hibernate mapping files. The reverse engineering wizard supports customizable templates.
hbm2ddl
.It can even be used from "inside" Hibernate.