org.seasar.doma

Annotation Type BatchInsert

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface BatchInsert

Indicates a batch insert.

The annotated method must be a member of a Dao annotated interface.

 @Entity
 public class Employee {
     ...
 }

 @Dao
 public interface EmployeeDao {

     @BatchInsert
     int[] insert(List<Employee> employee);
 }
 

The method may throw following exceptions:

• DomaNullPointerException if any of the method parameters are null
• UniqueConstraintException if an unique constraint is violated
• SqlFileNotFoundException if sqlFile is true and the SQL file is not found
• JdbcException if a JDBC related error occurs

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	batchSize The batch size.
DuplicateKeyType	duplicateKeyType This variable represents the type of duplicate key handling strategy for an insert operation.
java.lang.String[]	exclude The properties whose mapped columns are excluded from SQL INSERT statements.
boolean	ignoreGeneratedKeys Whether auto-generated keys are not retrieved from the database to improve performance.
java.lang.String[]	include The properties whose mapped columns are included in SQL INSERT statements.
int	queryTimeout The query timeout in seconds.
boolean	sqlFile
SqlLogType	sqlLog

Element Detail

sqlFile

public abstract boolean sqlFile

Returns:

whether the annotated method is mapped to an SQL file.

Default:

false

queryTimeout

public abstract int queryTimeout

The query timeout in seconds.

If not specified, Config.getQueryTimeout() is used.

Returns:

the query timeout

See Also:

Statement.setQueryTimeout(int)

Default:

-1

batchSize

public abstract int batchSize

The batch size.

If not specified, Config.getBatchSize() is used.

This value is used when Statement.executeBatch() is executed.

Returns:

the batch size

See Also:

PreparedStatement.addBatch()

Default:

-1

include

public abstract java.lang.String[] include

The properties whose mapped columns are included in SQL INSERT statements.

Only if sqlFile() is false, this value is available.

Returns:

the included properties

Default:

{}

exclude

public abstract java.lang.String[] exclude

The properties whose mapped columns are excluded from SQL INSERT statements.

Only if sqlFile() is false, this value is available.

Returns:

the excluded properties

Default:

{}

sqlLog

public abstract SqlLogType sqlLog

Returns:

the output format of SQL logs.

Default:

org.seasar.doma.jdbc.SqlLogType.FORMATTED

ignoreGeneratedKeys

public abstract boolean ignoreGeneratedKeys

Whether auto-generated keys are not retrieved from the database to improve performance. If this flag is enabled, entities won't have auto-generated keys.

Returns:

Whether auto-generated keys are not retrieved.

Default:

false

duplicateKeyType

public abstract DuplicateKeyType duplicateKeyType

This variable represents the type of duplicate key handling strategy for an insert operation. It can have one of three values:

• UPDATE: If a duplicate key is encountered, the existing row in the table will be updated.
• IGNORE: If a duplicate key is encountered, the insert operation will be ignored, and no changes will be made to the table.
• EXCEPTION: If a duplicate key is encountered, the operation will throw an exception, indicating that a duplicate key exists.

Returns:

the type of duplicate key handling strategy for an insert operation.

Default:

org.seasar.doma.jdbc.query.DuplicateKeyType.EXCEPTION