Package org.hibernate.id.insert

Interface InsertGeneratedIdentifierDelegate

All Known Implementing Classes:

AbstractReturningDelegate, AbstractSelectingDelegate, BasicSelectingDelegate, GetGeneratedKeysDelegate, InsertReturningDelegate, Oracle12cGetGeneratedKeysDelegate, SybaseJConnGetGeneratedKeysDelegate, UniqueKeySelectingDelegate

public interface InsertGeneratedIdentifierDelegate

Each implementation defines a strategy for retrieving a primary key generated by the database from the database after execution of an insert statement. The generated primary key is usually an IDENTITY column, but in principle it might be something else, for example, a value generated by a trigger.

An implementation controls:

• building the SQL insert statement, and
• retrieving the generated identifier value using JDBC.

The implementation should be written to handle any instance of OnExecutionGenerator.

See Also:

OnExecutionGenerator

Method Summary

Modifier and Type	Method	Description
TableInsertBuilder	createTableInsertBuilder(BasicEntityIdentifierMapping identifierMapping, Expectation expectation, SessionFactoryImplementor sessionFactory)	Create a TableInsertBuilder with any specific identity handling already built in.
Object	performInsert(String insertSQL, SharedSessionContractImplementor session, Binder binder)	Execute the given insert statement and return the generated key value.
Object	performInsert(PreparedStatementDetails insertStatementDetails, JdbcValueBindings valueBindings, Object entity, SharedSessionContractImplementor session)	Perform the insert and extract the database-generated primary key value.
default String	prepareIdentifierGeneratingInsert(String insertSQL)	Append SQL specific to this delegate's mode of handling generated primary key values to the given insert statement.
IdentifierGeneratingInsert	prepareIdentifierGeneratingInsert(SqlStringGenerationContext context)	Deprecated. this is no longer called
PreparedStatement	prepareStatement(String insertSql, SharedSessionContractImplementor session)

Method Detail

createTableInsertBuilder

TableInsertBuilder createTableInsertBuilder(BasicEntityIdentifierMapping identifierMapping,
                                            Expectation expectation,
                                            SessionFactoryImplementor sessionFactory)

Create a TableInsertBuilder with any specific identity handling already built in.

prepareStatement

PreparedStatement prepareStatement(String insertSql,
                                   SharedSessionContractImplementor session)

performInsert

Object performInsert(PreparedStatementDetails insertStatementDetails,
                     JdbcValueBindings valueBindings,
                     Object entity,
                     SharedSessionContractImplementor session)

Perform the insert and extract the database-generated primary key value.

See Also:

createTableInsertBuilder(org.hibernate.metamodel.mapping.BasicEntityIdentifierMapping, org.hibernate.jdbc.Expectation, org.hibernate.engine.spi.SessionFactoryImplementor)

prepareIdentifierGeneratingInsert

@Deprecated(since="6.2")
IdentifierGeneratingInsert prepareIdentifierGeneratingInsert(SqlStringGenerationContext context)

Deprecated.

this is no longer called

Build an insert statement specific to the delegate's mode of handling generated key values.

Parameters:

context - A context to help generate SQL strings

Returns:

An IdentifierGeneratingInsert

prepareIdentifierGeneratingInsert

default String prepareIdentifierGeneratingInsert(String insertSQL)

Append SQL specific to this delegate's mode of handling generated primary key values to the given insert statement.

Returns:

The processed insert statement string

performInsert

Object performInsert(String insertSQL,
                     SharedSessionContractImplementor session,
                     Binder binder)

Execute the given insert statement and return the generated key value.

Parameters:

insertSQL - The insert statement string

session - The session in which we are operating

binder - The parameter binder

Returns:

The generated identifier value