Method Summary

Method Details

• getTenantIdentifier

  String getTenantIdentifier()

  Obtain the tenant identifier associated with this session, as a string.

  Returns:

  The tenant identifier associated with this session, ornull

  See Also:

  • CurrentTenantIdentifierResolver
  • SessionBuilder.tenantIdentifier(Object)

• getTenantIdentifierValue

  Object getTenantIdentifierValue()

  Obtain the tenant identifier associated with this session.

  Returns:

  The tenant identifier associated with this session, ornull

  Since:

  6.4

  See Also:

  • CurrentTenantIdentifierResolver
  • SessionBuilder.tenantIdentifier(Object)

• getCacheMode

  CacheMode getCacheMode()

  Get the currentcache mode for this session.

  Returns:

  the current cache mode

• setCacheMode

  void setCacheMode(CacheMode cacheMode)

  Set the currentcache mode for this session.

  The cache mode determines the manner in which this session can interact with the second level cache.

  Parameters:

  cacheMode - the new cache mode

• close

  void close() throwsHibernateException

  End the session by releasing the JDBC connection and cleaning up.

  Specified by:

  close in interface AutoCloseable

  Throws:

  HibernateException - Indicates problems cleaning up.

• isOpen

  boolean isOpen()

  Check if the session is still open.

  Returns:

  true if it is open

• isConnected

  boolean isConnected()

  Check if the session is currently connected.

  Returns:

  true if it is connected

• beginTransaction

  Transaction beginTransaction()

  Begin a unit of work and return the associatedTransaction object. If a new underlying transaction is required, begin the transaction. Otherwise, continue the new work in the context of the existing underlying transaction.

  Returns:

  an instance ofTransaction representing the new transaction

  See Also:

  • getTransaction()
  • EntityTransaction.begin()

  API Note:

  The JPA-standard way to begin a new resource-local transaction is by callinggetTransaction().begin(). But it's not always safe to execute this idiom.

  • JPA doesn't allow anEntityTransaction to represent a JTA transaction context. Therefore, whenstrict JPA transaction compliance is enabled via, for example, setting"hibernate.jpa.compliance.transaction", the call togetTransaction() fails if transactions are managed by JTA.

    On the other hand, this method does not fail when JTA transaction management is used, not even if strict JPA transaction compliance is enabled.

  • Even when resource-local transactions are in use, and even when strict JPA transaction compliance isdisabled, the call tobegin() fails if a transaction is alreadyactive.

    This method never fails when a transaction is already active. Instead,beginTransaction() simply returns theTransaction object representing the active transaction.

• getTransaction

  Transaction getTransaction()

  Get theTransaction instance associated with this session.

  Returns:

  an instance ofTransaction representing the transaction associated with this session

  See Also:

  • EntityManager.getTransaction()

  API Note:

  This method is the JPA-standard way to obtain an instance ofEntityTransaction representing a resource-local transaction. But JPA doesn't allow anEntityTransaction to represent a JTA transaction. Therefore, whenstrict JPA transaction compliance is enabled via, for example, setting"hibernate.jpa.compliance.transaction", this method fails if transactions are managed by JTA.

  On the other hand, when JTA transaction management is used, and when strict JPA transaction compliance isdisabled, this method happily returns aTransaction representing the current JTA transaction context.

• joinTransaction

  void joinTransaction()

  Join the currently-active JTA transaction.

  Since:

  6.2

  See Also:

  • EntityManager.joinTransaction()

• isJoinedToTransaction

  boolean isJoinedToTransaction()

  Check if the session is joined to the current transaction.

  Since:

  6.2

  See Also:

  • joinTransaction()
  • EntityManager.isJoinedToTransaction()

• getNamedProcedureCall

  ProcedureCall getNamedProcedureCall(String name)

  Obtain aProcedureCall based on a named template

  Parameters:

  name - The name given to the template

  Returns:

  The ProcedureCall

  See Also:

  • NamedStoredProcedureQuery

• createStoredProcedureCall

  ProcedureCall createStoredProcedureCall(String procedureName)

  Create aProcedureCall to a stored procedure.

  Parameters:

  procedureName - The name of the procedure.

  Returns:

  The representation of the procedure call.

• createStoredProcedureCall

  ProcedureCall createStoredProcedureCall(String procedureName,Class<?>... resultClasses)

  Create aProcedureCall to a stored procedure with the given result set entity mappings. Each given class is considered a "root return".

  Parameters:

  procedureName - The name of the procedure.

  resultClasses - The entity(s) to map the result on to.

  Returns:

  The representation of the procedure call.

• createStoredProcedureCall

  ProcedureCall createStoredProcedureCall(String procedureName,String... resultSetMappings)

  Create aProcedureCall to a stored procedure with the given result set entity mappings.

  Parameters:

  procedureName - The name of the procedure.

  resultSetMappings - The explicit result set mapping(s) to use for mapping the results

  Returns:

  The representation of the procedure call.

• createNamedStoredProcedureQuery

  ProcedureCall createNamedStoredProcedureQuery(String name)

  Obtain aProcedureCall based on a named template

  Parameters:

  name - The name given to the template

  Returns:

  The ProcedureCall

  See Also:

  • NamedStoredProcedureQuery

• createStoredProcedureQuery

  ProcedureCall createStoredProcedureQuery(String procedureName)

  Create aProcedureCall to a stored procedure.

  Parameters:

  procedureName - The name of the procedure.

  Returns:

  The representation of the procedure call.

• createStoredProcedureQuery

  ProcedureCall createStoredProcedureQuery(String procedureName,Class<?>... resultClasses)

  Create aProcedureCall to a stored procedure with the given result set entity mappings. Each given class is considered a "root return".

  Parameters:

  procedureName - The name of the procedure.

  resultClasses - The entity(s) to map the result on to.

  Returns:

  The representation of the procedure call.

• createStoredProcedureQuery

  ProcedureCall createStoredProcedureQuery(String procedureName,String... resultSetMappings)

  Create aProcedureCall to a stored procedure with the given result set entity mappings.

  Parameters:

  procedureName - The name of the procedure.

  resultSetMappings - The explicit result set mapping(s) to use for mapping the results

  Returns:

  The representation of the procedure call.

• getJdbcBatchSize

  Integer getJdbcBatchSize()

  Get the session-level JDBC batch size for the current session.

  Returns:

  the current session-level JDBC batch size

  Since:

  5.2

  See Also:

  • SessionFactoryOptions.getJdbcBatchSize()
  • SessionFactoryBuilder.applyJdbcBatchSize(int)

• setJdbcBatchSize

  void setJdbcBatchSize(Integer jdbcBatchSize)

  Set the session-level JDBC batch size. Override thefactory-level JDBC batch size controlled by the configuration property"hibernate.jdbc.batch_size".

  Parameters:

  jdbcBatchSize - the new session-level JDBC batch size

  Since:

  5.2

  See Also:

  • BatchSettings.STATEMENT_BATCH_SIZE
  • SessionFactoryOptions.getJdbcBatchSize()
  • SessionFactoryBuilder.applyJdbcBatchSize(int)

  API Note:

  Setting a session-level JDBC batch size for aStatelessSession triggers a sort of write-behind behaviour where operations are batched and executed asynchronously, undermining the semantics of the stateless programming model. We recommend the use of explicitly-batching operations likeinsertMultiple(),updateMultiple(), anddeleteMultiple() instead.

• getCriteriaBuilder

  HibernateCriteriaBuilder getCriteriaBuilder()

  Obtain aHibernateCriteriaBuilder which may be used toconstructcriteria queries.

  Returns:

  an instance ofHibernateCriteriaBuilder

  Throws:

  IllegalStateException - if the session has been closed

  See Also:

  • SessionFactory.getCriteriaBuilder()

• doWork

  void doWork(Work work) throwsHibernateException

  Perform work using theConnection underlying by this session.

  Parameters:

  work - The work to be performed.

  Throws:

  HibernateException - Generally indicates wrappedSQLException

  API Note:

  This method competes with the JPA-defined methodEntityManager.runWithConnection(jakarta.persistence.ConnectionConsumer<C>)

• doReturningWork

  <T> T doReturningWork(ReturningWork<T> work)

  Perform work using theConnection underlying by this session, and return a result.

  Type Parameters:

  T - The type of the result returned from the work

  Parameters:

  work - The work to be performed.

  Returns:

  the result of callingReturningWork.execute(java.sql.Connection).

  Throws:

  HibernateException - Generally indicates wrappedSQLException

  API Note:

  This method competes with the JPA-defined methodEntityManager.callWithConnection(jakarta.persistence.ConnectionFunction<C, T>)

• createEntityGraph

  <T> RootGraph<T> createEntityGraph(Class<T> rootType)

  Create a new mutable instance ofEntityGraph, with only a root node, allowing programmatic definition of the graph from scratch.

  Parameters:

  rootType - the root entity class of the graph

  Since:

  6.3

  See Also:

  • EntityGraphs.createGraph(jakarta.persistence.metamodel.EntityType)

• createEntityGraph

  RootGraph<?> createEntityGraph(String graphName)

  Create a new mutable instance ofEntityGraph, based on a predefinednamed entity graph, allowing customization of the graph, or returnnull if there is no predefined graph with the given name.

  Parameters:

  graphName - the name of the graph

  Since:

  6.3

  See Also:

  • EntityManagerFactory.getNamedEntityGraphs(Class)
  • EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

  API Note:

  This method returnsRootGraph<?>, requiring an unchecked typecast before use. It's cleaner to obtain a graph usingcreateEntityGraph(Class, String) instead.

• createEntityGraph

  <T> RootGraph<T> createEntityGraph(Class<T> rootType,String graphName)

  Create a new mutable instance ofEntityGraph, based on a predefinednamed entity graph, allowing customization of the graph, or returnnull if there is no predefined graph with the given name.

  Parameters:

  rootType - the root entity class of the graph

  graphName - the name of the predefined named entity graph

  Throws:

  IllegalArgumentException - if the graph with the given name does not have the given entity type as its root

  Since:

  6.3

  See Also:

  • EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

• getEntityGraph

  RootGraph<?> getEntityGraph(String graphName)

  Obtain an immutable reference to a predefinednamed entity graph or returnnull if there is no predefined graph with the given name.

  Parameters:

  graphName - the name of the predefined named entity graph

  Since:

  6.3

  See Also:

  • EntityManagerFactory.getNamedEntityGraphs(Class)
  • EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

  API Note:

  This method returnsRootGraph<?>, requiring an unchecked typecast before use. It's cleaner to obtain a graph using the static metamodel for the class which defines the graph, or by callingEntityManagerFactory.getNamedEntityGraphs(Class) instead.

• getEntityGraphs

  <T> List<EntityGraph<? super T>> getEntityGraphs(Class<T> entityClass)

  Retrieve all namedEntityGraphs with the given root entity type.

  Since:

  6.3

  See Also:

  • EntityManagerFactory.getNamedEntityGraphs(Class)
  • EntityManagerFactory.addNamedEntityGraph(String, EntityGraph)

• enableFilter

  Filter enableFilter(String filterName)

  Enable the namedfilter for this current session.

  The returnedFilter object must be used to bind arguments to parameters of the filter, and every parameter must be set before any other operation of this session is called.

  Parameters:

  filterName - the name of the filter to be enabled.

  Returns:

  theFilter instance representing the enabled filter.

  Throws:

  UnknownFilterException - if there is no such filter

  See Also:

  • FilterDef

• getEnabledFilter

  Filter getEnabledFilter(String filterName)

  Retrieve a currently enabledfilter by name.

  Parameters:

  filterName - the name of the filter to be retrieved.

  Returns:

  theFilter instance representing the enabled filter.

• disableFilter

  void disableFilter(String filterName)

  Disable the namedfilter for the current session.

  Parameters:

  filterName - the name of the filter to be disabled.

• getFactory

  SessionFactory getFactory()

  The factory which created this session.

• inTransaction

  default void inTransaction(Consumer<? superTransaction> action)

  Perform an action within the bounds of atransaction associated with this session.

  Parameters:

  action - a void function which accepts theTransaction

  Since:

  7.0

• fromTransaction

  default <R> R fromTransaction(Function<? superTransaction,R> action)

  Obtain a value within the bounds of atransaction associated with this session.

  Parameters:

  action - a function which accepts theTransaction and returns the value

  Since:

  7.0

• unwrap

  default <T> T unwrap(Class<T> type)

  Return an object of the specified type to allow access to a provider-specific API.

  Parameters:

  type - the class of the object to be returned. This is usually either the underlying class implementingSharedSessionContract or an interface it implements.

  Returns:

  an instance of the specified class

  Throws:

  PersistenceException - if the provider does not support the given type