Detach an entity from JPA/EJB3 persistence context

Question

What would be the easiest way to detach a specific JPA Entity Bean that was acquired through an EntityManager. Alternatively, could I have a query return detached objects in the first place so they would essentially act as 'read only'?

The reason why I want to do this is becuase I want to modify the data within the bean - with in my application only, but not ever have it persisted to the database. In my program, I eventually have to call flush() on the EntityManager, which would persist all changes from attached entities to the underyling database, but I want to exclude specific objects.

score 62 · Answer 1 · edited Oct 30 '17 at 11:24

62

(may be too late to answer, but can be useful for others)

I'm developing my first system with JPA right now. Unfortunately I'm faced with this problem when this system is almost complete.

Simply put. Use Hibernate, or wait for JPA 2.0.

In Hibernate, you can use 'session.evict(object)' to remove one object from session. In JPA 2.0, ~~in draft right now~~, there is the 'EntityManager.detach(object)' method to detach one object from persistence context.

edited Oct 30 '17 at 11:24

P̲̳x͓L̳

3,615
3
29
37

answered May 22 '09 at 14:04

2

Its now exactly one year later. I have this issue and I cannot find any "detach" method call on EntityManager. Was it dropped for some reason? – Dave May 21 '10 at 05:47
3

Is here http://download.oracle.com/javaee/6/api/javax/persistence/EntityManager.html#detach(java.lang.Object) – Lee Chee Kiam Apr 13 '11 at 08:29

score 29 · Answer 2 · answered Aug 27 '12 at 10:04

29

No matter which JPA implementation you use, Just use entityManager.detach(object) it's now in JPA 2.0 and part of JEE6.

answered Aug 27 '12 at 10:04

Mehdi

4,396
4
29
30

score 19 · Answer 3 · answered Jan 12 '10 at 14:10

If you need to detach an object from the EntityManager and you are using Hibernate as your underlying ORM layer you can get access to the Hibernate Session object and use the Session.evict(Object) method that Mauricio Kanada mentioned above.

public void detach(Object entity) {
    org.hibernate.Session session = (Session) entityManager.getDelegate();
    session.evict(entity);
}

Of course this would break if you switched to another ORM provider but I think this is preferably to trying to make a deep copy.

score 17 · Accepted Answer · answered Aug 28 '08 at 18:39

Unfortunately, there's no way to disconnect one object from the entity manager in the current JPA implementation, AFAIR.

EntityManager.clear() will disconnect all the JPA objects, so that might not be an appropriate solution in all the cases, if you have other objects you do plan to keep connected.

So your best bet would be to clone the objects and pass the clones to the code that changes the objects. Since primitive and immutable object fields are taken care of by the default cloning mechanism in a proper way, you won't have to write a lot of plumbing code (apart from deep cloning any aggregated structures you might have).

This is no longer true, EM now provides detach(entity) method, since JPA v2 , see javax.persistence.EntityManager#detach — Frederik, Aug 08 '20 at 12:09

score 3 · Answer 5 · answered Aug 28 '08 at 01:45

3

As far as I know, the only direct ways to do it are:

Commit the txn - Probably not a reasonable option
Clear the Persistence Context - EntityManager.clear() - This is brutal, but would clear it out
Copy the object - Most of the time your JPA objects are serializable, so this should be easy (if not particularly efficient).

answered Aug 28 '08 at 01:45

jsight

27,819
25
107
140

2

How does committing the txn cause the entity to be detached? – Peter Davis May 19 '11 at 17:59

score 3 · Answer 6 · edited Jun 15 '15 at 05:49

3

If using EclipseLink you also have the options,

Use the Query hint, eclipselink.maintain-cache"="false - all returned objects will be detached.

Use the EclipseLink JpaEntityManager copy() API to copy the object to the desired depth.

edited Jun 15 '15 at 05:49

Dhanuka

2,826
5
27
38

answered Mar 31 '11 at 13:16

James

17,965
11
91
146

score 1 · Answer 7 · answered Oct 22 '09 at 07:59

1

this is quick and dirty, but you can also serialize and deserialize the object.

answered Oct 22 '09 at 07:59

Davide Consonni

2,094
26
27

1

Just a heads up, this can cause issues with Lazy loading and JPA relationships. – James McMahon Jan 12 '10 at 13:33

score 1 · Answer 8 · answered Jun 04 '13 at 22:03

In JPA 1.0 (tested using EclipseLink) you could retrieve the entity outside of a transaction. For example, with container managed transactions you could do:

public MyEntity myMethod(long id) {
    final MyEntity myEntity = retrieve(id);
    // myEntity is detached here
}

@TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED)
public MyEntity retrieve(long id) {
    return entityManager.find(MyEntity.class, id);
}

score 1 · Answer 9 · edited Sep 03 '14 at 16:27

1

Do deal with a similar case I have created a DTO object that extends the persistent entity object as follows:

class MyEntity
{
   public static class MyEntityDO extends MyEntity {}

}

Finally, an scalar query will retrieve the desired non managed attributes:

(Hibernate) select p.id, p.name from MyEntity P
(JPA)       select new MyEntity(p.id, p.name) from myEntity P

edited Sep 03 '14 at 16:27

Halvor Holsten Strand

19,829
17
83
99

answered Sep 03 '14 at 16:16

Roger Mori

11
1

score 1 · Answer 10 · answered Aug 28 '08 at 02:36

If there aren't too many properties in the bean, you might just create a new instance and set all of its properties manually from the persisted bean.

This could be implemented as a copy constructor, for example:

public Thing(Thing oldBean) {
  this.setPropertyOne(oldBean.getPropertyOne());
  // and so on
}

Then:

Thing newBean = new Thing(oldBean);

score 1 · Answer 11 · answered Mar 30 '11 at 20:12

Since I am using SEAM and JPA 1.0 and my system has a fuctinality that needs to log all fields changes, i have created an value object or data transfer object if same fields of the entity that needs to be logged. The constructor of the new pojo is:

    public DocumentoAntigoDTO(Documento documentoAtual) {
    Method[] metodosDocumento = Documento.class.getMethods();
    for(Method metodo:metodosDocumento){
        if(metodo.getName().contains("get")){
            try {
                Object resultadoInvoke = metodo.invoke(documentoAtual,null);
                Method[] metodosDocumentoAntigo = DocumentoAntigoDTO.class.getMethods();
                for(Method metodoAntigo : metodosDocumentoAntigo){
                    String metodSetName = "set" + metodo.getName().substring(3);
                    if(metodoAntigo.getName().equals(metodSetName)){
                        metodoAntigo.invoke(this, resultadoInvoke);
                    }
                }
            } catch (IllegalArgumentException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            }
        }
    }
}

score 0 · Answer 12 · answered Oct 25 '18 at 18:39

0

I think there is a way to evict a single entity from EntityManager by calling this

EntityManagerFactory emf;
emf.getCache().evict(Entity);

This will remove particular entity from cache.

answered Oct 25 '18 at 18:39

Abhishek Tripathi

1
7

This only evicts the object from the second level cache, not from the session cache. – Lukasz Frankowski Apr 25 '19 at 05:42

score 0 · Answer 13 · edited Jan 02 '12 at 11:22

If you get here because you actually want to pass an entity across a remote boundary then you just put some code in to fool the hibernazi.

for(RssItem i : result.getChannel().getItem()){
}

Cloneable wont work because it actually copies the PersistantBag across.

And forget about using serializable and bytearray streams and piped streams. creating threads to avoid deadlocks kills the entire concept.

score 0 · Answer 14 · answered Jul 08 '21 at 05:48

0

Im using entityManager.detach(returnObject); which worked for me.

answered Jul 08 '21 at 05:48

Pradeesh

21
1
4

score -1 · Answer 15 · answered Nov 27 '09 at 12:21

-1

I think you can also use method EntityManager.refresh(Object o) if primary key of the entity has not been changed. This method will restore original state of the entity.

answered Nov 27 '09 at 12:21

trunikov

1

Detach an entity from JPA/EJB3 persistence context

15 Answers15

Linked