org.apache.ibatis.annotations

Annotation Type Options

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Repeatable(value=Options.List.class)
public @interface Options

The annotation that specify options for customizing default behaviors.

How to use:

 public interface UserMapper {
   @Options(useGeneratedKeys = true, keyProperty = "id")
   @Insert("INSERT INTO users (name) VALUES(#{name})")
   boolean insert(User user);
 }
 

Author:

Clinton Begin

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	databaseId
int	fetchSize Returns the fetch size.
Options.FlushCachePolicy	flushCache Returns the 2nd cache flush strategy.
String	keyColumn Returns column names that retrieves a key value.
String	keyProperty Returns property names that holds a key value.
String	resultSets Returns result set names.
ResultSetType	resultSetType Returns the result set type.
StatementType	statementType Return the statement type.
int	timeout Returns the statement timeout.
boolean	useCache Returns whether use the 2nd cache feature if assigned the cache.
boolean	useGeneratedKeys Returns whether use the generated keys feature supported by JDBC 3.0

Element Detail

useCache

public abstract boolean useCache

Returns whether use the 2nd cache feature if assigned the cache.

Returns:

true if use; false if otherwise

Default:

true

flushCache

public abstract Options.FlushCachePolicy flushCache

Returns the 2nd cache flush strategy.

Returns:

the 2nd cache flush strategy

Default:

org.apache.ibatis.annotations.Options.FlushCachePolicy.DEFAULT

resultSetType

public abstract ResultSetType resultSetType

Returns the result set type.

Returns:

the result set type

Default:

org.apache.ibatis.mapping.ResultSetType.DEFAULT

statementType

public abstract StatementType statementType

Return the statement type.

Returns:

the statement type

Default:

org.apache.ibatis.mapping.StatementType.PREPARED

fetchSize

public abstract int fetchSize

Returns the fetch size.

Returns:

the fetch size

Default:

-1

timeout

public abstract int timeout

Returns the statement timeout.

Returns:

the statement timeout

Default:

-1

useGeneratedKeys

public abstract boolean useGeneratedKeys

Returns whether use the generated keys feature supported by JDBC 3.0

Returns:

true if use; false if otherwise

Default:

false

keyProperty

public abstract String keyProperty

Returns property names that holds a key value.

If you specify multiple property, please separate using comma(',').

Returns:

property names that separate with comma(',')

Default:

""

keyColumn

public abstract String keyColumn

Returns column names that retrieves a key value.

If you specify multiple column, please separate using comma(',').

Returns:

column names that separate with comma(',')

Default:

""

resultSets

public abstract String resultSets

Returns result set names.

If you specify multiple result set, please separate using comma(',').

Returns:

result set names that separate with comma(',')

Default:

""

databaseId

public abstract String databaseId

Returns:

A database id that correspond this options

Since:

3.5.5

Default:

""