Package org.springframework.data.jpa.provider

Enum Class PersistenceProvider

java.lang.Object
java.lang.Enum<PersistenceProvider>
org.springframework.data.jpa.provider.PersistenceProvider
All Implemented Interfaces:
Serializable, Comparable<PersistenceProvider>, Constable, ProxyIdAccessor, QueryComment, QueryExtractor
public enum PersistenceProvider extends Enum<PersistenceProvider> implements QueryExtractor, ProxyIdAccessor, QueryComment
Enumeration representing persistence providers to be used.
Author:
Oliver Gierke, Thomas Darimont, Mark Paluch, Jens Schauder, Greg Turnquist, Yuriy Tsarkov, Ariel Morelli Andres

  • Enum Constant Details

    • HIBERNATE

      public static final PersistenceProvider HIBERNATE
      Hibernate persistence provider.

    • GENERIC_JPA

      public static final PersistenceProvider GENERIC_JPA
      Unknown special provider. Use standard JPA.

  • Method Details

    • values

      public static PersistenceProvider[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PersistenceProvider valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromEntityManager

      public static PersistenceProvider fromEntityManager(jakarta.persistence.EntityManager em)
      Determines the PersistenceProvider from the given EntityManager by introspecting EntityManagerFactory via EntityManager.getEntityManagerFactory(). If no special one can be determined GENERIC_JPA will be returned.

      This method avoids EntityManager initialization when using SharedEntityManagerCreator by accessing EntityManager.getEntityManagerFactory().

      Parameters:
      em - must not be null.
      Returns:
      will never be null.
      See Also:

    • fromEntityManagerFactory

      public static PersistenceProvider fromEntityManagerFactory(jakarta.persistence.EntityManagerFactory emf)
      Determines the PersistenceProvider from the given EntityManagerFactory. If no special one can be determined GENERIC_JPA will be returned.
      Parameters:
      emf - must not be null.
      Returns:
      will never be null.
      Since:
      3.5.1

    • fromMetamodel

      public static PersistenceProvider fromMetamodel(jakarta.persistence.metamodel.Metamodel metamodel)
      Determines the PersistenceProvider from the given Metamodel. If no special one can be determined GENERIC_JPA will be returned.
      Parameters:
      metamodel - must not be null.
      Returns:
      will never be null.

    • getCountQueryPlaceholder

      public String getCountQueryPlaceholder()
      Returns the placeholder to be used for simple count queries. Default implementation returns x.
      Returns:
      a placeholder for count queries. Guaranteed to be not null.

    • canExtractQuery

      public boolean canExtractQuery()
      Description copied from interface: QueryExtractor
      Returns whether the extractor is able to extract the original query string from a given Query.
      Specified by:
      canExtractQuery in interface QueryExtractor
      Returns:

    • getIdClassAttributes

      public <T> Set<jakarta.persistence.metamodel.SingularAttribute<? super T,?>> getIdClassAttributes(jakarta.persistence.metamodel.IdentifiableType<T> type)
      Parameters:
      type - the entity type.
      Returns:
      the set of identifier attributes used in a @IdClass for type. Empty when type does not use @IdClass.
      Since:
      2.5.6

    • unwrapTypedParameterValue

      @Nullable public static Object unwrapTypedParameterValue(@Nullable Object value)
      Because Hibernate's TypedParameterValue is only used to wrap a null, swap it out with null for query creation.
      Parameters:
      value -
      Returns:
      the original value or null.
      Since:
      3.0

    • isPresent

      public boolean isPresent()

    • executeQueryWithResultStream

      public CloseableIterator<Object> executeQueryWithResultStream(jakarta.persistence.Query jpaQuery)