Uploaded image for project: 'WildFly'
  1. WildFly
  2. WFLY-12674

wildfly.jpa.skipquerydetach set to true, will now skip clearing of query results

    XMLWordPrintable

Details

    Description

      Introduce wildfly.jpa.skipquerydetach that defaults to false (to wrap query objects with detacher that clears query results when obtained) but could be set to true, for JBoss AS 5/6 compatibility. This could of been part of WFLY-3674 but was overlooked.

      An example of setting wildfly.jpa.skipquerydetach to true, so that the various query detacher will not be used (e.g. underlying query is returned instead of instance of QueryNonTxInvocationDetacher/TypedQueryNonTxInvocationDetacher/StoredProcedureQueryNonTxInvocationDetacher wrapper):

      <property name="wildfly.jpa.skipquerydetach" value="true" />
      

      The below reference notes are more for background information but provide the explanation of why the AS5/6 way of detaching loaded entities changed later, to ensure the returned results from Query objects, are detached, instead of the current persistence context at the time of creating the query object, as per feedback below from JPA lead Linda DeMichiel.

      From related JPA expert group discussion:

      >>>>> Perhaps a clearer proposal could be:
      >>>>>
      >>>>> "
      >>>>> If the entity manager is invoked outside the scope of a transaction,
      >>>>> any entities loaded from the database will
      >>>>> immediately become detached at the end of the container level method
      >>>>> invocation call (e.g. when the session bean method
      >>>>> ends).
      >>>>> "
      >>>>
      >>>> Ah, thanks. That is not the intended semantics. Rather it is that the
      >>>> persistence context is created to service the method call that is made
      >>>> on the entity manager only. It doesn't have the duration of a business
      >>>> method invocation.
      >>>
      >>> Is it really?
      >>>
      >>
      >> Yes. See also section 3.8.7, which is quite explicit with regard to
      >> queries.
      >> BTW, these decisions date back to JPA 1.0 (aka EJB 3.0).
      >
      > My updated proposal for the 7.6.2 wording is:
      >
      > "
      > If the entity manager is invoked outside the scope of a transaction, any entities loaded from the database will
      > immediately become detached at the end of the entity manager method call.
      > "
      
      OK, sure + "... or query invocation" 
      

      Note that we (JPA expert group) missed Linda's response of "... or query invocation" in the JPA spec update, as the JPA 2.2 spec today states:

      7.6.2 Container-managed Transaction-scoped Persistence Context

      The application can obtain a container-managed entity manager with transaction-scoped persistence context by injection or direct lookup in the JNDI namespace. The persistence context type for the entity manager is defaulted or defined as PersistenceContextType.TRANSACTION.

      A new persistence context begins when the container-managed entity manager is invoked [84] in the scope of an active JTA transaction, and there is no current persistence context already associated with the JTA transaction. The persistence context is created and then associated with the JTA transaction. This association of the persistence context with the JTA transaction is independent of the synchronization type of the persistence context and whether the persistence context has been joined to the transaction.

      Some related AS5/6 JPA container code. which simply cleared the persistence context as we were creating a new Query, for example see:

         public Query createQuery(String ejbqlString)
         {
            EntityManager em = getEntityManager();
            detachEntitiesIfNoTx(em);
            return em.createQuery(ejbqlString);
         }
      

      Also of reference, is from issue description WFLY-3674:

      For compatibility with earlier JBoss application server versions (5.0/6.0), add an extension that allows the persistence context to last until the referencing persistence context is closed.

      For example, in a session method that has no active JTA transaction, entities returned, will not cleared from the persistence context, until the session method completes. This extension is only introduced to allow compatibility with older application server versions.

      WFLY-12674 is about doing the same for Queries (if wildfly.jpa.skipquerydetach is set to true).

      Attachments

        Issue Links

          Activity

            People

              smarlow1@redhat.com Scott Marlow
              smarlow1@redhat.com Scott Marlow
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: