org.seasar.doma

Annotation Type Insert

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

Indicates a insert.

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

 @Entity
 public class Employee {
     ...
 }

 @Dao
 public interface EmployeeDao {

     @Insert
     int insert(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
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	excludeNull Whether SQL NULL columns are excluded from SQL INSERT statements.
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

excludeNull

public abstract boolean excludeNull

Whether SQL NULL columns are excluded from SQL INSERT statements.

Only if sqlFile() is false, this element value is used.

Returns:

whether SQL NULL columns are excluded

Default:

false

include

public abstract java.lang.String[] include

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

Only if sqlFile() is false, this element value is used.

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 element value is used.

Returns:

the excluded properties

Default:

{}

sqlLog

public abstract SqlLogType sqlLog

Returns:

the output format of SQL logs.

Default:

org.seasar.doma.jdbc.SqlLogType.FORMATTED

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