Package org.hibernate.id.insert

Interface InsertGeneratedIdentifierDelegate

All Superinterfaces:

GeneratedValuesMutationDelegate

All Known Implementing Classes:

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

@Deprecated(forRemoval=true,
            since="6.5")
public interface InsertGeneratedIdentifierDelegate
extends GeneratedValuesMutationDelegate

Deprecated, for removal: This API element is subject to removal in a future version.

Use GeneratedValuesMutationDelegate instead.

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.

Author:

Steve Ebersole

See Also:

• OnExecutionGenerator

Method Summary

Modifier and Type	Method	Description
default TableInsertBuilder	createTableInsertBuilder(BasicEntityIdentifierMapping identifierMapping, Expectation expectation, SessionFactoryImplementor sessionFactory)	Deprecated, for removal: This API element is subject to removal in a future version. Create a TableInsertBuilder with any specific identity handling already built in.
default Object	performInsert(String insertSQL, SharedSessionContractImplementor session, Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. Execute the given insert statement and return the generated key value.
default Object	performInsert(PreparedStatementDetails insertStatementDetails, JdbcValueBindings valueBindings, Object entity, SharedSessionContractImplementor session)	Deprecated, for removal: This API element is subject to removal in a future version. Perform the insert and extract the database-generated primary key value.
GeneratedValues	performInsertReturning(String insertSQL, SharedSessionContractImplementor session, Binder binder)	Deprecated, for removal: This API element is subject to removal in a future version. Execute the given insert statement and return the generated key value.
default String	prepareIdentifierGeneratingInsert(String insertSQL)	Deprecated, for removal: This API element is subject to removal in a future version. Append SQL specific to this delegate's mode of handling generated primary key values to the given insert statement.
PreparedStatement	prepareStatement(String insertSql, SharedSessionContractImplementor session)	Deprecated, for removal: This API element is subject to removal in a future version. Create a PreparedStatement from the provided sql based on the delegate needs.

Methods inherited from interface org.hibernate.generator.values.GeneratedValuesMutationDelegate

createTableMutationBuilder, getGeneratedValuesMappingProducer, getTiming, performMutation, supportsArbitraryValues, supportsRowId

Method Details

createTableInsertBuilder

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

prepareStatement

PreparedStatement prepareStatement(String insertSql,
 SharedSessionContractImplementor session)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: GeneratedValuesMutationDelegate

Create a PreparedStatement from the provided sql based on the delegate needs.

Specified by:

prepareStatement in interface GeneratedValuesMutationDelegate

performInsert

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

default String prepareIdentifierGeneratingInsert(String insertSQL)

Deprecated, for removal: This API element is subject to removal in a future version.

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

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

performInsertReturning

GeneratedValues performInsertReturning(String insertSQL,
 SharedSessionContractImplementor session,
 Binder binder)

Deprecated, for removal: This API element is subject to removal in a future version.

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