Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.SharedSessionContract

Method Summary

Modifier and Type	Method and Description
public Transaction	Returns: a Transaction instance beginTransaction() Begin a unit of work and return the associated `Transaction` object.
public void	close() End the session by releasing the JDBC connection and cleaning up.
public Criteria	Returns: The criteria instance for manipulation and execution createCriteria(Class<T> The class, which is an entity, or has entity subclasses/implementors persistentClass) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given class (entity or subclasses/implementors).
public Criteria	Returns: The criteria instance for manipulation and execution createCriteria(Class<T> The class, which is an entity, or has entity subclasses/implementors persistentClass, String The alias to use alias) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given class (entity or subclasses/implementors), using a specific alias.
public Criteria	Returns: The criteria instance for manipulation and execution createCriteria(String The entity name entityName) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given entity name.
public Criteria	Returns: The criteria instance for manipulation and execution createCriteria(String The entity name entityName, String The alias to use alias) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given entity name, using a specific alias.
public Query<R>	createQuery(String The HQL/JPQL query queryString) Redeclares org.hibernate.query.QueryProducer.createQuery. Deprecated as a consequence of `Query` being deprecated. Create a `Query` instance for the given HQL/JPQL query string.
public ProcedureCall	Returns: The representation of the procedure call. createStoredProcedureCall(String The name of the procedure. procedureName) Deprecated as a consequence of `ProcedureCall` being deprecated. Creates a call to a stored procedure.
public ProcedureCall	Returns: The representation of the procedure call. createStoredProcedureCall(String The name of the procedure. procedureName, Class<T>... The entity(s) to map the result on to. resultClasses) Deprecated as a consequence of `ProcedureCall` being deprecated. Creates a call to a stored procedure with specific result set entity mappings.
public ProcedureCall	Returns: The representation of the procedure call. createStoredProcedureCall(String The name of the procedure. procedureName, String... The explicit result set mapping(s) to use for mapping the results resultSetMappings) Deprecated as a consequence of `ProcedureCall` being deprecated. Creates a call to a stored procedure with specific result set entity mappings.
public default < The type of the result returned from the work T> T	Returns: the result from calling `ReturningWork#execute`. doReturningWork(ReturningWork<T> The work to be performed. work) Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
public default void	doWork(Work The work to be performed. work) Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
public Integer	Returns: Session-level JDBC batch size getJdbcBatchSize() Get the Session-level JDBC batch size for the current Session.
public ProcedureCall	Returns: The ProcedureCall getNamedProcedureCall(String The name given to the template name) Deprecated as a consequence of `ProcedureCall` being deprecated. Gets a ProcedureCall based on a named template
public Query<R>	getNamedQuery(String the name of a pre-defined, named query queryName) Redeclares org.hibernate.query.QueryProducer.getNamedQuery. Deprecated as a consequence of `Query` being deprecated. Create a `Query` instance for the named query.
public String	Returns: The tenant identifier associated with this session, or `null` getTenantIdentifier() Obtain the tenant identifier associated with this session.
public Transaction	Returns: a Transaction instance getTransaction() Get the `Transaction` instance associated with this session.
public boolean	Returns: boolean isConnected() Check if the session is currently connected.
public boolean	Returns: boolean isOpen() Check if the session is still open.
public void	setJdbcBatchSize(Integer Session-level JDBC batch size jdbcBatchSize) Set the Session-level JDBC batch size.

Inherited from org.hibernate.query.QueryProducer:: createNamedQuery createNamedQuery createNativeQuery createNativeQuery createNativeQuery createQuery createQuery createQuery createQuery createSQLQuery getNamedNativeQuery getNamedSQLQuery

Method Detail

beginTransaction back to summary

beginTransaction	back to summary
public Transaction beginTransaction() Begin a unit of work and return the associated `Transaction` 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:Transaction a Transaction instance See Also `getTransaction`

public Transaction beginTransaction()

Begin a unit of work and return the associated Transaction 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:Transaction: a Transaction instance
See Also: getTransaction

close	back to summary
public void close() throws HibernateException End the session by releasing the JDBC connection and cleaning up. Exceptions HibernateException: Indicates problems cleaning up.

back to summary

public void close() throws HibernateException

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

Exceptions

HibernateException:: Indicates problems cleaning up.

createCriteria back to summary

createCriteria	back to summary
public Criteria createCriteria(Class<T> persistentClass) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given class (entity or subclasses/implementors). Parameters persistentClass:Class<T> The class, which is an entity, or has entity subclasses/implementors Returns:Criteria The criteria instance for manipulation and execution Annotations @Deprecated

public Criteria createCriteria(Class<T> persistentClass)

Deprecated

(since 5.2) for Session, use the JPA Criteria

Create Criteria instance for the given class (entity or subclasses/implementors).

Parameters

persistentClass:Class<T>: The class, which is an entity, or has entity subclasses/implementors

Returns:Criteria

The criteria instance for manipulation and execution

Annotations

@Deprecated

createCriteria back to summary

createCriteria	back to summary
public Criteria createCriteria(Class<T> persistentClass, String alias) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given class (entity or subclasses/implementors), using a specific alias. Parameters persistentClass:Class<T> The class, which is an entity, or has entity subclasses/implementors alias:String The alias to use Returns:Criteria The criteria instance for manipulation and execution Annotations @Deprecated

public Criteria createCriteria(Class<T> persistentClass, String alias)

Deprecated

(since 5.2) for Session, use the JPA Criteria

Create Criteria instance for the given class (entity or subclasses/implementors), using a specific alias.

Parameters

persistentClass:Class<T>: The class, which is an entity, or has entity subclasses/implementors
alias:String: The alias to use

Returns:Criteria

The criteria instance for manipulation and execution

Annotations

@Deprecated

createCriteria back to summary

createCriteria	back to summary
public Criteria createCriteria(String entityName) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given entity name. Parameters entityName:String The entity name Returns:Criteria The criteria instance for manipulation and execution Annotations @Deprecated

public Criteria createCriteria(String entityName)

Deprecated

(since 5.2) for Session, use the JPA Criteria

Create Criteria instance for the given entity name.

Parameters

entityName:String: The entity name

Returns:Criteria

The criteria instance for manipulation and execution

Annotations

@Deprecated

createCriteria back to summary

createCriteria	back to summary
public Criteria createCriteria(String entityName, String alias) Deprecated (since 5.2) for Session, use the JPA Criteria Create `Criteria` instance for the given entity name, using a specific alias. Parameters entityName:String The entity name alias:String The alias to use Returns:Criteria The criteria instance for manipulation and execution Annotations @Deprecated

public Criteria createCriteria(String entityName, String alias)

Deprecated

(since 5.2) for Session, use the JPA Criteria

Create Criteria instance for the given entity name, using a specific alias.

Parameters

entityName:String: The entity name
alias:String: The alias to use

Returns:Criteria

The criteria instance for manipulation and execution

Annotations

@Deprecated

createQuery back to summary

createQuery	back to summary
public Query<R> createQuery(String queryString) Redeclares org.hibernate.query.QueryProducer.createQuery. Doc from org.hibernate.query.QueryProducer.createQuery. Deprecated as a consequence of `Query` being deprecated. See corresponding docs for further information. Create a `Query` instance for the given HQL/JPQL query string. Parameters queryString:String The HQL/JPQL query Returns:Query<R> The Query instance for manipulation and execution Annotations @Override

public Query<R> createQuery(String queryString)

Redeclares org.hibernate.query.QueryProducer.createQuery.

Doc from org.hibernate.query.QueryProducer.createQuery.

Deprecated

as a consequence of Query being deprecated. See corresponding docs for further information.

Create a Query instance for the given HQL/JPQL query string.

Parameters

queryString:String: The HQL/JPQL query

Returns:Query<R>

The Query instance for manipulation and execution

Annotations

@Override

createStoredProcedureCall back to summary

createStoredProcedureCall	back to summary
public ProcedureCall createStoredProcedureCall(String procedureName) Deprecated as a consequence of `ProcedureCall` being deprecated. See corresponding docs for further information. Creates a call to a stored procedure. Parameters procedureName:String The name of the procedure. Returns:ProcedureCall The representation of the procedure call.

public ProcedureCall createStoredProcedureCall(String procedureName)

Deprecated

as a consequence of ProcedureCall being deprecated. See corresponding docs for further information.

Creates a call to a stored procedure.

Parameters

procedureName:String: The name of the procedure.

Returns:ProcedureCall

The representation of the procedure call.

createStoredProcedureCall back to summary

createStoredProcedureCall	back to summary
public ProcedureCall createStoredProcedureCall(String procedureName, Class<T>... resultClasses) Deprecated as a consequence of `ProcedureCall` being deprecated. See corresponding docs for further information. Creates a call to a stored procedure with specific result set entity mappings. Each class named is considered a "root return". Parameters procedureName:String The name of the procedure. resultClasses:Class<T>[] The entity(s) to map the result on to. Returns:ProcedureCall The representation of the procedure call.

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

Deprecated

as a consequence of ProcedureCall being deprecated. See corresponding docs for further information.

Creates a call to a stored procedure with specific result set entity mappings. Each class named is considered a "root return".

Parameters

procedureName:String: The name of the procedure.
resultClasses:Class<T>[]: The entity(s) to map the result on to.

Returns:ProcedureCall

The representation of the procedure call.

createStoredProcedureCall back to summary

createStoredProcedureCall	back to summary
public ProcedureCall createStoredProcedureCall(String procedureName, String... resultSetMappings) Deprecated as a consequence of `ProcedureCall` being deprecated. See corresponding docs for further information. Creates a call to a stored procedure with specific result set entity mappings. Parameters procedureName:String The name of the procedure. resultSetMappings:String[] The explicit result set mapping(s) to use for mapping the results Returns:ProcedureCall The representation of the procedure call.

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

Deprecated

as a consequence of ProcedureCall being deprecated. See corresponding docs for further information.

Creates a call to a stored procedure with specific result set entity mappings.

Parameters

procedureName:String: The name of the procedure.
resultSetMappings:String[]: The explicit result set mapping(s) to use for mapping the results

Returns:ProcedureCall

The representation of the procedure call.

doReturningWork back to summary

doReturningWork	back to summary
public default <T> T doReturningWork(ReturningWork<T> work) throws HibernateException Controller for allowing users to perform JDBC related work using the Connection managed by this Session. After execution returns the result of the `ReturningWork#execute` call. Parameters <T> The type of the result returned from the work work:ReturningWork<T> The work to be performed. Returns:T the result from calling `ReturningWork#execute`. Exceptions HibernateException: Generally indicates wrapped `java.sql.SQLException`

public default <T> T doReturningWork(ReturningWork<T> work) throws HibernateException

Controller for allowing users to perform JDBC related work using the Connection managed by this Session. After execution returns the result of the ReturningWork#execute call.

Parameters

<T>: The type of the result returned from the work
work:ReturningWork<T>: The work to be performed.

Returns:T

the result from calling ReturningWork#execute.

Exceptions

HibernateException:: Generally indicates wrapped java.sql.SQLException

doWork back to summary

doWork	back to summary
public default void doWork(Work work) throws HibernateException Controller for allowing users to perform JDBC related work using the Connection managed by this Session. Parameters work:Work The work to be performed. Exceptions HibernateException: Generally indicates wrapped `java.sql.SQLException`

public default void doWork(Work work) throws HibernateException

Controller for allowing users to perform JDBC related work using the Connection managed by this Session.

Parameters

work:Work: The work to be performed.

Exceptions

HibernateException:: Generally indicates wrapped java.sql.SQLException

getJdbcBatchSize back to summary

getJdbcBatchSize	back to summary
public Integer getJdbcBatchSize() Get the Session-level JDBC batch size for the current Session. Overrides the SessionFactory JDBC batch size defined by the `hibernate.default_batch_fetch_size` configuration property for the scope of the current `Session`. Returns:Integer Session-level JDBC batch size Since 5.2 See Also `org.hibernate.boot.spi.SessionFactoryOptions#getJdbcBatchSize`, `org.hibernate.boot.SessionFactoryBuilder#applyJdbcBatchSize`

public Integer getJdbcBatchSize()

Get the Session-level JDBC batch size for the current Session. Overrides the SessionFactory JDBC batch size defined by the hibernate.default_batch_fetch_size configuration property for the scope of the current Session.

Returns:Integer: Session-level JDBC batch size
Since: 5.2
See Also: org.hibernate.boot.spi.SessionFactoryOptions#getJdbcBatchSize, org.hibernate.boot.SessionFactoryBuilder#applyJdbcBatchSize

getNamedProcedureCall back to summary

getNamedProcedureCall	back to summary
public ProcedureCall getNamedProcedureCall(String name) Deprecated as a consequence of `ProcedureCall` being deprecated. See corresponding docs for further information. Gets a ProcedureCall based on a named template Parameters name:String The name given to the template Returns:ProcedureCall The ProcedureCall See Also `javax.persistence.NamedStoredProcedureQuery`

public ProcedureCall getNamedProcedureCall(String name)

Deprecated

as a consequence of ProcedureCall being deprecated. See corresponding docs for further information.

Gets a ProcedureCall based on a named template

Parameters

name:String: The name given to the template

Returns:ProcedureCall

The ProcedureCall

getNamedQuery back to summary

getNamedQuery	back to summary
public Query<R> getNamedQuery(String queryName) Redeclares org.hibernate.query.QueryProducer.getNamedQuery. Doc from org.hibernate.query.QueryProducer.getNamedQuery. Deprecated as a consequence of `Query` being deprecated. See corresponding docs for further information. Create a `Query` instance for the named query. Parameters queryName:String the name of a pre-defined, named query Returns:Query<R> The Query instance for manipulation and execution Annotations @Override

public Query<R> getNamedQuery(String queryName)

Redeclares org.hibernate.query.QueryProducer.getNamedQuery.

Doc from org.hibernate.query.QueryProducer.getNamedQuery.

Deprecated

as a consequence of Query being deprecated. See corresponding docs for further information.

Create a Query instance for the named query.

Parameters

queryName:String: the name of a pre-defined, named query

Returns:Query<R>

The Query instance for manipulation and execution

Annotations

@Override

getTenantIdentifier back to summary

getTenantIdentifier	back to summary
public String getTenantIdentifier() Obtain the tenant identifier associated with this session. Returns:String The tenant identifier associated with this session, or `null`

public String getTenantIdentifier()

Obtain the tenant identifier associated with this session.

Returns:String: The tenant identifier associated with this session, or null

getTransaction back to summary

getTransaction	back to summary
public Transaction getTransaction() Get the `Transaction` instance associated with this session. The concrete type of the returned `Transaction` object is determined by the `hibernate.transaction_factory` property. Returns:Transaction a Transaction instance

public Transaction getTransaction()

Get the Transaction instance associated with this session. The concrete type of the returned Transaction object is determined by the hibernate.transaction_factory property.

Returns:Transaction: a Transaction instance

isConnected	back to summary
public boolean isConnected() Check if the session is currently connected. Returns:boolean boolean

isConnected

back to summary

public boolean isConnected()

Check if the session is currently connected.

Returns:boolean: boolean

isOpen	back to summary
public boolean isOpen() Check if the session is still open. Returns:boolean boolean

isOpen

back to summary

public boolean isOpen()

Check if the session is still open.

Returns:boolean: boolean

setJdbcBatchSize back to summary

setJdbcBatchSize	back to summary
public void setJdbcBatchSize(Integer jdbcBatchSize) Set the Session-level JDBC batch size. Overrides the SessionFactory JDBC batch size defined by the `hibernate.default_batch_fetch_size` configuration property for the scope of the current `Session`. Parameters jdbcBatchSize:Integer Session-level JDBC batch size Since 5.2 See Also `org.hibernate.boot.spi.SessionFactoryOptions#getJdbcBatchSize`, `org.hibernate.boot.SessionFactoryBuilder#applyJdbcBatchSize`

public void setJdbcBatchSize(Integer jdbcBatchSize)

Set the Session-level JDBC batch size. Overrides the SessionFactory JDBC batch size defined by the hibernate.default_batch_fetch_size configuration property for the scope of the current Session.

Parameters

jdbcBatchSize:Integer: Session-level JDBC batch size

Since

5.2

public Interface SharedSessionContract

Method Summary

Method Detail