EventType (mysql-binlog-connector-java 0.20.1 API)

java.lang.Object
- java.lang.Enum<EventType>
- - com.github.shyiko.mysql.binlog.event.EventType

All Implemented Interfaces:

Serializable, Comparable<EventType>
```
public enum EventType
extends Enum<EventType>
```
Author:

Stanley Shyiko

See Also:

Event Meanings for the original documentation.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANONYMOUS_GTID`
`APPEND_BLOCK` Used for LOAD DATA INFILE statements as of MySQL 4.0.
`BEGIN_LOAD_QUERY` Used for LOAD DATA INFILE statements as of MySQL 5.0.
`CREATE_FILE` Used for LOAD DATA INFILE statements in MySQL 4.0 and 4.1.
`DELETE_FILE` Used for LOAD DATA INFILE statements as of MySQL 4.0.
`DELETE_ROWS` Describes deleted rows (within a single table).
`EXEC_LOAD` Used for LOAD DATA INFILE statements in 4.0 and 4.1.
`EXECUTE_LOAD_QUERY` Used for LOAD DATA INFILE statements as of MySQL 5.0.
`EXT_DELETE_ROWS` Describes deleted rows (within a single table).
`EXT_UPDATE_ROWS` Describes updated rows (within a single table).
`EXT_WRITE_ROWS` Describes inserted rows (within a single table).
`FORMAT_DESCRIPTION` A descriptor event that is written to the beginning of the each binary log file.
`GTID` Global Transaction Identifier.
`HEARTBEAT` Sent by a master to a slave to let the slave know that the master is still alive.
`IGNORABLE` In some situations, it is necessary to send over ignorable data to the slave: data that a slave can handle in case there is code for handling it, but which can be ignored if it is not recognized.
`INCIDENT` Used to log an out of the ordinary event that occurred on the master.
`INTVAR` Written every time a statement uses an AUTO_INCREMENT column or the LAST_INSERT_ID() function; precedes other events for the statement.
`LOAD` Used for LOAD DATA INFILE statements in MySQL 3.23.
`NEW_LOAD` Used for LOAD DATA INFILE statements in MySQL 4.0 and 4.1.
`PRE_GA_DELETE_ROWS` Describes deleted rows (within a single table).
`PRE_GA_UPDATE_ROWS` Describes updated rows (within a single table).
`PRE_GA_WRITE_ROWS` Describes inserted rows (within a single table).
`PREVIOUS_GTIDS`
`QUERY` Written when an updating statement is done.
`RAND` Written every time a statement uses the RAND() function; precedes other events for the statement.
`ROTATE` Written when mysqld switches to a new binary log file.
`ROWS_QUERY` Introduced to record the original query for rows events in RBR.
`SLAVE` Not used.
`START_V3` A descriptor event that is written to the beginning of the each binary log file.
`STOP` Written when mysqld stops.
`TABLE_MAP` This event precedes each row operation event.
`TRANSACTION_CONTEXT`
`UNKNOWN` Events of this event type should never occur.
`UPDATE_ROWS` Describes updated rows (within a single table).
`USER_VAR` Written every time a statement uses a user variable; precedes other events for the statement.
`VIEW_CHANGE`
`WRITE_ROWS` Describes inserted rows (within a single table).
`XA_PREPARE` Prepared XA transaction terminal event similar to XID except that it is specific to XA transaction.
`XID` Generated for a commit of a transaction that modifies one or more tables of an XA-capable storage engine.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`isDelete(EventType eventType)`
`static boolean`	`isRowMutation(EventType eventType)`
`static boolean`	`isUpdate(EventType eventType)`
`static boolean`	`isWrite(EventType eventType)`
`static EventType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EventType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - UNKNOWN
```
public static final EventType UNKNOWN
```
    Events of this event type should never occur. Not written to a binary log.
  - START_V3
```
public static final EventType START_V3
```
    A descriptor event that is written to the beginning of the each binary log file. (In MySQL 4.0 and 4.1, this event is written only to the first binary log file that the server creates after startup.) This event is used in MySQL 3.23 through 4.1 and superseded in MySQL 5.0 by FORMAT_DESCRIPTION.
  - QUERY
```
public static final EventType QUERY
```
    Written when an updating statement is done.
  - STOP
```
public static final EventType STOP
```
    Written when mysqld stops.
  - ROTATE
```
public static final EventType ROTATE
```
    Written when mysqld switches to a new binary log file. This occurs when someone issues a FLUSH LOGS statement or the current binary log file becomes larger than max_binlog_size.
  - INTVAR
```
public static final EventType INTVAR
```
    Written every time a statement uses an AUTO_INCREMENT column or the LAST_INSERT_ID() function; precedes other events for the statement. This is written only before a QUERY and is not used in case of RBR.
  - LOAD
```
public static final EventType LOAD
```
    Used for LOAD DATA INFILE statements in MySQL 3.23.
  - SLAVE
```
public static final EventType SLAVE
```
    Not used.
  - CREATE_FILE
```
public static final EventType CREATE_FILE
```
    Used for LOAD DATA INFILE statements in MySQL 4.0 and 4.1.
  - APPEND_BLOCK
```
public static final EventType APPEND_BLOCK
```
    Used for LOAD DATA INFILE statements as of MySQL 4.0.
  - EXEC_LOAD
```
public static final EventType EXEC_LOAD
```
    Used for LOAD DATA INFILE statements in 4.0 and 4.1.
  - DELETE_FILE
```
public static final EventType DELETE_FILE
```
    Used for LOAD DATA INFILE statements as of MySQL 4.0.
  - NEW_LOAD
```
public static final EventType NEW_LOAD
```
    Used for LOAD DATA INFILE statements in MySQL 4.0 and 4.1.
  - RAND
```
public static final EventType RAND
```
    Written every time a statement uses the RAND() function; precedes other events for the statement. Indicates the seed values to use for generating a random number with RAND() in the next statement. This is written only before a QUERY and is not used in case of RBR.
  - USER_VAR
```
public static final EventType USER_VAR
```
    Written every time a statement uses a user variable; precedes other events for the statement. Indicates the value to use for the user variable in the next statement. This is written only before a QUERY and is not used in case of RBR.
  - FORMAT_DESCRIPTION
```
public static final EventType FORMAT_DESCRIPTION
```
    A descriptor event that is written to the beginning of the each binary log file. This event is used as of MySQL 5.0; it supersedes START_V3.
  - XID
```
public static final EventType XID
```
    Generated for a commit of a transaction that modifies one or more tables of an XA-capable storage engine. Normal transactions are implemented by sending a QUERY containing a BEGIN statement and a QUERY containing a COMMIT statement (or a ROLLBACK statement if the transaction is rolled back).
  - BEGIN_LOAD_QUERY
```
public static final EventType BEGIN_LOAD_QUERY
```
    Used for LOAD DATA INFILE statements as of MySQL 5.0.
  - EXECUTE_LOAD_QUERY
```
public static final EventType EXECUTE_LOAD_QUERY
```
    Used for LOAD DATA INFILE statements as of MySQL 5.0.
  - TABLE_MAP
```
public static final EventType TABLE_MAP
```
    This event precedes each row operation event. It maps a table definition to a number, where the table definition consists of database and table names and column definitions. The purpose of this event is to enable replication when a table has different definitions on the master and slave. Row operation events that belong to the same transaction may be grouped into sequences, in which case each such sequence of events begins with a sequence of TABLE_MAP events: one per table used by events in the sequence. Used in case of RBR.
  - PRE_GA_WRITE_ROWS
```
public static final EventType PRE_GA_WRITE_ROWS
```
    Describes inserted rows (within a single table). Used in case of RBR (5.1.0 - 5.1.15).
  - PRE_GA_UPDATE_ROWS
```
public static final EventType PRE_GA_UPDATE_ROWS
```
    Describes updated rows (within a single table). Used in case of RBR (5.1.0 - 5.1.15).
  - PRE_GA_DELETE_ROWS
```
public static final EventType PRE_GA_DELETE_ROWS
```
    Describes deleted rows (within a single table). Used in case of RBR (5.1.0 - 5.1.15).
  - WRITE_ROWS
```
public static final EventType WRITE_ROWS
```
    Describes inserted rows (within a single table). Used in case of RBR (5.1.16 - mysql-trunk).
  - UPDATE_ROWS
```
public static final EventType UPDATE_ROWS
```
    Describes updated rows (within a single table). Used in case of RBR (5.1.16 - mysql-trunk).
  - DELETE_ROWS
```
public static final EventType DELETE_ROWS
```
    Describes deleted rows (within a single table). Used in case of RBR (5.1.16 - mysql-trunk).
  - INCIDENT
```
public static final EventType INCIDENT
```
    Used to log an out of the ordinary event that occurred on the master. It notifies the slave that something happened on the master that might cause data to be in an inconsistent state.
  - HEARTBEAT
```
public static final EventType HEARTBEAT
```
    Sent by a master to a slave to let the slave know that the master is still alive. Not written to a binary log.
  - IGNORABLE
```
public static final EventType IGNORABLE
```
    In some situations, it is necessary to send over ignorable data to the slave: data that a slave can handle in case there is code for handling it, but which can be ignored if it is not recognized.
  - ROWS_QUERY
```
public static final EventType ROWS_QUERY
```
    Introduced to record the original query for rows events in RBR.
  - EXT_WRITE_ROWS
```
public static final EventType EXT_WRITE_ROWS
```
    Describes inserted rows (within a single table). Used in case of RBR (5.1.18+).
  - EXT_UPDATE_ROWS
```
public static final EventType EXT_UPDATE_ROWS
```
    Describes updated rows (within a single table). Used in case of RBR (5.1.18+).
  - EXT_DELETE_ROWS
```
public static final EventType EXT_DELETE_ROWS
```
    Describes deleted rows (within a single table). Used in case of RBR (5.1.18+).
  - GTID
```
public static final EventType GTID
```
    Global Transaction Identifier.
  - ANONYMOUS_GTID
```
public static final EventType ANONYMOUS_GTID
```
  - PREVIOUS_GTIDS
```
public static final EventType PREVIOUS_GTIDS
```
  - TRANSACTION_CONTEXT
```
public static final EventType TRANSACTION_CONTEXT
```
  - VIEW_CHANGE
```
public static final EventType VIEW_CHANGE
```
  - XA_PREPARE
```
public static final EventType XA_PREPARE
```
    Prepared XA transaction terminal event similar to XID except that it is specific to XA transaction.
- Method Detail
  - values
```
public static EventType[] 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 (EventType c : EventType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EventType 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
  - isRowMutation
```
public static boolean isRowMutation(EventType eventType)
```
  - isWrite
```
public static boolean isWrite(EventType eventType)
```
  - isUpdate
```
public static boolean isUpdate(EventType eventType)
```
  - isDelete
```
public static boolean isDelete(EventType eventType)
```

Enum EventType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNKNOWN

START_V3

QUERY

STOP

ROTATE

INTVAR

LOAD

SLAVE

CREATE_FILE

APPEND_BLOCK

EXEC_LOAD

DELETE_FILE

NEW_LOAD

RAND

USER_VAR

FORMAT_DESCRIPTION

XID

BEGIN_LOAD_QUERY

EXECUTE_LOAD_QUERY

TABLE_MAP

PRE_GA_WRITE_ROWS

PRE_GA_UPDATE_ROWS

PRE_GA_DELETE_ROWS

WRITE_ROWS

UPDATE_ROWS

DELETE_ROWS

INCIDENT

HEARTBEAT

IGNORABLE

ROWS_QUERY

EXT_WRITE_ROWS

EXT_UPDATE_ROWS

EXT_DELETE_ROWS

GTID

ANONYMOUS_GTID

PREVIOUS_GTIDS

TRANSACTION_CONTEXT

VIEW_CHANGE

XA_PREPARE

Method Detail

values

valueOf

isRowMutation

isWrite

isUpdate

isDelete