io.ebean.annotation

Enum PersistBatch

java.lang.Object

java.lang.Enum<PersistBatch>

io.ebean.annotation.PersistBatch

All Implemented Interfaces:

Serializable, Comparable<PersistBatch>

public enum PersistBatch
extends Enum<PersistBatch>

Defines the mode for JDBC batch processing.

Used both at a per transaction basis and per request basis.

  // set full jdbc batch as default
  serverConfig.setPersistBatch(PersistBatch.ALL);


  // set full jdbc batch per transaction
  transaction.setBatch(PersistBatch.ALL);

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Use JDBC Batch mode on Inserts, Updates and Deletes.
INHERIT You should not use this value explicitly.
INSERT Use JDBC Batch mode on Inserts.
NONE Do not use JDBC Batch mode.

Method Summary

Modifier and Type	Method and Description
boolean	forInsert() Return true if persist cascade should use JDBC batch for inserts.
static PersistBatch	valueOf(String name) Returns the enum constant of this type with the specified name.
static PersistBatch[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final PersistBatch NONE

Do not use JDBC Batch mode.

INSERT

public static final PersistBatch INSERT

Use JDBC Batch mode on Inserts.

ALL

public static final PersistBatch ALL

Use JDBC Batch mode on Inserts, Updates and Deletes.

INHERIT

public static final PersistBatch INHERIT

You should not use this value explicitly. It should only used on the Transactional annotation to indicate that the value should inherit from the ServerConfig setting.

Method Detail

values

public static PersistBatch[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PersistBatch c : PersistBatch.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PersistBatch valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forInsert

public boolean forInsert()

Return true if persist cascade should use JDBC batch for inserts.