Package org.hibernate.annotations

Annotation Interface SQLInsert


@Target({TYPE,FIELD,METHOD})@Retention(RUNTIME)@Repeatable(SQLInserts.class)public @interfaceSQLInsert
Specifies a custom SQL DML statement to be used in place of the default SQL generated by Hibernate when an entity or collection row is inserted in the database.

The givenSQL statement must have exactly the number of JDBC? parameters that Hibernate expects, that is, one for each column mapped by the entity, in the exact order Hibernate expects. In particular, theprimary key columns must come last.

If a column shouldnot be written as part of the insert statement, and has no corresponding JDBC parameter in the custom SQL, it must be mapped usinginsertable=false.

A custom SQL insert statement might assign a value to a mapped column as it is written. In this case, the corresponding property of the entity remains unassigned after the insert is executed unless@Generated is specified, forcing Hibernate to reread the state of the entity after each insert.

Similarly, a custom insert statement might transform a mapped column value as it is written. In this case, the state of the entity held in memory loses synchronization with the database after the insert is executed unless@Generated(writable=true) is specified, again forcing Hibernate to reread the state of the entity after each insert.

If an entity hassecondary tables, it may have a@SQLInsert annotation for each secondary table. Thetable() member must specify the name of the secondary table.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Procedure name or SQLINSERT statement.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    Is the statement callable (aka aCallableStatement)?
    Deprecated, for removal: This API element is subject to removal in a future version.
    useverify() with anExpectation class
    The name of the table affected by the insert statement.
    Class<? extendsExpectation>
    AnExpectation class used to verify that the operation was successful.