001package io.ebean.annotation;
002
003/**
004 * Defines the mode for JDBC batch processing.
005 * <p>
006 * Used both at a per transaction basis and per request basis.
007 * </p>
008 *
009 * <pre>{@code
010 *
011 *   // set full jdbc batch as default
012 *   serverConfig.setPersistBatch(PersistBatch.ALL);
013 *
014 *
015 *   // set full jdbc batch per transaction
016 *   transaction.setBatchMode(true);
017 *
018 * }</pre>
019 *
020 */
021public enum PersistBatch {
022
023  /**
024   * Do not use JDBC Batch mode.
025   */
026  NONE,
027
028  /**
029   * Use JDBC Batch mode on Inserts, Updates and Deletes.
030   */
031  ALL,
032
033  /**
034   * You should not use this value explicitly. It should only used on the Transactional annotation
035   * to indicate that the value should inherit from the ServerConfig setting.
036   */
037  INHERIT
038}