UknownLogEvent if event type is unknown or skipped,
- * null if buffer is not including a full event.
+ * null if buffer is not including a full event.
*/
- public LogEvent decode(LogBuffer buffer, LogContext context)
- throws IOException
- {
+ public LogEvent decode(LogBuffer buffer, LogContext context) throws IOException {
final int limit = buffer.limit();
- if (limit >= FormatDescriptionLogEvent.LOG_EVENT_HEADER_LEN)
- {
- LogHeader header = new LogHeader(buffer,
- context.getFormatDescription());
+ if (limit >= FormatDescriptionLogEvent.LOG_EVENT_HEADER_LEN) {
+ LogHeader header = new LogHeader(buffer, context.getFormatDescription());
final int len = header.getEventLen();
- if (limit >= len)
- {
+ if (limit >= len) {
LogEvent event;
/* Checking binary-log's header */
- if (handleSet.get(header.getType()))
- {
+ if (handleSet.get(header.getType())) {
buffer.limit(len);
- try
- {
+ try {
/* Decoding binary-log to event */
event = decode(buffer, header, context);
- }
- catch (IOException e)
- {
- if (logger.isWarnEnabled())
- logger.warn("Decoding "
- + LogEvent.getTypeName(header.getType())
- + " failed from: "
- + context.getLogPosition(), e);
+ } catch (IOException e) {
+ if (logger.isWarnEnabled()) logger.warn("Decoding " + LogEvent.getTypeName(header.getType())
+ + " failed from: " + context.getLogPosition(), e);
throw e;
- }
- finally
- {
+ } finally {
buffer.limit(limit); /* Restore limit */
}
- }
- else
- {
+ } else {
/* Ignore unsupported binary-log. */
event = new UnknownLogEvent(header);
}
@@ -152,338 +132,275 @@ public final class LogDecoder
*
* @return UknownLogEvent if event type is unknown or skipped.
*/
- public static LogEvent decode(LogBuffer buffer, LogHeader header,
- LogContext context) throws IOException
- {
+ public static LogEvent decode(LogBuffer buffer, LogHeader header, LogContext context) throws IOException {
FormatDescriptionLogEvent descriptionEvent = context.getFormatDescription();
LogPosition logPosition = context.getLogPosition();
-
+
int checksumAlg = LogEvent.BINLOG_CHECKSUM_ALG_UNDEF;
if (header.getType() != LogEvent.FORMAT_DESCRIPTION_EVENT) {
checksumAlg = descriptionEvent.header.getChecksumAlg();
- }else {
+ } else {
// 如果是format事件自己，也需要处理checksum
checksumAlg = header.getChecksumAlg();
}
-
+
if (checksumAlg != LogEvent.BINLOG_CHECKSUM_ALG_OFF && checksumAlg != LogEvent.BINLOG_CHECKSUM_ALG_UNDEF) {
// remove checksum bytes
buffer.limit(header.getEventLen() - LogEvent.BINLOG_CHECKSUM_LEN);
}
-
- switch (header.getType())
- {
- case LogEvent.QUERY_EVENT:
- {
- QueryLogEvent event = new QueryLogEvent(header, buffer,
- descriptionEvent);
+
+ switch (header.getType()) {
+ case LogEvent.QUERY_EVENT: {
+ QueryLogEvent event = new QueryLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
return event;
}
- case LogEvent.XID_EVENT:
- {
- XidLogEvent event = new XidLogEvent(header, buffer,
- descriptionEvent);
+ case LogEvent.XID_EVENT: {
+ XidLogEvent event = new XidLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
return event;
}
- case LogEvent.TABLE_MAP_EVENT:
- {
- TableMapLogEvent mapEvent = new TableMapLogEvent(header,
- buffer, descriptionEvent);
+ case LogEvent.TABLE_MAP_EVENT: {
+ TableMapLogEvent mapEvent = new TableMapLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
context.putTable(mapEvent);
return mapEvent;
}
- case LogEvent.WRITE_ROWS_EVENT_V1:
- {
- RowsLogEvent event = new WriteRowsLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- event.fillTable(context);
- return event;
- }
- case LogEvent.UPDATE_ROWS_EVENT_V1:
- {
- RowsLogEvent event = new UpdateRowsLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- event.fillTable(context);
- return event;
- }
- case LogEvent.DELETE_ROWS_EVENT_V1:
- {
- RowsLogEvent event = new DeleteRowsLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- event.fillTable(context);
- return event;
- }
- case LogEvent.ROTATE_EVENT:
- {
- RotateLogEvent event = new RotateLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition = new LogPosition(event.getFilename(),
- event.getPosition());
- context.setLogPosition(logPosition);
- return event;
- }
- case LogEvent.LOAD_EVENT:
- case LogEvent.NEW_LOAD_EVENT:
- {
- LoadLogEvent event = new LoadLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.SLAVE_EVENT: /* can never happen (unused event) */
- {
- if (logger.isWarnEnabled())
- logger.warn("Skipping unsupported SLAVE_EVENT from: "
- + context.getLogPosition());
- break;
- }
- case LogEvent.CREATE_FILE_EVENT:
- {
- CreateFileLogEvent event = new CreateFileLogEvent(header,
- buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.APPEND_BLOCK_EVENT:
- {
- AppendBlockLogEvent event = new AppendBlockLogEvent(header,
- buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.DELETE_FILE_EVENT:
- {
- DeleteFileLogEvent event = new DeleteFileLogEvent(header,
- buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.EXEC_LOAD_EVENT:
- {
- ExecuteLoadLogEvent event = new ExecuteLoadLogEvent(header,
- buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.START_EVENT_V3:
- {
- /* This is sent only by MySQL <=4.x */
- StartLogEventV3 event = new StartLogEventV3(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.STOP_EVENT:
- {
- StopLogEvent event = new StopLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.INTVAR_EVENT:
- {
- IntvarLogEvent event = new IntvarLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.RAND_EVENT:
- {
- RandLogEvent event = new RandLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.USER_VAR_EVENT:
- {
- UserVarLogEvent event = new UserVarLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.FORMAT_DESCRIPTION_EVENT:
- {
- descriptionEvent = new FormatDescriptionLogEvent(header,
- buffer, descriptionEvent);
- context.setFormatDescription(descriptionEvent);
- return descriptionEvent;
- }
- case LogEvent.PRE_GA_WRITE_ROWS_EVENT:
- {
- if (logger.isWarnEnabled())
- logger.warn("Skipping unsupported PRE_GA_WRITE_ROWS_EVENT from: "
- + context.getLogPosition());
- // ev = new Write_rows_log_event_old(buf, event_len,
- // description_event);
- break;
- }
- case LogEvent.PRE_GA_UPDATE_ROWS_EVENT:
- {
- if (logger.isWarnEnabled())
- logger.warn("Skipping unsupported PRE_GA_UPDATE_ROWS_EVENT from: "
- + context.getLogPosition());
- // ev = new Update_rows_log_event_old(buf, event_len,
- // description_event);
- break;
- }
- case LogEvent.PRE_GA_DELETE_ROWS_EVENT:
- {
- if (logger.isWarnEnabled())
- logger.warn("Skipping unsupported PRE_GA_DELETE_ROWS_EVENT from: "
- + context.getLogPosition());
- // ev = new Delete_rows_log_event_old(buf, event_len,
- // description_event);
- break;
- }
- case LogEvent.BEGIN_LOAD_QUERY_EVENT:
- {
- BeginLoadQueryLogEvent event = new BeginLoadQueryLogEvent(
- header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.EXECUTE_LOAD_QUERY_EVENT:
- {
- ExecuteLoadQueryLogEvent event = new ExecuteLoadQueryLogEvent(
- header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.INCIDENT_EVENT:
- {
- IncidentLogEvent event = new IncidentLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.HEARTBEAT_LOG_EVENT:
- {
- HeartbeatLogEvent event = new HeartbeatLogEvent(header, buffer,
- descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.IGNORABLE_LOG_EVENT:
- {
- IgnorableLogEvent event = new IgnorableLogEvent(header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.ROWS_QUERY_LOG_EVENT:
- {
- RowsQueryLogEvent event = new RowsQueryLogEvent(header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.WRITE_ROWS_EVENT: {
+ case LogEvent.WRITE_ROWS_EVENT_V1: {
RowsLogEvent event = new WriteRowsLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
event.fillTable(context);
return event;
}
- case LogEvent.UPDATE_ROWS_EVENT: {
+ case LogEvent.UPDATE_ROWS_EVENT_V1: {
RowsLogEvent event = new UpdateRowsLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
event.fillTable(context);
return event;
}
- case LogEvent.DELETE_ROWS_EVENT: {
+ case LogEvent.DELETE_ROWS_EVENT_V1: {
RowsLogEvent event = new DeleteRowsLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
event.fillTable(context);
return event;
}
- case LogEvent.GTID_LOG_EVENT:
- case LogEvent.ANONYMOUS_GTID_LOG_EVENT:
+ case LogEvent.ROTATE_EVENT: {
+ RotateLogEvent event = new RotateLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition = new LogPosition(event.getFilename(), event.getPosition());
+ context.setLogPosition(logPosition);
+ return event;
+ }
+ case LogEvent.LOAD_EVENT:
+ case LogEvent.NEW_LOAD_EVENT: {
+ LoadLogEvent event = new LoadLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.SLAVE_EVENT: /* can never happen (unused event) */
{
+ if (logger.isWarnEnabled()) logger.warn("Skipping unsupported SLAVE_EVENT from: "
+ + context.getLogPosition());
+ break;
+ }
+ case LogEvent.CREATE_FILE_EVENT: {
+ CreateFileLogEvent event = new CreateFileLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.APPEND_BLOCK_EVENT: {
+ AppendBlockLogEvent event = new AppendBlockLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.DELETE_FILE_EVENT: {
+ DeleteFileLogEvent event = new DeleteFileLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.EXEC_LOAD_EVENT: {
+ ExecuteLoadLogEvent event = new ExecuteLoadLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.START_EVENT_V3: {
+ /* This is sent only by MySQL <=4.x */
+ StartLogEventV3 event = new StartLogEventV3(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.STOP_EVENT: {
+ StopLogEvent event = new StopLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.INTVAR_EVENT: {
+ IntvarLogEvent event = new IntvarLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.RAND_EVENT: {
+ RandLogEvent event = new RandLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.USER_VAR_EVENT: {
+ UserVarLogEvent event = new UserVarLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.FORMAT_DESCRIPTION_EVENT: {
+ descriptionEvent = new FormatDescriptionLogEvent(header, buffer, descriptionEvent);
+ context.setFormatDescription(descriptionEvent);
+ return descriptionEvent;
+ }
+ case LogEvent.PRE_GA_WRITE_ROWS_EVENT: {
+ if (logger.isWarnEnabled()) logger.warn("Skipping unsupported PRE_GA_WRITE_ROWS_EVENT from: "
+ + context.getLogPosition());
+ // ev = new Write_rows_log_event_old(buf, event_len,
+ // description_event);
+ break;
+ }
+ case LogEvent.PRE_GA_UPDATE_ROWS_EVENT: {
+ if (logger.isWarnEnabled()) logger.warn("Skipping unsupported PRE_GA_UPDATE_ROWS_EVENT from: "
+ + context.getLogPosition());
+ // ev = new Update_rows_log_event_old(buf, event_len,
+ // description_event);
+ break;
+ }
+ case LogEvent.PRE_GA_DELETE_ROWS_EVENT: {
+ if (logger.isWarnEnabled()) logger.warn("Skipping unsupported PRE_GA_DELETE_ROWS_EVENT from: "
+ + context.getLogPosition());
+ // ev = new Delete_rows_log_event_old(buf, event_len,
+ // description_event);
+ break;
+ }
+ case LogEvent.BEGIN_LOAD_QUERY_EVENT: {
+ BeginLoadQueryLogEvent event = new BeginLoadQueryLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.EXECUTE_LOAD_QUERY_EVENT: {
+ ExecuteLoadQueryLogEvent event = new ExecuteLoadQueryLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.INCIDENT_EVENT: {
+ IncidentLogEvent event = new IncidentLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.HEARTBEAT_LOG_EVENT: {
+ HeartbeatLogEvent event = new HeartbeatLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.IGNORABLE_LOG_EVENT: {
+ IgnorableLogEvent event = new IgnorableLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.ROWS_QUERY_LOG_EVENT: {
+ RowsQueryLogEvent event = new RowsQueryLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.WRITE_ROWS_EVENT: {
+ RowsLogEvent event = new WriteRowsLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ event.fillTable(context);
+ return event;
+ }
+ case LogEvent.UPDATE_ROWS_EVENT: {
+ RowsLogEvent event = new UpdateRowsLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ event.fillTable(context);
+ return event;
+ }
+ case LogEvent.DELETE_ROWS_EVENT: {
+ RowsLogEvent event = new DeleteRowsLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ event.fillTable(context);
+ return event;
+ }
+ case LogEvent.GTID_LOG_EVENT:
+ case LogEvent.ANONYMOUS_GTID_LOG_EVENT: {
GtidLogEvent event = new GtidLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
return event;
}
- case LogEvent.PREVIOUS_GTIDS_LOG_EVENT:
- {
+ case LogEvent.PREVIOUS_GTIDS_LOG_EVENT: {
PreviousGtidsLogEvent event = new PreviousGtidsLogEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
return event;
}
- case LogEvent.ANNOTATE_ROWS_EVENT:
- {
- AnnotateRowsEvent event = new AnnotateRowsEvent(header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.BINLOG_CHECKPOINT_EVENT:
- {
- BinlogCheckPointLogEvent event = new BinlogCheckPointLogEvent(header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.GTID_EVENT:
- {
- MariaGtidLogEvent event = new MariaGtidLogEvent(header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- case LogEvent.GTID_LIST_EVENT:
- {
- MariaGtidListLogEvent event = new MariaGtidListLogEvent(header, buffer, descriptionEvent);
- /* updating position in context */
- logPosition.position = header.getLogPos();
- return event;
- }
- default:
- /*
- Create an object of Ignorable_log_event for unrecognized sub-class.
- So that SLAVE SQL THREAD will only update the position and continue.
- */
- if((buffer.getUint16(LogEvent.FLAGS_OFFSET) & LogEvent.LOG_EVENT_IGNORABLE_F) > 0){
- IgnorableLogEvent event = new IgnorableLogEvent(header, buffer, descriptionEvent);
+ case LogEvent.ANNOTATE_ROWS_EVENT: {
+ AnnotateRowsEvent event = new AnnotateRowsEvent(header, buffer, descriptionEvent);
/* updating position in context */
logPosition.position = header.getLogPos();
return event;
- }else {
- if (logger.isWarnEnabled())
- logger.warn("Skipping unrecognized binlog event "
- + LogEvent.getTypeName(header.getType()) + " from: "
- + context.getLogPosition());
}
+ case LogEvent.BINLOG_CHECKPOINT_EVENT: {
+ BinlogCheckPointLogEvent event = new BinlogCheckPointLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.GTID_EVENT: {
+ MariaGtidLogEvent event = new MariaGtidLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ case LogEvent.GTID_LIST_EVENT: {
+ MariaGtidListLogEvent event = new MariaGtidListLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ }
+ default:
+ /*
+ * Create an object of Ignorable_log_event for unrecognized
+ * sub-class. So that SLAVE SQL THREAD will only update the
+ * position and continue.
+ */
+ if ((buffer.getUint16(LogEvent.FLAGS_OFFSET) & LogEvent.LOG_EVENT_IGNORABLE_F) > 0) {
+ IgnorableLogEvent event = new IgnorableLogEvent(header, buffer, descriptionEvent);
+ /* updating position in context */
+ logPosition.position = header.getLogPos();
+ return event;
+ } else {
+ if (logger.isWarnEnabled()) logger.warn("Skipping unrecognized binlog event "
+ + LogEvent.getTypeName(header.getType()) + " from: "
+ + context.getLogPosition());
+ }
}
/* updating position in context */
diff --git a/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/LogEvent.java b/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/LogEvent.java
index 7f9c3a8f..dc460dea 100644
--- a/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/LogEvent.java
+++ b/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/LogEvent.java
@@ -7,239 +7,218 @@ import com.taobao.tddl.dbsync.binlog.event.LogHeader;
/**
* Binary log event definitions. This includes generic code common to all types
- * of log events, as well as specific code for each type of log event.
- *
- * - All numbers, whether they are 16-, 24-, 32-, or 64-bit numbers, are stored
- * in little endian, i.e., the least significant byte first, unless otherwise
- * specified.
- *
- * representation of unsigned integers, called Packed Integer. A Packed Integer
- * has the capacity of storing up to 8-byte integers, while small integers still
- * can use 1, 3, or 4 bytes. The value of the first byte determines how to read
- * the number, according to the following table:
- *
+ * of log events, as well as specific code for each type of log event. - All
+ * numbers, whether they are 16-, 24-, 32-, or 64-bit numbers, are stored in
+ * little endian, i.e., the least significant byte first, unless otherwise
+ * specified. representation of unsigned integers, called Packed Integer. A
+ * Packed Integer has the capacity of storing up to 8-byte integers, while small
+ * integers still can use 1, 3, or 4 bytes. The value of the first byte
+ * determines how to read the number, according to the following table:
* | First byte | *Format | *
|---|---|
| 0-250 | *The first byte is the number (in the range 0-250), and no more bytes are * used. | *
| 252 | *Two more bytes are used. The number is in the range 251-0xffff. | *
| 253 | *Three more bytes are used. The number is in the range 0xffff-0xffffff. | *
| 254 | *Eight more bytes are used. The number is in the range * 0xffffff-0xffffffffffffffff. | *
* Base class for ignorable log events. Events deriving from - this class can be safely ignored by slaves that cannot - recognize them. Newer slaves, will be able to read and - handle them. This has been designed to be an open-ended - architecture, so adding new derived events shall not harm - the old slaves that support ignorable log event mechanism - (they will just ignore unrecognized ignorable events). - - @note The only thing that makes an event ignorable is that it has - the LOG_EVENT_IGNORABLE_F flag set. It is not strictly necessary - that ignorable event types derive from Ignorable_log_event; they may - just as well derive from Log_event and pass LOG_EVENT_IGNORABLE_F as - argument to the Log_event constructor. -+ * this class can be safely ignored by slaves that cannot + * recognize them. Newer slaves, will be able to read and + * handle them. This has been designed to be an open-ended + * architecture, so adding new derived events shall not harm + * the old slaves that support ignorable log event mechanism + * (they will just ignore unrecognized ignorable events). + * + * @note The only thing that makes an event ignorable is that it has + * the LOG_EVENT_IGNORABLE_F flag set. It is not strictly necessary + * that ignorable event types derive from Ignorable_log_event; they may + * just as well derive from Log_event and pass LOG_EVENT_IGNORABLE_F as + * argument to the Log_event constructor. + * * * @author jianghang 2013-4-8 上午12:36:29 * @version 1.0.3 diff --git a/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/IncidentLogEvent.java b/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/IncidentLogEvent.java index ecbd3226..f0c03e56 100644 --- a/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/IncidentLogEvent.java +++ b/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/IncidentLogEvent.java @@ -5,12 +5,9 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; /** * Class representing an incident, an occurance out of the ordinary, that - * happened on the master. - * - * The event is used to inform the slave that something out of the ordinary - * happened on the master that might cause the database to be in an inconsistent - * state. - * + * happened on the master. The event is used to inform the slave that something + * out of the ordinary happened on the master that might cause the database to + * be in an inconsistent state. *
| Name | *Format | *Description | *
|---|---|---|
| type | *1 byte enumeration | *One byte identifying the type of variable stored. Currently, two * identifiers are supported: LAST_INSERT_ID_EVENT==1 and INSERT_ID_EVENT==2. | *
| value | *8 byte unsigned integer | *The value of the variable. | *
* Variable data part: - * *
| Name | *Format | *Description | *
|---|---|---|
| slave_proxy_id | *4 byte unsigned integer | @@ -45,71 +42,57 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * temporary table local to the client. The slave_proxy_id is used to * distinguish temporary tables that belong to different clients. *|
| exec_time | *4 byte unsigned integer | *The time from when the query started to when it was logged in the binlog, * in seconds. | *
| skip_lines | *4 byte unsigned integer | *The number on line (14) above, if present, or 0 if line (14) is left out. * | *
| table_name_len | *1 byte unsigned integer | *The length of 'table_name' on line (4) above. | *
| db_len | *1 byte unsigned integer | *The length of 'db' on line (1) above. | *
| num_fields | *4 byte unsigned integer | *The number n of fields on line (15) above. | *
| Name | *Format | *Description | *
|---|---|---|
| sql_ex | *variable length | - * *Describes the part of the query on lines (3) and (5)–(13) above.
* More precisely, it stores the five strings (on lines) field_term (6),
* enclosed (7), escaped (8), line_term (11), and line_start (12); as well as a
* bitfield indicating the presence of the keywords REPLACE (3), IGNORE (3), and
- * OPTIONALLY (7).
- *
- * The data is stored in one of two formats, called "old" and "new". The type
- * field of Common-Header determines which of these two formats is used: type
- * LOAD_EVENT means that the old format is used, and type NEW_LOAD_EVENT means
- * that the new format is used. When MySQL writes a Load_log_event, it uses the
- * new format if at least one of the five strings is two or more bytes long.
- * Otherwise (i.e., if all strings are 0 or 1 bytes long), the old format is
- * used.
- *
- * The new and old format differ in the way the five strings are stored.
- *
+ * OPTIONALLY (7). The data is stored in one of two formats, called "old" and
+ * "new". The type field of Common-Header determines which of these two formats
+ * is used: type LOAD_EVENT means that the old format is used, and type
+ * NEW_LOAD_EVENT means that the new format is used. When MySQL writes a
+ * Load_log_event, it uses the new format if at least one of the five strings is
+ * two or more bytes long. Otherwise (i.e., if all strings are 0 or 1 bytes
+ * long), the old format is used. The new and old format differ in the way the
+ * five strings are stored.
*
|
*
| field_lens | *num_fields 1 byte unsigned integers | *An array of num_fields integers representing the length of each field in * the query. (num_fields is from the Post-Header). | *
| fields | *num_fields null-terminated strings | @@ -148,7 +127,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * the num_fields array.) The total length of all strings equals to the sum of * all field_lens, plus num_fields bytes for all the trailing zeros. *|
| table_name | *null-terminated string of length table_len+1 bytes | @@ -156,31 +134,27 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * trailing zero is actually redundant since the table_len is known from * Post-Header.) *|
| db | *null-terminated string of length db_len+1 bytes | *The 'db' from the query, as a null-terminated string. (The trailing zero * is actually redundant since the db_len is known from Post-Header.) | *
| file_name | *variable length string without trailing zero, extending to the end of the * event (determined by the length field of the Common-Header) | *The 'file_name' from the query. | *
| Name | *Format | *Description | *
|---|---|---|
| timestamp | *4 byte unsigned integer | *The time when the query started, in seconds since 1970. | *
| type | *1 byte enumeration | *See enum #Log_event_type. | *
| server_id | *4 byte unsigned integer | *Server ID of the server that created the event. | *
| total_size | *4 byte unsigned integer | *The total size of this event, in bytes. In other words, this is the sum * of the sizes of Common-Header, Post-Header, and Body. | *
| master_position | *4 byte unsigned integer | @@ -54,24 +47,21 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * the position of the next event, in bytes from the beginning of the file. In a * relay log, this is the position of the next event in the master's binlog. *|
| flags | *2 byte bitfield | *See Log_event::flags. | *
| Name | *Format | *Description | *
|---|---|---|
| slave_proxy_id | *4 byte unsigned integer | @@ -31,20 +26,17 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * temporary table local to the client. The slave_proxy_id is used to * distinguish temporary tables that belong to different clients. *|
| exec_time | *4 byte unsigned integer | *The time from when the query started to when it was logged in the binlog, * in seconds. | *
| db_len | *1 byte integer | *The length of the name of the currently selected database. | *
| error_code | *2 byte unsigned integer | @@ -52,7 +44,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * fail with the same error code, except for the error codes ER_DB_CREATE_EXISTS * == 1007 and ER_DB_DROP_EXISTS == 1008. *|
| status_vars_len | *2 byte unsigned integer | @@ -60,18 +51,14 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * query_log_event_status_vars "below". *
| Name | *Format | *Description | *|
|---|---|---|---|
| query_log_event_status_vars status_vars | *status_vars_len bytes | @@ -81,16 +68,13 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * Table_query_log_event_status_vars "below". MySQL always writes events in the * order defined below; however, it is capable of reading them in any order. *||
| db | *db_len+1 | - *The currently selected database, as a null-terminated string. - * - * (The trailing zero is redundant since the length is already known; it is - * db_len from Post-Header.) | + *The currently selected database, as a null-terminated string. (The + * trailing zero is redundant since the length is already known; it is db_len + * from Post-Header.) | *
| query | *variable length string without trailing zero, extending to the end of the @@ -98,20 +82,16 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * | The SQL query. | *
| Status variable | *1 byte identifier | *Format | *Description | *|
|---|---|---|---|---|
| flags2 | *Q_FLAGS2_CODE == 0 | @@ -121,16 +101,12 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * identifies those options that need to be written to the binlog (not all do). * Specifically, OPTIONS_WRITTEN_TO_BIN_LOG equals (OPTION_AUTO_IS_NULL | * OPTION_NO_FOREIGN_KEY_CHECKS | OPTION_RELAXED_UNIQUE_CHECKS | - * OPTION_NOT_AUTOCOMMIT), or 0x0c084000 in hex. - * - * These flags correspond to the SQL variables SQL_AUTO_IS_NULL, - * FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, and AUTOCOMMIT, documented in the - * "SET Syntax" section of the MySQL Manual. - * - * This field is always written to the binlog in version >= 5.0, and never - * written in version < 5.0. + * OPTION_NOT_AUTOCOMMIT), or 0x0c084000 in hex. These flags correspond to the + * SQL variables SQL_AUTO_IS_NULL, FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, and + * AUTOCOMMIT, documented in the "SET Syntax" section of the MySQL Manual. This + * field is always written to the binlog in version >= 5.0, and never written in + * version < 5.0. *|||
| sql_mode | *Q_SQL_MODE_CODE == 1 | @@ -177,11 +153,9 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * All these flags are replicated from the server. However, all flags except * MODE_NO_DIR_IN_CREATE are honored by the slave; the slave always preserves * its old value of MODE_NO_DIR_IN_CREATE. For a rationale, see comment in - * Query_log_event::do_apply_event in log_event.cc. - * - * This field is always written to the binlog. + * Query_log_event::do_apply_event in log_event.cc. This field is always written + * to the binlog. *|||
| catalog | *Q_CATALOG_NZ_CODE == 6 | @@ -189,23 +163,17 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * characters (at most 255 bytes) *Stores the client's current catalog. Every database belongs to a catalog, * the same way that every table belongs to a database. Currently, there is only - * one catalog, "std". - * - * This field is written if the length of the catalog is > 0; otherwise it is - * not written. | + * one catalog, "std". This field is written if the length of the catalog is > + * 0; otherwise it is not written. *||
| auto_increment | *Q_AUTO_INCREMENT == 3 | *two 2 byte unsigned integers, totally 2+2=4 bytes | - * *The two variables auto_increment_increment and auto_increment_offset, in * that order. For more information, see "System variables" in the MySQL manual. - * * This field is written if auto_increment > 1. Otherwise, it is not written. | *|
| charset | *Q_CHARSET_CODE == 4 | @@ -216,33 +184,22 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * collation_connection identifies the character set and collation that the * master converts the query to when it receives it; this is useful when * comparing literal strings. collation_server is the default character set and - * collation used when a new database is created. - * - * See also "Connection Character Sets and Collations" in the MySQL 5.1 manual. - * - * All three variables are codes identifying a (character set, collation) pair. - * To see which codes map to which pairs, run the query "SELECT id, - * character_set_name, collation_name FROM COLLATIONS". - * - * Cf. Q_CHARSET_DATABASE_CODE below. - * - * This field is always written. + * collation used when a new database is created. See also + * "Connection Character Sets and Collations" in the MySQL 5.1 manual. All three + * variables are codes identifying a (character set, collation) pair. To see + * which codes map to which pairs, run the query "SELECT id, character_set_name, + * collation_name FROM COLLATIONS". Cf. Q_CHARSET_DATABASE_CODE below. This + * field is always written. *|||
| time_zone | *Q_TIME_ZONE_CODE == 5 | *Variable-length string: the length in bytes (1 byte) followed by the * characters (at most 255 bytes). - * | The time_zone of the master. - * - * See also "System Variables" and "MySQL Server Time Zone Support" in the MySQL - * manual. - * - * This field is written if the length of the time zone string is > 0; - * otherwise, it is not written. | + *The time_zone of the master. See also "System Variables" and + * "MySQL Server Time Zone Support" in the MySQL manual. This field is written + * if the length of the time zone string is > 0; otherwise, it is not written. | *
| lc_time_names_number | *Q_LC_TIME_NAMES_CODE == 7 | @@ -251,84 +208,68 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * to languages is defined in sql_locale.cc. This field is written if it is not * 0, i.e., if the locale is not en_US. *|||
| charset_database_number | *Q_CHARSET_DATABASE_CODE == 8 | *2 byte integer | - * *The value of the collation_database system variable (in the source code * stored in thd->variables.collation_database), which holds the code for a * (character set, collation) pair as described above (see Q_CHARSET_CODE). - * * collation_database was used in old versions (???WHEN). Its value was loaded * when issuing a "use db" query and could be changed by issuing a * "SET collation_database=xxx" query. It used to affect the "LOAD DATA INFILE" - * and "CREATE TABLE" commands. - * - * In newer versions, "CREATE TABLE" has been changed to take the character set - * from the database of the created table, rather than the character set of the - * current database. This makes a difference when creating a table in another - * database than the current one. "LOAD DATA INFILE" has not yet changed to do - * this, but there are plans to eventually do it, and to make collation_database - * read-only. - * - * This field is written if it is not 0. | + * and "CREATE TABLE" commands. In newer versions, "CREATE TABLE" has been + * changed to take the character set from the database of the created table, + * rather than the character set of the current database. This makes a + * difference when creating a table in another database than the current one. + * "LOAD DATA INFILE" has not yet changed to do this, but there are plans to + * eventually do it, and to make collation_database read-only. This field is + * written if it is not 0. *|
| table_map_for_update | *Q_TABLE_MAP_FOR_UPDATE_CODE == 9 | *8 byte integer | - * *The value of the table map that is to be updated by the multi-table * update query statement. Every bit of this variable represents a table, and is - * set to 1 if the corresponding table is to be updated by this statement. - * - * The value of this variable is set when executing a multi-table update - * statement and used by slave to apply filter rules without opening all the - * tables on slave. This is required because some tables may not exist on slave - * because of the filter rules. | + * set to 1 if the corresponding table is to be updated by this statement. The + * value of this variable is set when executing a multi-table update statement + * and used by slave to apply filter rules without opening all the tables on + * slave. This is required because some tables may not exist on slave because of + * the filter rules. *
* The sql_mode variable. See the section "SQL Modes" in the MySQL manual, * and see mysql_priv.h for a list of the possible flags. Currently * (2007-10-04), the following flags are available: - * *
| Name | *Format | *Description | *|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| seed1 | *8 byte unsigned integer | *64 bit random seed1. | *|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| seed2 | *8 byte unsigned integer | @@ -41,19 +32,16 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * @author Changyuan.lh * @version 1.0 */ -public final class RandLogEvent extends LogEvent -{ +public final class RandLogEvent extends LogEvent { + /** * Fixed data part: Empty - * *
| Name | *Format | *Description | *
|---|---|---|
| position | *8 byte integer | *The position within the binlog to rotate to. | *
| Name | *Format | *Description | *
|---|---|---|
| new_log | *variable length string without trailing zero, extending to the end of the * event (determined by the length field of the Common-Header) | *Name of the binlog to rotate to. | *
- * * Variable data part: - * *
Rotate_log_event without log information. This
* is used to generate missing log rotation events.
*/
- public RotateLogEvent(String filename)
- {
+ public RotateLogEvent(String filename){
super(ROTATE_HEADER);
this.filename = filename;
@@ -125,21 +107,18 @@ public final class RotateLogEvent extends LogEvent
/**
* Creates a new Rotate_log_event without log information.
*/
- public RotateLogEvent(String filename, final long position)
- {
+ public RotateLogEvent(String filename, final long position){
super(ROTATE_HEADER);
this.filename = filename;
this.position = position;
}
- public final String getFilename()
- {
+ public final String getFilename() {
return filename;
}
- public final long getPosition()
- {
+ public final long getPosition() {
return position;
}
}
diff --git a/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/RowsLogEvent.java b/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/RowsLogEvent.java
index ca898cac..d27074b6 100644
--- a/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/RowsLogEvent.java
+++ b/dbsync/src/main/java/com/taobao/tddl/dbsync/binlog/event/RowsLogEvent.java
@@ -12,41 +12,33 @@ import com.taobao.tddl.dbsync.binlog.LogEvent;
* @author Changyuan.lh
* @version 1.0
*/
-public abstract class RowsLogEvent extends LogEvent
-{
+public abstract class RowsLogEvent extends LogEvent {
+
/**
* Fixed data part:
- *
* * Variable data part: - * *
| Name | *Format | *Description | *
|---|---|---|
| table_id | *6 bytes unsigned integer | *The number that identifies the table. | *
| flags | *2 byte bitfield | *Reserved for future use; currently always 0. | *
| Name | *Format | *Description | *
|---|---|---|
| database_name | *one byte string length, followed by null-terminated string | @@ -55,20 +45,17 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * by a terminating 0 byte. (Note the redundancy in the representation of the * length.) *|
| table_name | *one byte string length, followed by null-terminated string | *The name of the table, encoded the same way as the database name above. | *
| column_count | *packed_integer "Packed Integer" | *The number of columns in the table, represented as a packed * variable-length integer. | *
| column_type | *List of column_count 1 byte enumeration values | @@ -78,13 +65,11 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * listed in the table Table_table_map_log_event_column_types "below" (along * with description of the associated metadata field). *|
| metadata_length | *packed_integer "Packed Integer" | *The length of the following metadata block | *
| metadata | *list of metadata for each column | @@ -93,7 +78,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * metadata for each column are listed in the table * Table_table_map_log_event_column_types "below". *|
| null_bits | *column_count bits, rounded up to nearest byte | @@ -104,13 +88,10 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * first byte, the ninth is in the least significant bit of the second byte, and * so on. *
| Size of metadata in bytes | *Description of metadata | * - * *||
|---|---|---|---|
| MYSQL_TYPE_DECIMAL | *0 | *0 | *No column metadata. | *
| MYSQL_TYPE_TINY | *1 | *0 | *No column metadata. | *
| MYSQL_TYPE_SHORT | *2 | *0 | *No column metadata. | *
| MYSQL_TYPE_LONG | *3 | *0 | *No column metadata. | *
| MYSQL_TYPE_FLOAT | *4 | @@ -156,7 +132,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *1 byte unsigned integer, representing the "pack_length", which is equal * to sizeof(float) on the server from which the event originates. | *|
| MYSQL_TYPE_DOUBLE | *5 | @@ -164,63 +139,54 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *1 byte unsigned integer, representing the "pack_length", which is equal * to sizeof(double) on the server from which the event originates. | *|
| MYSQL_TYPE_NULL | *6 | *0 | *No column metadata. | *
| MYSQL_TYPE_TIMESTAMP | *7 | *0 | *No column metadata. | *
| MYSQL_TYPE_LONGLONG | *8 | *0 | *No column metadata. | *
| MYSQL_TYPE_INT24 | *9 | *0 | *No column metadata. | *
| MYSQL_TYPE_DATE | *10 | *0 | *No column metadata. | *
| MYSQL_TYPE_TIME | *11 | *0 | *No column metadata. | *
| MYSQL_TYPE_DATETIME | *12 | *0 | *No column metadata. | *
| MYSQL_TYPE_YEAR | *13 | *0 | *No column metadata. | *
| MYSQL_TYPE_NEWDATE | *14 | @@ -228,14 +194,12 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *This enumeration value is only used internally and cannot exist in a * binlog. | *|
| MYSQL_TYPE_VARCHAR | *15 | *2 bytes | *2 byte unsigned integer representing the maximum length of the string. | *
| MYSQL_TYPE_BIT | *16 | @@ -245,7 +209,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * occupied by the bitfield. The number of bytes is either int((length+7)/8) or * int(length/8). *||
| MYSQL_TYPE_NEWDECIMAL | *246 | @@ -253,7 +216,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *A 1 byte unsigned int representing the precision, followed by a 1 byte * unsigned int representing the number of decimals. | *|
| MYSQL_TYPE_ENUM | *247 | @@ -261,7 +223,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *This enumeration value is only used internally and cannot exist in a * binlog. | *|
| MYSQL_TYPE_SET | *248 | @@ -269,7 +230,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *This enumeration value is only used internally and cannot exist in a * binlog. | *|
| MYSQL_TYPE_TINY_BLOB | *249 | @@ -277,7 +237,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *This enumeration value is only used internally and cannot exist in a * binlog. | *|
| MYSQL_TYPE_MEDIUM_BLOB | *250 | @@ -285,7 +244,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *This enumeration value is only used internally and cannot exist in a * binlog. | *|
| MYSQL_TYPE_LONG_BLOB | *251 | @@ -293,7 +251,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *This enumeration value is only used internally and cannot exist in a * binlog. | *|
| MYSQL_TYPE_BLOB | *252 | @@ -301,7 +258,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *The pack length, i.e., the number of bytes needed to represent the length * of the blob: 1, 2, 3, or 4. | *|
| MYSQL_TYPE_VAR_STRING | *253 | @@ -312,7 +268,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * unsigned integer representing the field size, i.e., the number of bytes * needed to store the length of the string. *||
| MYSQL_TYPE_STRING | *254 | @@ -321,7 +276,6 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; * byte is the field size, i.e., the number of bytes in the representation of * size of the string: 3 or 4. *||
| MYSQL_TYPE_GEOMETRY | *255 | @@ -329,21 +283,19 @@ import com.taobao.tddl.dbsync.binlog.LogEvent; *The pack length, i.e., the number of bytes needed to represent the length * of the geometry: 1, 2, 3, or 4. | *
* Variable data part: *
* Variable data part: - * *