1
/* Copyright (C) 2000-2006 MySQL AB
3
This program is free software; you can redistribute it and/or modify
4
it under the terms of the GNU General Public License as published by
5
the Free Software Foundation; version 2 of the License.
7
This program is distributed in the hope that it will be useful,
8
but WITHOUT ANY WARRANTY; without even the implied warranty of
9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
GNU General Public License for more details.
12
You should have received a copy of the GNU General Public License
13
along with this program; if not, write to the Free Software
14
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
17
@addtogroup Replication
22
@brief Binary log event definitions. This includes generic code
23
common to all types of log events, as well as specific code for each
31
#if defined(USE_PRAGMA_INTERFACE) && !defined(MYSQL_CLIENT)
32
#pragma interface /* gcc class implementation */
35
#include <my_bitmap.h>
36
#include "rpl_constants.h"
38
#include "rpl_record.h"
39
#include "rpl_reporting.h"
41
#include "my_decimal.h"
45
Either assert or return an error.
47
In debug build, the condition will be checked, but in non-debug
48
builds, the error code given will be returned instead.
50
@param COND Condition to check
51
@param ERRNO Error number to return in non-debug builds
54
#define ASSERT_OR_RETURN_ERROR(COND, ERRNO) \
55
do { if (!(COND)) return ERRNO; } while (0)
57
#define ASSERT_OR_RETURN_ERROR(COND, ERRNO) \
61
#define LOG_READ_EOF -1
62
#define LOG_READ_BOGUS -2
63
#define LOG_READ_IO -3
64
#define LOG_READ_MEM -5
65
#define LOG_READ_TRUNC -6
66
#define LOG_READ_TOO_LARGE -7
68
#define LOG_EVENT_OFFSET 4
71
3 is MySQL 4.x; 4 is MySQL 5.0.0.
72
Compared to version 3, version 4 has:
73
- a different Start_log_event, which includes info about the binary log
74
(sizes of headers); this info is included for better compatibility if the
75
master's MySQL version is different from the slave's.
76
- all events have a unique ID (the triplet (server_id, timestamp at server
77
start, other) to be sure an event is not executed more than once in a
78
multimaster setup, example:
86
if a query is run on M1, it will arrive twice on S, so we need that S
87
remembers the last unique ID it has processed, to compare and know if the
88
event should be skipped or not. Example of ID: we already have the server id
90
timestamp_when_the_master_started (4 bytes), a counter (a sequence number
91
which increments every time we write an event to the binlog) (3 bytes).
92
Q: how do we handle when the counter is overflowed and restarts from 0 ?
94
- Query and Load (Create or Execute) events may have a more precise
95
timestamp (with microseconds), number of matched/affected/warnings rows
96
and fields of session variables: SQL_MODE,
97
FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, SQL_AUTO_IS_NULL, the collations and
98
charsets, the PASSWORD() version (old/new/...).
100
#define BINLOG_VERSION 4
103
We could have used SERVER_VERSION_LENGTH, but this introduces an
104
obscure dependency - if somebody decided to change SERVER_VERSION_LENGTH
105
this would break the replication protocol
107
#define ST_SERVER_VER_LEN 50
110
These are flags and structs to handle all the LOAD DATA INFILE options (LINES
115
These are flags and structs to handle all the LOAD DATA INFILE options (LINES
117
DUMPFILE_FLAG is probably useless (DUMPFILE is a clause of SELECT, not of LOAD
120
#define DUMPFILE_FLAG 0x1
121
#define OPT_ENCLOSED_FLAG 0x2
122
#define REPLACE_FLAG 0x4
123
#define IGNORE_FLAG 0x8
125
#define FIELD_TERM_EMPTY 0x1
126
#define ENCLOSED_EMPTY 0x2
127
#define LINE_TERM_EMPTY 0x4
128
#define LINE_START_EMPTY 0x8
129
#define ESCAPED_EMPTY 0x10
131
/*****************************************************************************
135
****************************************************************************/
147
#define NUM_LOAD_DELIM_STRS 5
149
/*****************************************************************************
153
****************************************************************************/
156
sql_ex_info() {} /* Remove gcc warning */
157
const char* field_term;
158
const char* enclosed;
159
const char* line_term;
160
const char* line_start;
162
int cached_new_format;
163
uint8 field_term_len,enclosed_len,line_term_len,line_start_len, escaped_len;
167
// store in new format even if old is possible
168
void force_new_format() { cached_new_format = 1;}
171
return (new_format() ?
172
field_term_len + enclosed_len + line_term_len +
173
line_start_len + escaped_len + 6 : 7);
175
bool write_data(IO_CACHE* file);
176
const char* init(const char* buf, const char* buf_end, bool use_new_format);
179
return ((cached_new_format != -1) ? cached_new_format :
180
(cached_new_format=(field_term_len > 1 ||
182
line_term_len > 1 || line_start_len > 1 ||
187
/*****************************************************************************
191
This log consists of events. Each event has a fixed-length header,
192
possibly followed by a variable length data body.
194
The data body consists of an optional fixed length segment (post-header)
195
and an optional variable length segment.
197
See the #defines below for the format specifics.
199
The events which really update data are Query_log_event,
200
Execute_load_query_log_event and old Load_log_event and
201
Execute_load_log_event events (Execute_load_query is used together with
202
Begin_load_query and Append_block events to replicate LOAD DATA INFILE.
203
Create_file/Append_block/Execute_load (which includes Load_log_event)
204
were used to replicate LOAD DATA before the 5.0.3).
206
****************************************************************************/
208
#define LOG_EVENT_HEADER_LEN 19 /* the fixed header length */
209
#define OLD_HEADER_LEN 13 /* the fixed header length in 3.23 */
211
Fixed header length, where 4.x and 5.0 agree. That is, 5.0 may have a longer
212
header (it will for sure when we have the unique event's ID), but at least
213
the first 19 bytes are the same in 4.x and 5.0. So when we have the unique
214
event's ID, LOG_EVENT_HEADER_LEN will be something like 26, but
215
LOG_EVENT_MINIMAL_HEADER_LEN will remain 19.
217
#define LOG_EVENT_MINIMAL_HEADER_LEN 19
219
/* event-specific post-header sizes */
220
// where 3.23, 4.x and 5.0 agree
221
#define QUERY_HEADER_MINIMAL_LEN (4 + 4 + 1 + 2)
222
// where 5.0 differs: 2 for len of N-bytes vars.
223
#define QUERY_HEADER_LEN (QUERY_HEADER_MINIMAL_LEN + 2)
224
#define LOAD_HEADER_LEN (4 + 4 + 4 + 1 +1 + 4)
225
#define START_V3_HEADER_LEN (2 + ST_SERVER_VER_LEN + 4)
226
#define ROTATE_HEADER_LEN 8 // this is FROZEN (the Rotate post-header is frozen)
227
#define CREATE_FILE_HEADER_LEN 4
228
#define APPEND_BLOCK_HEADER_LEN 4
229
#define EXEC_LOAD_HEADER_LEN 4
230
#define DELETE_FILE_HEADER_LEN 4
231
#define FORMAT_DESCRIPTION_HEADER_LEN (START_V3_HEADER_LEN+1+LOG_EVENT_TYPES)
232
#define ROWS_HEADER_LEN 8
233
#define TABLE_MAP_HEADER_LEN 8
234
#define EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN (4 + 4 + 4 + 1)
235
#define EXECUTE_LOAD_QUERY_HEADER_LEN (QUERY_HEADER_LEN + EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN)
236
#define INCIDENT_HEADER_LEN 2
237
#define HEARTBEAT_HEADER_LEN 0
239
Max number of possible extra bytes in a replication event compared to a
240
packet (i.e. a query) sent from client to master;
241
First, an auxiliary log_event status vars estimation:
243
#define MAX_SIZE_LOG_EVENT_STATUS (4 /* flags2 */ + \
245
1 + 1 + 255 /* catalog */ + \
248
MAX_TIME_ZONE_NAME_LENGTH)
249
#define MAX_LOG_EVENT_HEADER ( /* in order of Query_log_event::write */ \
250
LOG_EVENT_HEADER_LEN + /* write_header */ \
251
QUERY_HEADER_LEN + /* write_data */ \
252
EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN + /*write_post_header_for_derived */ \
253
MAX_SIZE_LOG_EVENT_STATUS + /* status */ \
257
Event header offsets;
258
these point to places inside the fixed header.
261
#define EVENT_TYPE_OFFSET 4
262
#define SERVER_ID_OFFSET 5
263
#define EVENT_LEN_OFFSET 9
264
#define LOG_POS_OFFSET 13
265
#define FLAGS_OFFSET 17
267
/* start event post-header (for v3 and v4) */
269
#define ST_BINLOG_VER_OFFSET 0
270
#define ST_SERVER_VER_OFFSET 2
271
#define ST_CREATED_OFFSET (ST_SERVER_VER_OFFSET + ST_SERVER_VER_LEN)
272
#define ST_COMMON_HEADER_LEN_OFFSET (ST_CREATED_OFFSET + 4)
274
/* slave event post-header (this event is never written) */
276
#define SL_MASTER_PORT_OFFSET 8
277
#define SL_MASTER_POS_OFFSET 0
278
#define SL_MASTER_HOST_OFFSET 10
280
/* query event post-header */
282
#define Q_THREAD_ID_OFFSET 0
283
#define Q_EXEC_TIME_OFFSET 4
284
#define Q_DB_LEN_OFFSET 8
285
#define Q_ERR_CODE_OFFSET 9
286
#define Q_STATUS_VARS_LEN_OFFSET 11
287
#define Q_DATA_OFFSET QUERY_HEADER_LEN
288
/* these are codes, not offsets; not more than 256 values (1 byte). */
289
#define Q_FLAGS2_CODE 0
290
#define Q_SQL_MODE_CODE 1
292
Q_CATALOG_CODE is catalog with end zero stored; it is used only by MySQL
293
5.0.x where 0<=x<=3. We have to keep it to be able to replicate these
296
#define Q_CATALOG_CODE 2
297
#define Q_AUTO_INCREMENT 3
298
#define Q_CHARSET_CODE 4
299
#define Q_TIME_ZONE_CODE 5
301
Q_CATALOG_NZ_CODE is catalog withOUT end zero stored; it is used by MySQL
302
5.0.x where x>=4. Saves one byte in every Query_log_event in binlog,
303
compared to Q_CATALOG_CODE. The reason we didn't simply re-use
304
Q_CATALOG_CODE is that then a 5.0.3 slave of this 5.0.x (x>=4) master would
305
crash (segfault etc) because it would expect a 0 when there is none.
307
#define Q_CATALOG_NZ_CODE 6
309
#define Q_LC_TIME_NAMES_CODE 7
311
#define Q_CHARSET_DATABASE_CODE 8
312
/* Intvar event post-header */
314
#define I_TYPE_OFFSET 0
315
#define I_VAL_OFFSET 1
317
/* Rand event post-header */
319
#define RAND_SEED1_OFFSET 0
320
#define RAND_SEED2_OFFSET 8
322
/* User_var event post-header */
324
#define UV_VAL_LEN_SIZE 4
325
#define UV_VAL_IS_NULL 1
326
#define UV_VAL_TYPE_SIZE 1
327
#define UV_NAME_LEN_SIZE 4
328
#define UV_CHARSET_NUMBER_SIZE 4
330
/* Load event post-header */
332
#define L_THREAD_ID_OFFSET 0
333
#define L_EXEC_TIME_OFFSET 4
334
#define L_SKIP_LINES_OFFSET 8
335
#define L_TBL_LEN_OFFSET 12
336
#define L_DB_LEN_OFFSET 13
337
#define L_NUM_FIELDS_OFFSET 14
338
#define L_SQL_EX_OFFSET 18
339
#define L_DATA_OFFSET LOAD_HEADER_LEN
341
/* Rotate event post-header */
343
#define R_POS_OFFSET 0
344
#define R_IDENT_OFFSET 8
346
/* CF to DF handle LOAD DATA INFILE */
348
/* CF = "Create File" */
349
#define CF_FILE_ID_OFFSET 0
350
#define CF_DATA_OFFSET CREATE_FILE_HEADER_LEN
352
/* AB = "Append Block" */
353
#define AB_FILE_ID_OFFSET 0
354
#define AB_DATA_OFFSET APPEND_BLOCK_HEADER_LEN
356
/* EL = "Execute Load" */
357
#define EL_FILE_ID_OFFSET 0
359
/* DF = "Delete File" */
360
#define DF_FILE_ID_OFFSET 0
362
/* TM = "Table Map" */
363
#define TM_MAPID_OFFSET 0
364
#define TM_FLAGS_OFFSET 6
367
#define RW_MAPID_OFFSET 0
368
#define RW_FLAGS_OFFSET 6
370
/* ELQ = "Execute Load Query" */
371
#define ELQ_FILE_ID_OFFSET QUERY_HEADER_LEN
372
#define ELQ_FN_POS_START_OFFSET ELQ_FILE_ID_OFFSET + 4
373
#define ELQ_FN_POS_END_OFFSET ELQ_FILE_ID_OFFSET + 8
374
#define ELQ_DUP_HANDLING_OFFSET ELQ_FILE_ID_OFFSET + 12
376
/* 4 bytes which all binlogs should begin with */
377
#define BINLOG_MAGIC "\xfe\x62\x69\x6e"
380
This flag only makes sense for Format_description_log_event. It is set
381
when the event is written, and *reset* when a binlog file is
382
closed (yes, it's the only case when MySQL modifies already written
383
part of binlog). Thus it is a reliable indicator that binlog was
384
closed correctly. (Stop_log_event is not enough, there's always a
385
small chance that mysqld crashes in the middle of insert and end of
386
the binlog would look like a Stop_log_event).
388
This flag is used to detect a restart after a crash, and to provide
389
"unbreakable" binlog. The problem is that on a crash storage engines
390
rollback automatically, while binlog does not. To solve this we use this
391
flag and automatically append ROLLBACK to every non-closed binlog (append
392
virtually, on reading, file itself is not changed). If this flag is found,
393
mysqlbinlog simply prints "ROLLBACK" Replication master does not abort on
394
binlog corruption, but takes it as EOF, and replication slave forces a
395
rollback in this case.
397
Note, that old binlogs does not have this flag set, so we get a
398
a backward-compatible behaviour.
401
#define LOG_EVENT_BINLOG_IN_USE_F 0x1
404
@def LOG_EVENT_THREAD_SPECIFIC_F
406
If the query depends on the thread (for example: TEMPORARY TABLE).
407
Currently this is used by mysqlbinlog to know it must print
408
SET @@PSEUDO_THREAD_ID=xx; before the query (it would not hurt to print it
409
for every query but this would be slow).
411
#define LOG_EVENT_THREAD_SPECIFIC_F 0x4
414
@def LOG_EVENT_SUPPRESS_USE_F
416
Suppress the generation of 'USE' statements before the actual
417
statement. This flag should be set for any events that does not need
418
the current database set to function correctly. Most notable cases
419
are 'CREATE DATABASE' and 'DROP DATABASE'.
421
This flags should only be used in exceptional circumstances, since
422
it introduce a significant change in behaviour regarding the
423
replication logic together with the flags --binlog-do-db and
426
#define LOG_EVENT_SUPPRESS_USE_F 0x8
429
The table map version internal to the log should be increased after
430
the event has been written to the binary log.
432
#define LOG_EVENT_UPDATE_TABLE_MAP_VERSION_F 0x10
435
@def OPTIONS_WRITTEN_TO_BIN_LOG
437
OPTIONS_WRITTEN_TO_BIN_LOG are the bits of thd->options which must
438
be written to the binlog. OPTIONS_WRITTEN_TO_BIN_LOG could be
439
written into the Format_description_log_event, so that if later we
440
don't want to replicate a variable we did replicate, or the
441
contrary, it's doable. But it should not be too hard to decide once
442
for all of what we replicate and what we don't, among the fixed 32
443
bits of thd->options.
445
I (Guilhem) have read through every option's usage, and it looks
446
like OPTION_AUTO_IS_NULL and OPTION_NO_FOREIGN_KEYS are the only
447
ones which alter how the query modifies the table. It's good to
448
replicate OPTION_RELAXED_UNIQUE_CHECKS too because otherwise, the
449
slave may insert data slower than the master, in InnoDB.
450
OPTION_BIG_SELECTS is not needed (the slave thread runs with
451
max_join_size=HA_POS_ERROR) and OPTION_BIG_TABLES is not needed
452
either, as the manual says (because a too big in-memory temp table
453
is automatically written to disk).
455
#define OPTIONS_WRITTEN_TO_BIN_LOG \
456
(OPTION_AUTO_IS_NULL | OPTION_NO_FOREIGN_KEY_CHECKS | \
457
OPTION_RELAXED_UNIQUE_CHECKS | OPTION_NOT_AUTOCOMMIT)
459
/* Shouldn't be defined before */
460
#define EXPECTED_OPTIONS \
461
((1ULL << 14) | (1ULL << 26) | (1ULL << 27) | (1ULL << 19))
463
#if OPTIONS_WRITTEN_TO_BIN_LOG != EXPECTED_OPTIONS
464
#error OPTIONS_WRITTEN_TO_BIN_LOG must NOT change their values!
466
#undef EXPECTED_OPTIONS /* You shouldn't use this one */
471
Enumeration type for the different types of log events.
476
Every time you update this enum (when you add a type), you have to
477
fix Format_description_log_event::Format_description_log_event().
487
CREATE_FILE_EVENT= 8,
488
APPEND_BLOCK_EVENT= 9,
490
DELETE_FILE_EVENT= 11,
492
NEW_LOAD_EVENT is like LOAD_EVENT except that it has a longer
493
sql_ex, allowing multibyte TERMINATED BY etc; both types share the
494
same class (Load_log_event)
499
FORMAT_DESCRIPTION_EVENT= 15,
501
BEGIN_LOAD_QUERY_EVENT= 17,
502
EXECUTE_LOAD_QUERY_EVENT= 18,
504
TABLE_MAP_EVENT = 19,
507
These event numbers were used for 5.1.0 to 5.1.15 and are
510
PRE_GA_WRITE_ROWS_EVENT = 20,
511
PRE_GA_UPDATE_ROWS_EVENT = 21,
512
PRE_GA_DELETE_ROWS_EVENT = 22,
515
These event numbers are used from 5.1.16 and forward
517
WRITE_ROWS_EVENT = 23,
518
UPDATE_ROWS_EVENT = 24,
519
DELETE_ROWS_EVENT = 25,
522
Something out of the ordinary happened on the master
527
Heartbeat event to be send by master at its idle time
528
to ensure master's online status to slave
530
HEARTBEAT_LOG_EVENT= 27,
533
Add new events here - right above this comment!
534
Existing events (except ENUM_END_EVENT) should never change their numbers
537
ENUM_END_EVENT /* end marker */
541
The number of types we handle in Format_description_log_event (UNKNOWN_EVENT
542
is not to be handled, it does not exist in binlogs, it does not have a
545
#define LOG_EVENT_TYPES (ENUM_END_EVENT-1)
549
INVALID_INT_EVENT = 0, LAST_INSERT_ID_EVENT = 1, INSERT_ID_EVENT = 2
559
class Format_description_log_event;
560
class Relay_log_info;
563
enum enum_base64_output_mode {
564
BASE64_OUTPUT_NEVER= 0,
565
BASE64_OUTPUT_AUTO= 1,
566
BASE64_OUTPUT_ALWAYS= 2,
567
BASE64_OUTPUT_UNSPEC= 3,
568
/* insert new output modes here */
569
BASE64_OUTPUT_MODE_COUNT
573
A structure for mysqlbinlog to know how to print events
575
This structure is passed to the event's print() methods,
577
There are two types of settings stored here:
578
1. Last db, flags2, sql_mode etc comes from the last printed event.
579
They are stored so that only the necessary USE and SET commands
581
2. Other information on how to print the events, e.g. short_form,
582
hexdump_from. These are not dependent on the last event.
584
typedef struct st_print_event_info
587
Settings for database, sql_mode etc that comes from the last event
588
that was printed. We cache these so that we don't have to print
589
them if they are unchanged.
591
// TODO: have the last catalog here ??
592
char db[FN_REFLEN+1]; // TODO: make this a LEX_STRING when thd->db is
595
bool sql_mode_inited;
596
ulong sql_mode; /* must be same as THD.variables.sql_mode */
597
ulong auto_increment_increment, auto_increment_offset;
599
char charset[6]; // 3 variables, each of them storable in 2 bytes
600
char time_zone_str[MAX_TIME_ZONE_NAME_LENGTH];
601
uint lc_time_names_number;
602
uint charset_database_number;
604
bool thread_id_printed;
606
st_print_event_info();
608
~st_print_event_info() {
609
close_cached_file(&head_cache);
610
close_cached_file(&body_cache);
612
bool init_ok() /* tells if construction was successful */
613
{ return my_b_inited(&head_cache) && my_b_inited(&body_cache); }
616
/* Settings on how to print the events */
618
enum_base64_output_mode base64_output_mode;
620
This is set whenever a Format_description_event is printed.
621
Later, when an event is printed in base64, this flag is tested: if
622
no Format_description_event has been seen, it is unsafe to print
623
the base64 event, so an error message is generated.
625
bool printed_fd_event;
626
my_off_t hexdump_from;
627
uint8 common_header_len;
631
These two caches are used by the row-based replication events to
632
collect the header information and the main body of the events
633
making up a statement.
641
the struct aggregates two paramenters that identify an event
642
uniquely in scope of communication of a particular master and slave couple.
643
I.e there can not be 2 events from the same staying connected master which
644
have the same coordinates.
646
Such identifier is not yet unique generally as the event originating master
647
is resetable. Also the crashed master can be replaced with some other.
649
struct event_coordinates
651
char * file_name; // binlog file name (directories stripped)
652
my_off_t pos; // event's position in the binlog file
658
This is the abstract base class for binary log events.
660
@section Log_event_binary_format Binary Format
662
Any @c Log_event saved on disk consists of the following three
669
The Common-Header, documented in the table @ref Table_common_header
670
"below", always has the same form and length within one version of
671
MySQL. Each event type specifies a format and length of the
672
Post-Header. The length of the Common-Header is the same for all
673
events of the same type. The Body may be of different format and
674
length even for different events of the same type. The binary
675
formats of Post-Header and Body are documented separately in each
676
subclass. The binary format of Common-Header is as follows.
679
<caption>Common-Header</caption>
689
<td>4 byte unsigned integer</td>
690
<td>The time when the query started, in seconds since 1970.
696
<td>1 byte enumeration</td>
697
<td>See enum #Log_event_type.</td>
702
<td>4 byte unsigned integer</td>
703
<td>Server ID of the server that created the event.</td>
708
<td>4 byte unsigned integer</td>
709
<td>The total size of this event, in bytes. In other words, this
710
is the sum of the sizes of Common-Header, Post-Header, and Body.
715
<td>master_position</td>
716
<td>4 byte unsigned integer</td>
717
<td>The position of the next event in the master binary log, in
718
bytes from the beginning of the file. In a binlog that is not a
719
relay log, this is just the position of the next event, in bytes
720
from the beginning of the file. In a relay log, this is
721
the position of the next event in the master's binlog.
727
<td>2 byte bitfield</td>
728
<td>See Log_event::flags.</td>
732
Summing up the numbers above, we see that the total size of the
733
common header is 19 bytes.
735
@subsection Log_event_format_of_atomic_primitives Format of Atomic Primitives
737
- All numbers, whether they are 16-, 24-, 32-, or 64-bit numbers,
738
are stored in little endian, i.e., the least significant byte first,
739
unless otherwise specified.
741
@anchor packed_integer
742
- Some events use a special format for efficient representation of
743
unsigned integers, called Packed Integer. A Packed Integer has the
744
capacity of storing up to 8-byte integers, while small integers
745
still can use 1, 3, or 4 bytes. The value of the first byte
746
determines how to read the number, according to the following table:
749
<caption>Format of Packed Integer</caption>
758
<td>The first byte is the number (in the range 0-250), and no more
764
<td>Two more bytes are used. The number is in the range
770
<td>Three more bytes are used. The number is in the range
771
0xffff-0xffffff.</td>
776
<td>Eight more bytes are used. The number is in the range
777
0xffffff-0xffffffffffffffff.</td>
782
- Strings are stored in various formats. The format of each string
783
is documented separately.
789
Enumeration of what kinds of skipping (and non-skipping) that can
790
occur when the slave executes an event.
795
enum enum_skip_reason {
802
Skip event by ignoring it.
804
This means that the slave skip counter will not be changed.
809
Skip event and decrease skip counter.
816
The following type definition is to be used whenever data is placed
817
and manipulated in a common buffer. Use this typedef for buffers
818
that contain data containing binary and character data.
820
typedef unsigned char Byte;
823
The offset in the log where this event originally appeared (it is
824
preserved in relay logs, making SHOW SLAVE STATUS able to print
825
coordinates of the event in the master's binlog). Note: when a
826
transaction is written by the master to its binlog (wrapped in
827
BEGIN/COMMIT) the log_pos of all the queries it contains is the
828
one of the BEGIN (this way, when one does SHOW SLAVE STATUS it
829
sees the offset of the BEGIN, which is logical as rollback may
830
occur), except the COMMIT query which has its real offset.
834
A temp buffer for read_log_event; it is later analysed according to the
835
event's type, and its content is distributed in the event-specific fields.
839
Timestamp on the master(for debugging and replication of
840
NOW()/TIMESTAMP). It is important for queries and LOAD DATA
841
INFILE. This is set at the event's creation time, except for Query
842
and Load (et al.) events where this is set at the query's
843
execution time, which guarantees good replication (otherwise, we
844
could have a query and its event with different timestamps).
847
/* The number of seconds the query took to run on the master. */
849
/* Number of bytes written by write() function */
853
The master's server id (is preserved in the relay log; used to
854
prevent from infinite loops in circular replication).
859
Some 16 flags. See the definitions above for LOG_EVENT_TIME_F,
860
LOG_EVENT_FORCED_ROTATE_F, LOG_EVENT_THREAD_SPECIFIC_F, and
861
LOG_EVENT_SUPPRESS_USE_F for notes.
868
A storage to cache the global system variable's value.
869
Handling of a separate event will be governed its member.
871
ulong slave_exec_mode;
877
Log_event(THD* thd_arg, uint16 flags_arg, bool cache_stmt);
879
read_log_event() functions read an event from a binlog or relay
880
log; used by SHOW BINLOG EVENTS, the binlog_dump thread on the
881
master (reads master's binlog), the slave IO thread (reads the
882
event sent by binlog_dump), the slave SQL thread (reads the event
883
from the relay log). If mutex is 0, the read will proceed without
884
mutex. We need the description_event to be able to parse the
885
event (to know the post-header's size); in fact in read_log_event
886
we detect the event's type, then call the specific event's
887
constructor and pass description_event as an argument.
889
static Log_event* read_log_event(IO_CACHE* file,
890
pthread_mutex_t* log_lock,
891
const Format_description_log_event
893
static int read_log_event(IO_CACHE* file, String* packet,
894
pthread_mutex_t* log_lock);
896
init_show_field_list() prepares the column names and types for the
897
output of SHOW BINLOG EVENTS; it is used only by SHOW BINLOG
900
static void init_show_field_list(List<Item>* field_list);
901
#ifdef HAVE_REPLICATION
902
int net_send(Protocol *protocol, const char* log_name, my_off_t pos);
905
pack_info() is used by SHOW BINLOG EVENTS; as print() it prepares and sends
906
a string to display to the user, so it resembles print().
909
virtual void pack_info(Protocol *protocol);
911
#endif /* HAVE_REPLICATION */
912
virtual const char* get_db()
914
return thd ? thd->db : 0;
917
Log_event() : temp_buf(0) {}
918
/* avoid having to link mysqlbinlog against libpthread */
919
static Log_event* read_log_event(IO_CACHE* file,
920
const Format_description_log_event
922
/* print*() functions are used by mysqlbinlog */
923
virtual void print(FILE* file, PRINT_EVENT_INFO* print_event_info) = 0;
924
void print_timestamp(IO_CACHE* file, time_t *ts = 0);
925
void print_header(IO_CACHE* file, PRINT_EVENT_INFO* print_event_info,
927
void print_base64(IO_CACHE* file, PRINT_EVENT_INFO* print_event_info,
931
static void *operator new(size_t size)
933
return (void*) my_malloc((uint)size, MYF(MY_WME|MY_FAE));
936
static void operator delete(void *ptr,
937
size_t size __attribute__((__unused__)))
939
my_free((uchar*) ptr, MYF(MY_WME|MY_ALLOW_ZERO_PTR));
942
/* Placement version of the above operators */
943
static void *operator new(size_t, void* ptr) { return ptr; }
944
static void operator delete(void*, void*) { }
947
bool write_header(IO_CACHE* file, ulong data_length);
948
virtual bool write(IO_CACHE* file)
950
return (write_header(file, get_data_size()) ||
951
write_data_header(file) ||
952
write_data_body(file));
954
virtual bool write_data_header(IO_CACHE* file __attribute__((__unused__)))
956
virtual bool write_data_body(IO_CACHE* file __attribute__((unused)))
958
inline time_t get_time()
964
return thd->start_time;
965
if ((tmp_thd= current_thd))
966
return tmp_thd->start_time;
970
virtual Log_event_type get_type_code() = 0;
971
virtual bool is_valid() const = 0;
972
virtual bool is_artificial_event() { return 0; }
973
inline bool get_cache_stmt() const { return cache_stmt; }
974
Log_event(const char* buf, const Format_description_log_event
976
virtual ~Log_event() { free_temp_buf();}
977
void register_temp_buf(char* buf) { temp_buf = buf; }
982
my_free(temp_buf, MYF(0));
987
Get event length for simple events. For complicated events the length
988
is calculated during write()
990
virtual int get_data_size() { return 0;}
991
static Log_event* read_log_event(const char* buf, uint event_len,
993
const Format_description_log_event
996
Returns the human readable name of the given event type.
998
static const char* get_type_str(Log_event_type type);
1000
Returns the human readable name of this event's type.
1002
const char* get_type_str();
1004
/* Return start of query time or current time */
1006
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1010
Apply the event to the database.
1012
This function represents the public interface for applying an
1017
int apply_event(Relay_log_info const *rli)
1019
return do_apply_event(rli);
1024
Update the relay log position.
1026
This function represents the public interface for "stepping over"
1027
the event and will update the relay log information.
1031
int update_pos(Relay_log_info *rli)
1033
return do_update_pos(rli);
1037
Decide if the event shall be skipped, and the reason for skipping
1042
enum_skip_reason shall_skip(Relay_log_info *rli)
1044
return do_shall_skip(rli);
1050
Helper function to ignore an event w.r.t. the slave skip counter.
1052
This function can be used inside do_shall_skip() for functions
1053
that cannot end a group. If the slave skip counter is 1 when
1054
seeing such an event, the event shall be ignored, the counter
1055
left intact, and processing continue with the next event.
1059
enum_skip_reason do_shall_skip(Relay_log_info *rli) {
1060
return continue_group(rli);
1066
enum_skip_reason continue_group(Relay_log_info *rli);
1069
Primitive to apply an event to the database.
1071
This is where the change to the database is made.
1073
@note The primitive is protected instead of private, since there
1074
is a hierarchy of actions to be performed in some cases.
1076
@see Format_description_log_event::do_apply_event()
1078
@param rli Pointer to relay log info structure
1080
@retval 0 Event applied successfully
1081
@retval errno Error code if event application failed
1083
virtual int do_apply_event(Relay_log_info const *rli __attribute__((__unused__)))
1085
return 0; /* Default implementation does nothing */
1090
Advance relay log coordinates.
1092
This function is called to advance the relay log coordinates to
1093
just after the event. It is essential that both the relay log
1094
coordinate and the group log position is updated correctly, since
1095
this function is used also for skipping events.
1097
Normally, each implementation of do_update_pos() shall:
1099
- Update the event position to refer to the position just after
1102
- Update the group log position to refer to the position just
1103
after the event <em>if the event is last in a group</em>
1105
@param rli Pointer to relay log info structure
1107
@retval 0 Coordinates changed successfully
1108
@retval errno Error code if advancing failed (usually just
1109
1). Observe that handler errors are returned by the
1110
do_apply_event() function, and not by this one.
1112
virtual int do_update_pos(Relay_log_info *rli);
1116
Decide if this event shall be skipped or not and the reason for
1119
The default implementation decide that the event shall be skipped
1122
- the server id of the event is the same as the server id of the
1123
server and <code>rli->replicate_same_server_id</code> is true,
1126
- if <code>rli->slave_skip_counter</code> is greater than zero.
1131
@retval Log_event::EVENT_SKIP_NOT
1132
The event shall not be skipped and should be applied.
1134
@retval Log_event::EVENT_SKIP_IGNORE
1135
The event shall be skipped by just ignoring it, i.e., the slave
1136
skip counter shall not be changed. This happends if, for example,
1137
the originating server id of the event is the same as the server
1140
@retval Log_event::EVENT_SKIP_COUNT
1141
The event shall be skipped because the slave skip counter was
1142
non-zero. The caller shall decrease the counter by one.
1144
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
1150
One class for each type of event.
1151
Two constructors for each class:
1152
- one to create the event for logging (when the server acts as a master),
1153
called after an update to the database is done,
1154
which accepts parameters like the query, the database, the options for LOAD
1156
- one to create the event from a packet (when the server acts as a slave),
1157
called before reproducing the update, which accepts parameters (like a
1158
buffer). Used to read from the master, from the relay log, and in
1159
mysqlbinlog. This constructor must be format-tolerant.
1163
@class Query_log_event
1165
A @c Query_log_event is created for each query that modifies the
1166
database, unless the query is logged row-based.
1168
@section Query_log_event_binary_format Binary format
1170
See @ref Log_event_binary_format "Binary format for log events" for
1171
a general discussion and introduction to the binary format of binlog
1174
The Post-Header has five components:
1177
<caption>Post-Header for Query_log_event</caption>
1182
<th>Description</th>
1186
<td>slave_proxy_id</td>
1187
<td>4 byte unsigned integer</td>
1188
<td>An integer identifying the client thread that issued the
1189
query. The id is unique per server. (Note, however, that two
1190
threads on different servers may have the same slave_proxy_id.)
1191
This is used when a client thread creates a temporary table local
1192
to the client. The slave_proxy_id is used to distinguish
1193
temporary tables that belong to different clients.
1199
<td>4 byte unsigned integer</td>
1200
<td>The time from when the query started to when it was logged in
1201
the binlog, in seconds.</td>
1206
<td>1 byte integer</td>
1207
<td>The length of the name of the currently selected database.</td>
1212
<td>2 byte unsigned integer</td>
1213
<td>Error code generated by the master. If the master fails, the
1214
slave will fail with the same error code, except for the error
1215
codes ER_DB_CREATE_EXISTS == 1007 and ER_DB_DROP_EXISTS == 1008.
1220
<td>status_vars_len</td>
1221
<td>2 byte unsigned integer</td>
1222
<td>The length of the status_vars block of the Body, in bytes. See
1223
@ref query_log_event_status_vars "below".
1228
The Body has the following components:
1231
<caption>Body for Query_log_event</caption>
1236
<th>Description</th>
1240
<td>@anchor query_log_event_status_vars status_vars</td>
1241
<td>status_vars_len bytes</td>
1242
<td>Zero or more status variables. Each status variable consists
1243
of one byte identifying the variable stored, followed by the value
1244
of the variable. The possible variables are listed separately in
1245
the table @ref Table_query_log_event_status_vars "below". MySQL
1246
always writes events in the order defined below; however, it is
1247
capable of reading them in any order. </td>
1253
<td>The currently selected database, as a null-terminated string.
1255
(The trailing zero is redundant since the length is already known;
1256
it is db_len from Post-Header.)
1262
<td>variable length string without trailing zero, extending to the
1263
end of the event (determined by the length field of the
1266
<td>The SQL query.</td>
1270
The following table lists the status variables that may appear in
1271
the status_vars field.
1273
@anchor Table_query_log_event_status_vars
1275
<caption>Status variables for Query_log_event</caption>
1278
<th>Status variable</th>
1279
<th>1 byte identifier</th>
1281
<th>Description</th>
1286
<td>Q_FLAGS2_CODE == 0</td>
1287
<td>4 byte bitfield</td>
1288
<td>The flags in @c thd->options, binary AND-ed with @c
1289
OPTIONS_WRITTEN_TO_BIN_LOG. The @c thd->options bitfield contains
1290
options for "SELECT". @c OPTIONS_WRITTEN identifies those options
1291
that need to be written to the binlog (not all do). Specifically,
1292
@c OPTIONS_WRITTEN_TO_BIN_LOG equals (@c OPTION_AUTO_IS_NULL | @c
1293
OPTION_NO_FOREIGN_KEY_CHECKS | @c OPTION_RELAXED_UNIQUE_CHECKS |
1294
@c OPTION_NOT_AUTOCOMMIT), or 0x0c084000 in hex.
1296
These flags correspond to the SQL variables SQL_AUTO_IS_NULL,
1297
FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, and AUTOCOMMIT, documented in
1298
the "SET Syntax" section of the MySQL Manual.
1300
This field is always written to the binlog in version >= 5.0, and
1301
never written in version < 5.0.
1307
<td>Q_SQL_MODE_CODE == 1</td>
1308
<td>8 byte bitfield</td>
1309
<td>The @c sql_mode variable. See the section "SQL Modes" in the
1310
MySQL manual, and see mysql_priv.h for a list of the possible
1311
flags. Currently (2007-10-04), the following flags are available:
1313
MODE_REAL_AS_FLOAT==0x1
1314
MODE_PIPES_AS_CONCAT==0x2
1315
MODE_ANSI_QUOTES==0x4
1316
MODE_IGNORE_SPACE==0x8
1318
MODE_ONLY_FULL_GROUP_BY==0x20
1319
MODE_NO_UNSIGNED_SUBTRACTION==0x40
1320
MODE_NO_DIR_IN_CREATE==0x80
1321
MODE_POSTGRESQL==0x100
1326
MODE_NO_KEY_OPTIONS==0x2000
1327
MODE_NO_TABLE_OPTIONS==0x4000
1328
MODE_NO_FIELD_OPTIONS==0x8000
1329
MODE_MYSQL323==0x10000
1330
MODE_MYSQL323==0x20000
1331
MODE_MYSQL40==0x40000
1333
MODE_NO_AUTO_VALUE_ON_ZERO==0x100000
1334
MODE_NO_BACKSLASH_ESCAPES==0x200000
1335
MODE_STRICT_TRANS_TABLES==0x400000
1336
MODE_STRICT_ALL_TABLES==0x800000
1337
MODE_NO_ZERO_IN_DATE==0x1000000
1338
MODE_NO_ZERO_DATE==0x2000000
1339
MODE_INVALID_DATES==0x4000000
1340
MODE_ERROR_FOR_DIVISION_BY_ZERO==0x8000000
1341
MODE_TRADITIONAL==0x10000000
1342
MODE_NO_AUTO_CREATE_USER==0x20000000
1343
MODE_HIGH_NOT_PRECEDENCE==0x40000000
1344
MODE_PAD_CHAR_TO_FULL_LENGTH==0x80000000
1346
All these flags are replicated from the server. However, all
1347
flags except @c MODE_NO_DIR_IN_CREATE are honored by the slave;
1348
the slave always preserves its old value of @c
1349
MODE_NO_DIR_IN_CREATE. For a rationale, see comment in
1350
@c Query_log_event::do_apply_event in @c log_event.cc.
1352
This field is always written to the binlog.
1358
<td>Q_CATALOG_NZ_CODE == 6</td>
1359
<td>Variable-length string: the length in bytes (1 byte) followed
1360
by the characters (at most 255 bytes)
1362
<td>Stores the client's current catalog. Every database belongs
1363
to a catalog, the same way that every table belongs to a
1364
database. Currently, there is only one catalog, "std".
1366
This field is written if the length of the catalog is > 0;
1367
otherwise it is not written.
1372
<td>auto_increment</td>
1373
<td>Q_AUTO_INCREMENT == 3</td>
1374
<td>two 2 byte unsigned integers, totally 2+2=4 bytes</td>
1376
<td>The two variables auto_increment_increment and
1377
auto_increment_offset, in that order. For more information, see
1378
"System variables" in the MySQL manual.
1380
This field is written if auto_increment > 1. Otherwise, it is not
1387
<td>Q_CHARSET_CODE == 4</td>
1388
<td>three 2 byte unsigned integers, totally 2+2+2=6 bytes</td>
1389
<td>The three variables character_set_client,
1390
collation_connection, and collation_server, in that order.
1391
character_set_client is a code identifying the character set and
1392
collation used by the client to encode the query.
1393
collation_connection identifies the character set and collation
1394
that the master converts the query to when it receives it; this is
1395
useful when comparing literal strings. collation_server is the
1396
default character set and collation used when a new database is
1399
See also "Connection Character Sets and Collations" in the MySQL
1402
All three variables are codes identifying a (character set,
1403
collation) pair. To see which codes map to which pairs, run the
1404
query "SELECT id, character_set_name, collation_name FROM
1407
Cf. Q_CHARSET_DATABASE_CODE below.
1409
This field is always written.
1415
<td>Q_TIME_ZONE_CODE == 5</td>
1416
<td>Variable-length string: the length in bytes (1 byte) followed
1417
by the characters (at most 255 bytes).
1418
<td>The time_zone of the master.
1420
See also "System Variables" and "MySQL Server Time Zone Support"
1421
in the MySQL manual.
1423
This field is written if the length of the time zone string is >
1424
0; otherwise, it is not written.
1429
<td>lc_time_names_number</td>
1430
<td>Q_LC_TIME_NAMES_CODE == 7</td>
1431
<td>2 byte integer</td>
1432
<td>A code identifying a table of month and day names. The
1433
mapping from codes to languages is defined in @c sql_locale.cc.
1435
This field is written if it is not 0, i.e., if the locale is not
1441
<td>charset_database_number</td>
1442
<td>Q_CHARSET_DATABASE_CODE == 8</td>
1443
<td>2 byte integer</td>
1445
<td>The value of the collation_database system variable (in the
1446
source code stored in @c thd->variables.collation_database), which
1447
holds the code for a (character set, collation) pair as described
1448
above (see Q_CHARSET_CODE).
1450
collation_database was used in old versions (???WHEN). Its value
1451
was loaded when issuing a "use db" query and could be changed by
1452
issuing a "SET collation_database=xxx" query. It used to affect
1453
the "LOAD DATA INFILE" and "CREATE TABLE" commands.
1455
In newer versions, "CREATE TABLE" has been changed to take the
1456
character set from the database of the created table, rather than
1457
the character set of the current database. This makes a
1458
difference when creating a table in another database than the
1459
current one. "LOAD DATA INFILE" has not yet changed to do this,
1460
but there are plans to eventually do it, and to make
1461
collation_database read-only.
1463
This field is written if it is not 0.
1468
@subsection Query_log_event_notes_on_previous_versions Notes on Previous Versions
1470
* Status vars were introduced in version 5.0. To read earlier
1471
versions correctly, check the length of the Post-Header.
1473
* The status variable Q_CATALOG_CODE == 2 existed in MySQL 5.0.x,
1474
where 0<=x<=3. It was identical to Q_CATALOG_CODE, except that the
1475
string had a trailing '\0'. The '\0' was removed in 5.0.4 since it
1476
was redundant (the string length is stored before the string). The
1477
Q_CATALOG_CODE will never be written by a new master, but can still
1478
be understood by a new slave.
1480
* See Q_CHARSET_DATABASE_CODE in the table above.
1483
class Query_log_event: public Log_event
1486
Log_event::Byte* data_buf;
1489
const char* catalog;
1492
If we already know the length of the query string
1493
we pass it with q_len, so we would not have to call strlen()
1494
otherwise, set it to 0, in which case, we compute it with strlen()
1501
For events created by Query_log_event::do_apply_event (and
1502
Load_log_event::do_apply_event()) we need the *original* thread
1503
id, to be able to log the event with the original (=master's)
1504
thread id (fix for BUG#1686).
1506
ulong slave_proxy_id;
1509
Binlog format 3 and 4 start to differ (as far as class members are
1510
concerned) from here.
1513
uint catalog_len; // <= 255 char; 0 means uninited
1516
We want to be able to store a variable number of N-bit status vars:
1517
(generally N=32; but N=64 for SQL_MODE) a user may want to log the number
1518
of affected rows (for debugging) while another does not want to lose 4
1520
The storage on disk is the following:
1521
status_vars_len is part of the post-header,
1522
status_vars are in the variable-length part, after the post-header, before
1524
status_vars on disk is a sequence of pairs (code, value) where 'code' means
1525
'sql_mode', 'affected' etc. Sometimes 'value' must be a short string, so
1526
its first byte is its length. For now the order of status vars is:
1527
flags2 - sql_mode - catalog - autoinc - charset
1528
We should add the same thing to Load_log_event, but in fact
1529
LOAD DATA INFILE is going to be logged with a new type of event (logging of
1530
the plain text query), so Load_log_event would be frozen, so no need. The
1531
new way of logging LOAD DATA INFILE would use a derived class of
1532
Query_log_event, so automatically benefit from the work already done for
1533
status variables in Query_log_event.
1535
uint16 status_vars_len;
1538
'flags2' is a second set of flags (on top of those in Log_event), for
1539
session variables. These are thd->options which is & against a mask
1540
(OPTIONS_WRITTEN_TO_BIN_LOG).
1541
flags2_inited helps make a difference between flags2==0 (3.23 or 4.x
1542
master, we don't know flags2, so use the slave server's global options) and
1543
flags2==0 (5.0 master, we know this has a meaning of flags all down which
1544
must influence the query).
1547
bool sql_mode_inited;
1548
bool charset_inited;
1551
/* In connections sql_mode is 32 bits now but will be 64 bits soon */
1553
ulong auto_increment_increment, auto_increment_offset;
1555
uint time_zone_len; /* 0 means uninited */
1556
const char *time_zone_str;
1557
uint lc_time_names_number; /* 0 means en_US */
1558
uint charset_database_number;
1560
#ifndef MYSQL_CLIENT
1562
Query_log_event(THD* thd_arg, const char* query_arg, ulong query_length,
1563
bool using_trans, bool suppress_use,
1564
THD::killed_state killed_err_arg= THD::KILLED_NO_VALUE);
1565
const char* get_db() { return db; }
1566
#ifdef HAVE_REPLICATION
1567
void pack_info(Protocol* protocol);
1568
#endif /* HAVE_REPLICATION */
1570
void print_query_header(IO_CACHE* file, PRINT_EVENT_INFO* print_event_info);
1571
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
1575
Query_log_event(const char* buf, uint event_len,
1576
const Format_description_log_event *description_event,
1577
Log_event_type event_type);
1581
my_free((uchar*) data_buf, MYF(0));
1583
Log_event_type get_type_code() { return QUERY_EVENT; }
1584
#ifndef MYSQL_CLIENT
1585
bool write(IO_CACHE* file);
1586
virtual bool write_post_header_for_derived(IO_CACHE* file __attribute__((__unused__)))
1589
bool is_valid() const { return query != 0; }
1592
Returns number of bytes additionaly written to post header by derived
1593
events (so far it is only Execute_load_query event).
1595
virtual ulong get_post_header_size_for_derived() { return 0; }
1596
/* Writes derived event-specific part of post header. */
1598
public: /* !!! Public in this patch to allow old usage */
1599
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1600
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
1601
virtual int do_apply_event(Relay_log_info const *rli);
1602
virtual int do_update_pos(Relay_log_info *rli);
1604
int do_apply_event(Relay_log_info const *rli,
1605
const char *query_arg,
1607
#endif /* HAVE_REPLICATION */
1611
#ifdef HAVE_REPLICATION
1614
@class Slave_log_event
1616
Note that this class is currently not used at all; no code writes a
1617
@c Slave_log_event (though some code in @c repl_failsafe.cc reads @c
1618
Slave_log_event). So it's not a problem if this code is not
1621
@section Slave_log_event_binary_format Binary Format
1623
This event type has no Post-Header. The Body has the following
1627
<caption>Body for Slave_log_event</caption>
1632
<th>Description</th>
1637
<td>8 byte integer</td>
1643
<td>master_port</td>
1644
<td>2 byte integer</td>
1649
<td>master_host</td>
1650
<td>null-terminated string</td>
1656
<td>null-terminated string</td>
1661
class Slave_log_event: public Log_event
1665
void init_from_mem_pool(int data_size);
1667
my_off_t master_pos;
1670
int master_host_len;
1674
#ifndef MYSQL_CLIENT
1675
Slave_log_event(THD* thd_arg, Relay_log_info* rli);
1676
void pack_info(Protocol* protocol);
1678
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
1681
Slave_log_event(const char* buf, uint event_len);
1683
int get_data_size();
1684
bool is_valid() const { return master_host != 0; }
1685
Log_event_type get_type_code() { return SLAVE_EVENT; }
1686
#ifndef MYSQL_CLIENT
1687
bool write(IO_CACHE* file);
1691
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1692
virtual int do_apply_event(Relay_log_info const* rli);
1696
#endif /* HAVE_REPLICATION */
1700
@class Load_log_event
1702
This log event corresponds to a "LOAD DATA INFILE" SQL query on the
1707
(2) LOAD DATA [LOCAL] INFILE 'file_name'
1708
(3) [REPLACE | IGNORE]
1709
(4) INTO TABLE 'table_name'
1711
(6) [TERMINATED BY 'field_term']
1712
(7) [[OPTIONALLY] ENCLOSED BY 'enclosed']
1713
(8) [ESCAPED BY 'escaped']
1716
(11) [TERMINATED BY 'line_term']
1717
(12) [LINES STARTING BY 'line_start']
1719
(14) [IGNORE skip_lines LINES]
1720
(15) (field_1, field_2, ..., field_n)@endverbatim
1722
@section Load_log_event_binary_format Binary Format
1724
The Post-Header consists of the following six components.
1727
<caption>Post-Header for Load_log_event</caption>
1732
<th>Description</th>
1736
<td>slave_proxy_id</td>
1737
<td>4 byte unsigned integer</td>
1738
<td>An integer identifying the client thread that issued the
1739
query. The id is unique per server. (Note, however, that two
1740
threads on different servers may have the same slave_proxy_id.)
1741
This is used when a client thread creates a temporary table local
1742
to the client. The slave_proxy_id is used to distinguish
1743
temporary tables that belong to different clients.
1749
<td>4 byte unsigned integer</td>
1750
<td>The time from when the query started to when it was logged in
1751
the binlog, in seconds.</td>
1756
<td>4 byte unsigned integer</td>
1757
<td>The number on line (14) above, if present, or 0 if line (14)
1763
<td>table_name_len</td>
1764
<td>1 byte unsigned integer</td>
1765
<td>The length of 'table_name' on line (4) above.</td>
1770
<td>1 byte unsigned integer</td>
1771
<td>The length of 'db' on line (1) above.</td>
1776
<td>4 byte unsigned integer</td>
1777
<td>The number n of fields on line (15) above.</td>
1781
The Body contains the following components.
1784
<caption>Body of Load_log_event</caption>
1789
<th>Description</th>
1794
<td>variable length</td>
1796
<td>Describes the part of the query on lines (3) and
1797
(5)–(13) above. More precisely, it stores the five strings
1798
(on lines) field_term (6), enclosed (7), escaped (8), line_term
1799
(11), and line_start (12); as well as a bitfield indicating the
1800
presence of the keywords REPLACE (3), IGNORE (3), and OPTIONALLY
1803
The data is stored in one of two formats, called "old" and "new".
1804
The type field of Common-Header determines which of these two
1805
formats is used: type LOAD_EVENT means that the old format is
1806
used, and type NEW_LOAD_EVENT means that the new format is used.
1807
When MySQL writes a Load_log_event, it uses the new format if at
1808
least one of the five strings is two or more bytes long.
1809
Otherwise (i.e., if all strings are 0 or 1 bytes long), the old
1812
The new and old format differ in the way the five strings are
1816
<li> In the new format, the strings are stored in the order
1817
field_term, enclosed, escaped, line_term, line_start. Each string
1818
consists of a length (1 byte), followed by a sequence of
1819
characters (0-255 bytes). Finally, a boolean combination of the
1820
following flags is stored in 1 byte: REPLACE_FLAG==0x4,
1821
IGNORE_FLAG==0x8, and OPT_ENCLOSED_FLAG==0x2. If a flag is set,
1822
it indicates the presence of the corresponding keyword in the SQL
1825
<li> In the old format, we know that each string has length 0 or
1826
1. Therefore, only the first byte of each string is stored. The
1827
order of the strings is the same as in the new format. These five
1828
bytes are followed by the same 1 byte bitfield as in the new
1829
format. Finally, a 1 byte bitfield called empty_flags is stored.
1830
The low 5 bits of empty_flags indicate which of the five strings
1831
have length 0. For each of the following flags that is set, the
1832
corresponding string has length 0; for the flags that are not set,
1833
the string has length 1: FIELD_TERM_EMPTY==0x1,
1834
ENCLOSED_EMPTY==0x2, LINE_TERM_EMPTY==0x4, LINE_START_EMPTY==0x8,
1835
ESCAPED_EMPTY==0x10.
1838
Thus, the size of the new format is 6 bytes + the sum of the sizes
1839
of the five strings. The size of the old format is always 7
1846
<td>num_fields 1 byte unsigned integers</td>
1847
<td>An array of num_fields integers representing the length of
1848
each field in the query. (num_fields is from the Post-Header).
1854
<td>num_fields null-terminated strings</td>
1855
<td>An array of num_fields null-terminated strings, each
1856
representing a field in the query. (The trailing zero is
1857
redundant, since the length are stored in the num_fields array.)
1858
The total length of all strings equals to the sum of all
1859
field_lens, plus num_fields bytes for all the trailing zeros.
1865
<td>null-terminated string of length table_len+1 bytes</td>
1866
<td>The 'table_name' from the query, as a null-terminated string.
1867
(The trailing zero is actually redundant since the table_len is
1868
known from Post-Header.)
1874
<td>null-terminated string of length db_len+1 bytes</td>
1875
<td>The 'db' from the query, as a null-terminated string.
1876
(The trailing zero is actually redundant since the db_len is known
1883
<td>variable length string without trailing zero, extending to the
1884
end of the event (determined by the length field of the
1887
<td>The 'file_name' from the query.
1893
@subsection Load_log_event_notes_on_previous_versions Notes on Previous Versions
1895
This event type is understood by current versions, but only
1896
generated by MySQL 3.23 and earlier.
1898
class Load_log_event: public Log_event
1901
uint get_query_buffer_length();
1902
void print_query(bool need_db, char *buf, char **end,
1903
char **fn_start, char **fn_end);
1905
int copy_log_event(const char *buf, ulong event_len,
1907
const Format_description_log_event* description_event);
1911
ulong slave_proxy_id;
1912
uint32 table_name_len;
1914
No need to have a catalog, as these events can only come from 4.x.
1915
TODO: this may become false if Dmitri pushes his new LOAD DATA INFILE in
1916
5.0 only (not in 4.x).
1922
const uchar* field_lens;
1923
uint32 field_block_len;
1925
const char* table_name;
1932
/* fname doesn't point to memory inside Log_event::temp_buf */
1933
void set_fname_outside_temp_buf(const char *afname, uint alen)
1939
/* fname doesn't point to memory inside Log_event::temp_buf */
1940
int check_fname_outside_temp_buf()
1945
#ifndef MYSQL_CLIENT
1946
String field_lens_buf;
1949
Load_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
1950
const char* table_name_arg,
1951
List<Item>& fields_arg, enum enum_duplicates handle_dup, bool ignore,
1953
void set_fields(const char* db, List<Item> &fields_arg,
1954
Name_resolution_context *context);
1955
const char* get_db() { return db; }
1956
#ifdef HAVE_REPLICATION
1957
void pack_info(Protocol* protocol);
1958
#endif /* HAVE_REPLICATION */
1960
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
1961
void print(FILE* file, PRINT_EVENT_INFO* print_event_info, bool commented);
1965
Note that for all the events related to LOAD DATA (Load_log_event,
1966
Create_file/Append/Exec/Delete, we pass description_event; however as
1967
logging of LOAD DATA is going to be changed in 4.1 or 5.0, this is only used
1968
for the common_header_len (post_header_len will not be changed).
1970
Load_log_event(const char* buf, uint event_len,
1971
const Format_description_log_event* description_event);
1974
Log_event_type get_type_code()
1976
return sql_ex.new_format() ? NEW_LOAD_EVENT: LOAD_EVENT;
1978
#ifndef MYSQL_CLIENT
1979
bool write_data_header(IO_CACHE* file);
1980
bool write_data_body(IO_CACHE* file);
1982
bool is_valid() const { return table_name != 0; }
1985
return (table_name_len + db_len + 2 + fname_len
1987
+ sql_ex.data_size() + field_block_len + num_fields);
1990
public: /* !!! Public in this patch to allow old usage */
1991
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
1992
virtual int do_apply_event(Relay_log_info const* rli)
1994
return do_apply_event(thd->slave_net,rli,0);
1997
int do_apply_event(NET *net, Relay_log_info const *rli,
1998
bool use_rli_only_for_errors);
2002
extern char server_version[SERVER_VERSION_LENGTH];
2005
@class Start_log_event_v3
2007
Start_log_event_v3 is the Start_log_event of binlog format 3 (MySQL 3.23 and
2010
Format_description_log_event derives from Start_log_event_v3; it is
2011
the Start_log_event of binlog format 4 (MySQL 5.0), that is, the
2012
event that describes the other events' Common-Header/Post-Header
2013
lengths. This event is sent by MySQL 5.0 whenever it starts sending
2014
a new binlog if the requested position is >4 (otherwise if ==4 the
2015
event will be sent naturally).
2017
@section Start_log_event_v3_binary_format Binary Format
2019
class Start_log_event_v3: public Log_event
2023
If this event is at the start of the first binary log since server
2024
startup 'created' should be the timestamp when the event (and the
2025
binary log) was created. In the other case (i.e. this event is at
2026
the start of a binary log created by FLUSH LOGS or automatic
2027
rotation), 'created' should be 0. This "trick" is used by MySQL
2028
>=4.0.14 slaves to know whether they must drop stale temporary
2029
tables and whether they should abort unfinished transaction.
2031
Note that when 'created'!=0, it is always equal to the event's
2032
timestamp; indeed Start_log_event is written only in log.cc where
2033
the first constructor below is called, in which 'created' is set
2034
to 'when'. So in fact 'created' is a useless variable. When it is
2035
0 we can read the actual value from timestamp ('when') and when it
2036
is non-zero we can read the same value from timestamp
2037
('when'). Conclusion:
2038
- we use timestamp to print when the binlog was created.
2039
- we use 'created' only to know if this is a first binlog or not.
2040
In 3.23.57 we did not pay attention to this identity, so mysqlbinlog in
2041
3.23.57 does not print 'created the_date' if created was zero. This is now
2045
uint16 binlog_version;
2046
char server_version[ST_SERVER_VER_LEN];
2048
artifical_event is 1 in the case where this is a generated event that
2049
should not case any cleanup actions. We handle this in the log by
2050
setting log_event == 0 (for now).
2052
bool artificial_event;
2054
We set this to 1 if we don't want to have the created time in the log,
2055
which is the case when we rollover to a new log.
2057
bool dont_set_created;
2059
#ifndef MYSQL_CLIENT
2060
Start_log_event_v3();
2061
#ifdef HAVE_REPLICATION
2062
void pack_info(Protocol* protocol);
2063
#endif /* HAVE_REPLICATION */
2065
Start_log_event_v3() {}
2066
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2069
Start_log_event_v3(const char* buf,
2070
const Format_description_log_event* description_event);
2071
~Start_log_event_v3() {}
2072
Log_event_type get_type_code() { return START_EVENT_V3;}
2073
#ifndef MYSQL_CLIENT
2074
bool write(IO_CACHE* file);
2076
bool is_valid() const { return 1; }
2079
return START_V3_HEADER_LEN; //no variable-sized part
2081
virtual bool is_artificial_event() { return artificial_event; }
2084
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2085
virtual int do_apply_event(Relay_log_info const *rli);
2086
virtual enum_skip_reason do_shall_skip(Relay_log_info*)
2089
Events from ourself should be skipped, but they should not
2090
decrease the slave skip counter.
2092
if (this->server_id == ::server_id)
2093
return Log_event::EVENT_SKIP_IGNORE;
2095
return Log_event::EVENT_SKIP_NOT;
2102
@class Format_description_log_event
2104
For binlog version 4.
2105
This event is saved by threads which read it, as they need it for future
2106
use (to decode the ordinary events).
2108
@section Format_description_log_event_binary_format Binary Format
2111
class Format_description_log_event: public Start_log_event_v3
2115
The size of the fixed header which _all_ events have
2116
(for binlogs written by this version, this is equal to
2117
LOG_EVENT_HEADER_LEN), except FORMAT_DESCRIPTION_EVENT and ROTATE_EVENT
2118
(those have a header of size LOG_EVENT_MINIMAL_HEADER_LEN).
2120
uint8 common_header_len;
2121
uint8 number_of_event_types;
2122
/* The list of post-headers' lengthes */
2123
uint8 *post_header_len;
2124
uchar server_version_split[3];
2125
const uint8 *event_type_permutation;
2127
Format_description_log_event(uint8 binlog_ver, const char* server_ver=0);
2128
Format_description_log_event(const char* buf, uint event_len,
2129
const Format_description_log_event
2130
*description_event);
2131
~Format_description_log_event()
2133
my_free((uchar*)post_header_len, MYF(MY_ALLOW_ZERO_PTR));
2135
Log_event_type get_type_code() { return FORMAT_DESCRIPTION_EVENT;}
2136
#ifndef MYSQL_CLIENT
2137
bool write(IO_CACHE* file);
2139
bool is_valid() const
2141
return ((common_header_len >= ((binlog_version==1) ? OLD_HEADER_LEN :
2142
LOG_EVENT_MINIMAL_HEADER_LEN)) &&
2143
(post_header_len != NULL));
2148
The vector of post-header lengths is considered as part of the
2149
post-header, because in a given version it never changes (contrary to the
2150
query in a Query_log_event).
2152
return FORMAT_DESCRIPTION_HEADER_LEN;
2155
void calc_server_version_split();
2158
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2159
virtual int do_apply_event(Relay_log_info const *rli);
2160
virtual int do_update_pos(Relay_log_info *rli);
2161
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2167
@class Intvar_log_event
2169
An Intvar_log_event will be created just before a Query_log_event,
2170
if the query uses one of the variables LAST_INSERT_ID or INSERT_ID.
2171
Each Intvar_log_event holds the value of one of these variables.
2173
@section Intvar_log_event_binary_format Binary Format
2175
The Post-Header has two components:
2178
<caption>Post-Header for Intvar_log_event</caption>
2183
<th>Description</th>
2188
<td>1 byte enumeration</td>
2189
<td>One byte identifying the type of variable stored. Currently,
2190
two identifiers are supported: LAST_INSERT_ID_EVENT==1 and
2197
<td>8 byte unsigned integer</td>
2198
<td>The value of the variable.</td>
2203
class Intvar_log_event: public Log_event
2209
#ifndef MYSQL_CLIENT
2210
Intvar_log_event(THD* thd_arg,uchar type_arg, ulonglong val_arg)
2211
:Log_event(thd_arg,0,0),val(val_arg),type(type_arg)
2213
#ifdef HAVE_REPLICATION
2214
void pack_info(Protocol* protocol);
2215
#endif /* HAVE_REPLICATION */
2217
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2220
Intvar_log_event(const char* buf,
2221
const Format_description_log_event *description_event);
2222
~Intvar_log_event() {}
2223
Log_event_type get_type_code() { return INTVAR_EVENT;}
2224
const char* get_var_type_name();
2225
int get_data_size() { return 9; /* sizeof(type) + sizeof(val) */;}
2226
#ifndef MYSQL_CLIENT
2227
bool write(IO_CACHE* file);
2229
bool is_valid() const { return 1; }
2232
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2233
virtual int do_apply_event(Relay_log_info const *rli);
2234
virtual int do_update_pos(Relay_log_info *rli);
2235
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2241
@class Rand_log_event
2243
Logs random seed used by the next RAND(), and by PASSWORD() in 4.1.0.
2244
4.1.1 does not need it (it's repeatable again) so this event needn't be
2245
written in 4.1.1 for PASSWORD() (but the fact that it is written is just a
2246
waste, it does not cause bugs).
2248
The state of the random number generation consists of 128 bits,
2249
which are stored internally as two 64-bit numbers.
2251
@section Rand_log_event_binary_format Binary Format
2252
This event type has no Post-Header. The Body of this event type has
2256
<caption>Post-Header for Intvar_log_event</caption>
2261
<th>Description</th>
2266
<td>8 byte unsigned integer</td>
2267
<td>64 bit random seed1.</td>
2272
<td>8 byte unsigned integer</td>
2273
<td>64 bit random seed2.</td>
2278
class Rand_log_event: public Log_event
2284
#ifndef MYSQL_CLIENT
2285
Rand_log_event(THD* thd_arg, ulonglong seed1_arg, ulonglong seed2_arg)
2286
:Log_event(thd_arg,0,0),seed1(seed1_arg),seed2(seed2_arg)
2288
#ifdef HAVE_REPLICATION
2289
void pack_info(Protocol* protocol);
2290
#endif /* HAVE_REPLICATION */
2292
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2295
Rand_log_event(const char* buf,
2296
const Format_description_log_event *description_event);
2297
~Rand_log_event() {}
2298
Log_event_type get_type_code() { return RAND_EVENT;}
2299
int get_data_size() { return 16; /* sizeof(ulonglong) * 2*/ }
2300
#ifndef MYSQL_CLIENT
2301
bool write(IO_CACHE* file);
2303
bool is_valid() const { return 1; }
2306
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2307
virtual int do_apply_event(Relay_log_info const *rli);
2308
virtual int do_update_pos(Relay_log_info *rli);
2309
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2314
@class Xid_log_event
2316
Logs xid of the transaction-to-be-committed in the 2pc protocol.
2317
Has no meaning in replication, slaves ignore it.
2319
@section Xid_log_event_binary_format Binary Format
2322
typedef ulonglong my_xid; // this line is the same as in handler.h
2325
class Xid_log_event: public Log_event
2330
#ifndef MYSQL_CLIENT
2331
Xid_log_event(THD* thd_arg, my_xid x): Log_event(thd_arg,0,0), xid(x) {}
2332
#ifdef HAVE_REPLICATION
2333
void pack_info(Protocol* protocol);
2334
#endif /* HAVE_REPLICATION */
2336
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2339
Xid_log_event(const char* buf,
2340
const Format_description_log_event *description_event);
2342
Log_event_type get_type_code() { return XID_EVENT;}
2343
int get_data_size() { return sizeof(xid); }
2344
#ifndef MYSQL_CLIENT
2345
bool write(IO_CACHE* file);
2347
bool is_valid() const { return 1; }
2350
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2351
virtual int do_apply_event(Relay_log_info const *rli);
2352
enum_skip_reason do_shall_skip(Relay_log_info *rli);
2357
@class User_var_log_event
2359
Every time a query uses the value of a user variable, a User_var_log_event is
2360
written before the Query_log_event, to set the user variable.
2362
@section User_var_log_event_binary_format Binary Format
2365
class User_var_log_event: public Log_event
2373
uint charset_number;
2375
#ifndef MYSQL_CLIENT
2376
User_var_log_event(THD* thd_arg __attribute__((__unused__)),
2377
char *name_arg, uint name_len_arg,
2378
char *val_arg, ulong val_len_arg, Item_result type_arg,
2379
uint charset_number_arg)
2380
:Log_event(), name(name_arg), name_len(name_len_arg), val(val_arg),
2381
val_len(val_len_arg), type(type_arg), charset_number(charset_number_arg)
2383
void pack_info(Protocol* protocol);
2385
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2388
User_var_log_event(const char* buf,
2389
const Format_description_log_event *description_event);
2390
~User_var_log_event() {}
2391
Log_event_type get_type_code() { return USER_VAR_EVENT;}
2392
#ifndef MYSQL_CLIENT
2393
bool write(IO_CACHE* file);
2395
bool is_valid() const { return 1; }
2398
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2399
virtual int do_apply_event(Relay_log_info const *rli);
2400
virtual int do_update_pos(Relay_log_info *rli);
2401
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2407
@class Stop_log_event
2409
@section Stop_log_event_binary_format Binary Format
2411
The Post-Header and Body for this event type are empty; it only has
2414
class Stop_log_event: public Log_event
2417
#ifndef MYSQL_CLIENT
2418
Stop_log_event() :Log_event()
2421
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2424
Stop_log_event(const char* buf,
2425
const Format_description_log_event *description_event):
2426
Log_event(buf, description_event)
2428
~Stop_log_event() {}
2429
Log_event_type get_type_code() { return STOP_EVENT;}
2430
bool is_valid() const { return 1; }
2433
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2434
virtual int do_update_pos(Relay_log_info *rli);
2435
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli __attribute__((__unused__)))
2438
Events from ourself should be skipped, but they should not
2439
decrease the slave skip counter.
2441
if (this->server_id == ::server_id)
2442
return Log_event::EVENT_SKIP_IGNORE;
2444
return Log_event::EVENT_SKIP_NOT;
2450
@class Rotate_log_event
2452
This will be deprecated when we move to using sequence ids.
2454
@section Rotate_log_event_binary_format Binary Format
2456
The Post-Header has one component:
2459
<caption>Post-Header for Rotate_log_event</caption>
2464
<th>Description</th>
2469
<td>8 byte integer</td>
2470
<td>The position within the binlog to rotate to.</td>
2475
The Body has one component:
2478
<caption>Body for Rotate_log_event</caption>
2483
<th>Description</th>
2488
<td>variable length string without trailing zero, extending to the
2489
end of the event (determined by the length field of the
2492
<td>Name of the binlog to rotate to.</td>
2498
class Rotate_log_event: public Log_event
2502
DUP_NAME= 2 // if constructor should dup the string argument
2504
const char* new_log_ident;
2508
#ifndef MYSQL_CLIENT
2509
Rotate_log_event(const char* new_log_ident_arg,
2511
ulonglong pos_arg, uint flags);
2512
#ifdef HAVE_REPLICATION
2513
void pack_info(Protocol* protocol);
2514
#endif /* HAVE_REPLICATION */
2516
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2519
Rotate_log_event(const char* buf, uint event_len,
2520
const Format_description_log_event* description_event);
2523
if (flags & DUP_NAME)
2524
my_free((uchar*) new_log_ident, MYF(MY_ALLOW_ZERO_PTR));
2526
Log_event_type get_type_code() { return ROTATE_EVENT;}
2527
int get_data_size() { return ident_len + ROTATE_HEADER_LEN;}
2528
bool is_valid() const { return new_log_ident != 0; }
2529
#ifndef MYSQL_CLIENT
2530
bool write(IO_CACHE* file);
2534
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2535
virtual int do_update_pos(Relay_log_info *rli);
2536
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2541
/* the classes below are for the new LOAD DATA INFILE logging */
2544
@class Create_file_log_event
2546
@section Create_file_log_event_binary_format Binary Format
2549
class Create_file_log_event: public Load_log_event
2553
Pretend we are Load event, so we can write out just
2554
our Load part - used on the slave when writing event out to
2555
SQL_LOAD-*.info file
2560
const char *event_buf;
2563
bool inited_from_old;
2565
#ifndef MYSQL_CLIENT
2566
Create_file_log_event(THD* thd, sql_exchange* ex, const char* db_arg,
2567
const char* table_name_arg,
2568
List<Item>& fields_arg,
2569
enum enum_duplicates handle_dup, bool ignore,
2570
uchar* block_arg, uint block_len_arg,
2572
#ifdef HAVE_REPLICATION
2573
void pack_info(Protocol* protocol);
2574
#endif /* HAVE_REPLICATION */
2576
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2577
void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
2581
Create_file_log_event(const char* buf, uint event_len,
2582
const Format_description_log_event* description_event);
2583
~Create_file_log_event()
2585
my_free((char*) event_buf, MYF(MY_ALLOW_ZERO_PTR));
2588
Log_event_type get_type_code()
2590
return fake_base ? Load_log_event::get_type_code() : CREATE_FILE_EVENT;
2594
return (fake_base ? Load_log_event::get_data_size() :
2595
Load_log_event::get_data_size() +
2598
bool is_valid() const { return inited_from_old || block != 0; }
2599
#ifndef MYSQL_CLIENT
2600
bool write_data_header(IO_CACHE* file);
2601
bool write_data_body(IO_CACHE* file);
2603
Cut out Create_file extentions and
2604
write it as Load event - used on the slave
2606
bool write_base(IO_CACHE* file);
2610
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2611
virtual int do_apply_event(Relay_log_info const *rli);
2617
@class Append_block_log_event
2619
@section Append_block_log_event_binary_format Binary Format
2622
class Append_block_log_event: public Log_event
2629
'db' is filled when the event is created in mysql_load() (the
2630
event needs to have a 'db' member to be well filtered by
2631
binlog-*-db rules). 'db' is not written to the binlog (it's not
2632
used by Append_block_log_event::write()), so it can't be read in
2633
the Append_block_log_event(const char* buf, int event_len)
2634
constructor. In other words, 'db' is used only for filtering by
2635
binlog-*-db rules. Create_file_log_event is different: it's 'db'
2636
(which is inherited from Load_log_event) is written to the binlog
2641
#ifndef MYSQL_CLIENT
2642
Append_block_log_event(THD* thd, const char* db_arg, uchar* block_arg,
2643
uint block_len_arg, bool using_trans);
2644
#ifdef HAVE_REPLICATION
2645
void pack_info(Protocol* protocol);
2646
virtual int get_create_or_append() const;
2647
#endif /* HAVE_REPLICATION */
2649
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2652
Append_block_log_event(const char* buf, uint event_len,
2653
const Format_description_log_event
2654
*description_event);
2655
~Append_block_log_event() {}
2656
Log_event_type get_type_code() { return APPEND_BLOCK_EVENT;}
2657
int get_data_size() { return block_len + APPEND_BLOCK_HEADER_LEN ;}
2658
bool is_valid() const { return block != 0; }
2659
#ifndef MYSQL_CLIENT
2660
bool write(IO_CACHE* file);
2661
const char* get_db() { return db; }
2665
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2666
virtual int do_apply_event(Relay_log_info const *rli);
2672
@class Delete_file_log_event
2674
@section Delete_file_log_event_binary_format Binary Format
2677
class Delete_file_log_event: public Log_event
2681
const char* db; /* see comment in Append_block_log_event */
2683
#ifndef MYSQL_CLIENT
2684
Delete_file_log_event(THD* thd, const char* db_arg, bool using_trans);
2685
#ifdef HAVE_REPLICATION
2686
void pack_info(Protocol* protocol);
2687
#endif /* HAVE_REPLICATION */
2689
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2690
void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
2694
Delete_file_log_event(const char* buf, uint event_len,
2695
const Format_description_log_event* description_event);
2696
~Delete_file_log_event() {}
2697
Log_event_type get_type_code() { return DELETE_FILE_EVENT;}
2698
int get_data_size() { return DELETE_FILE_HEADER_LEN ;}
2699
bool is_valid() const { return file_id != 0; }
2700
#ifndef MYSQL_CLIENT
2701
bool write(IO_CACHE* file);
2702
const char* get_db() { return db; }
2706
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2707
virtual int do_apply_event(Relay_log_info const *rli);
2713
@class Execute_load_log_event
2715
@section Delete_file_log_event_binary_format Binary Format
2718
class Execute_load_log_event: public Log_event
2722
const char* db; /* see comment in Append_block_log_event */
2724
#ifndef MYSQL_CLIENT
2725
Execute_load_log_event(THD* thd, const char* db_arg, bool using_trans);
2726
#ifdef HAVE_REPLICATION
2727
void pack_info(Protocol* protocol);
2728
#endif /* HAVE_REPLICATION */
2730
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2733
Execute_load_log_event(const char* buf, uint event_len,
2734
const Format_description_log_event
2735
*description_event);
2736
~Execute_load_log_event() {}
2737
Log_event_type get_type_code() { return EXEC_LOAD_EVENT;}
2738
int get_data_size() { return EXEC_LOAD_HEADER_LEN ;}
2739
bool is_valid() const { return file_id != 0; }
2740
#ifndef MYSQL_CLIENT
2741
bool write(IO_CACHE* file);
2742
const char* get_db() { return db; }
2746
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2747
virtual int do_apply_event(Relay_log_info const *rli);
2753
@class Begin_load_query_log_event
2755
Event for the first block of file to be loaded, its only difference from
2756
Append_block event is that this event creates or truncates existing file
2757
before writing data.
2759
@section Begin_load_query_log_event_binary_format Binary Format
2761
class Begin_load_query_log_event: public Append_block_log_event
2764
#ifndef MYSQL_CLIENT
2765
Begin_load_query_log_event(THD* thd_arg, const char *db_arg,
2766
uchar* block_arg, uint block_len_arg,
2768
#ifdef HAVE_REPLICATION
2769
Begin_load_query_log_event(THD* thd);
2770
int get_create_or_append() const;
2771
#endif /* HAVE_REPLICATION */
2773
Begin_load_query_log_event(const char* buf, uint event_len,
2774
const Format_description_log_event
2775
*description_event);
2776
~Begin_load_query_log_event() {}
2777
Log_event_type get_type_code() { return BEGIN_LOAD_QUERY_EVENT; }
2779
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2780
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2786
Elements of this enum describe how LOAD DATA handles duplicates.
2788
enum enum_load_dup_handling { LOAD_DUP_ERROR= 0, LOAD_DUP_IGNORE,
2792
@class Execute_load_query_log_event
2794
Event responsible for LOAD DATA execution, it similar to Query_log_event
2795
but before executing the query it substitutes original filename in LOAD DATA
2796
query with name of temporary file.
2798
@section Execute_load_query_log_event_binary_format Binary Format
2800
class Execute_load_query_log_event: public Query_log_event
2803
uint file_id; // file_id of temporary file
2804
uint fn_pos_start; // pointer to the part of the query that should
2806
uint fn_pos_end; // pointer to the end of this part of query
2808
We have to store type of duplicate handling explicitly, because
2809
for LOAD DATA it also depends on LOCAL option. And this part
2810
of query will be rewritten during replication so this information
2813
enum_load_dup_handling dup_handling;
2815
#ifndef MYSQL_CLIENT
2816
Execute_load_query_log_event(THD* thd, const char* query_arg,
2817
ulong query_length, uint fn_pos_start_arg,
2818
uint fn_pos_end_arg,
2819
enum_load_dup_handling dup_handling_arg,
2820
bool using_trans, bool suppress_use,
2822
killed_err_arg= THD::KILLED_NO_VALUE);
2823
#ifdef HAVE_REPLICATION
2824
void pack_info(Protocol* protocol);
2825
#endif /* HAVE_REPLICATION */
2827
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2828
/* Prints the query as LOAD DATA LOCAL and with rewritten filename */
2829
void print(FILE* file, PRINT_EVENT_INFO* print_event_info,
2830
const char *local_fname);
2832
Execute_load_query_log_event(const char* buf, uint event_len,
2833
const Format_description_log_event
2834
*description_event);
2835
~Execute_load_query_log_event() {}
2837
Log_event_type get_type_code() { return EXECUTE_LOAD_QUERY_EVENT; }
2838
bool is_valid() const { return Query_log_event::is_valid() && file_id != 0; }
2840
ulong get_post_header_size_for_derived();
2841
#ifndef MYSQL_CLIENT
2842
bool write_post_header_for_derived(IO_CACHE* file);
2846
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
2847
virtual int do_apply_event(Relay_log_info const *rli);
2854
@class Unknown_log_event
2856
@section Unknown_log_event_binary_format Binary Format
2858
class Unknown_log_event: public Log_event
2862
Even if this is an unknown event, we still pass description_event to
2863
Log_event's ctor, this way we can extract maximum information from the
2864
event's header (the unique ID for example).
2866
Unknown_log_event(const char* buf,
2867
const Format_description_log_event *description_event):
2868
Log_event(buf, description_event)
2870
~Unknown_log_event() {}
2871
void print(FILE* file, PRINT_EVENT_INFO* print_event_info);
2872
Log_event_type get_type_code() { return UNKNOWN_EVENT;}
2873
bool is_valid() const { return 1; }
2876
char *str_to_hex(char *to, const char *from, uint len);
2879
@class Table_map_log_event
2881
In row-based mode, every row operation event is preceded by a
2882
Table_map_log_event which maps a table definition to a number. The
2883
table definition consists of database name, table name, and column
2886
@section Table_map_log_event_binary_format Binary Format
2888
The Post-Header has the following components:
2891
<caption>Post-Header for Table_map_log_event</caption>
2896
<th>Description</th>
2901
<td>6 bytes unsigned integer</td>
2902
<td>The number that identifies the table.</td>
2907
<td>2 byte bitfield</td>
2908
<td>Reserved for future use; currently always 0.</td>
2913
The Body has the following components:
2916
<caption>Body for Table_map_log_event</caption>
2921
<th>Description</th>
2925
<td>database_name</td>
2926
<td>one byte string length, followed by null-terminated string</td>
2927
<td>The name of the database in which the table resides. The name
2928
is represented as a one byte unsigned integer representing the
2929
number of bytes in the name, followed by length bytes containing
2930
the database name, followed by a terminating 0 byte. (Note the
2931
redundancy in the representation of the length.) </td>
2936
<td>one byte string length, followed by null-terminated string</td>
2937
<td>The name of the table, encoded the same way as the database
2942
<td>column_count</td>
2943
<td>@ref packed_integer "Packed Integer"</td>
2944
<td>The number of columns in the table, represented as a packed
2945
variable-length integer.</td>
2949
<td>column_type</td>
2950
<td>List of column_count 1 byte enumeration values</td>
2951
<td>The type of each column in the table, listed from left to
2952
right. Each byte is mapped to a column type according to the
2953
enumeration type enum_field_types defined in mysql_com.h. The
2954
mapping of types to numbers is listed in the table @ref
2955
Table_table_map_log_event_column_types "below" (along with
2956
description of the associated metadata field). </td>
2960
<td>metadata_length</td>
2961
<td>@ref packed_integer "Packed Integer"</td>
2962
<td>The length of the following metadata block</td>
2967
<td>list of metadata for each column</td>
2968
<td>For each column from left to right, a chunk of data who's
2969
length and semantics depends on the type of the column. The
2970
length and semantics for the metadata for each column are listed
2971
in the table @ref Table_table_map_log_event_column_types
2977
<td>column_count bits, rounded up to nearest byte</td>
2978
<td>For each column, a bit indicating whether data in the column
2979
can be NULL or not. The number of bytes needed for this is
2980
int((column_count+7)/8). The flag for the first column from the
2981
left is in the least-significant bit of the first byte, the second
2982
is in the second least significant bit of the first byte, the
2983
ninth is in the least significant bit of the second byte, and so
2989
The table below lists all column types, along with the numerical
2990
identifier for it and the size and interpretation of meta-data used
2991
to describe the type.
2993
@anchor Table_table_map_log_event_column_types
2995
<caption>Table_map_log_event column types: numerical identifier and
3000
<th>Size of metadata in bytes</th>
3001
<th>Description of metadata</th>
3005
<td>MYSQL_TYPE_TINY</td><td>1</td>
3007
<td>No column metadata.</td>
3011
<td>MYSQL_TYPE_SHORT</td><td>2</td>
3013
<td>No column metadata.</td>
3017
<td>MYSQL_TYPE_LONG</td><td>3</td>
3019
<td>No column metadata.</td>
3023
<td>MYSQL_TYPE_FLOAT</td><td>4</td>
3025
<td>1 byte unsigned integer, representing the "pack_length", which
3026
is equal to sizeof(float) on the server from which the event
3031
<td>MYSQL_TYPE_DOUBLE</td><td>5</td>
3033
<td>1 byte unsigned integer, representing the "pack_length", which
3034
is equal to sizeof(double) on the server from which the event
3039
<td>MYSQL_TYPE_NULL</td><td>6</td>
3041
<td>No column metadata.</td>
3045
<td>MYSQL_TYPE_TIMESTAMP</td><td>7</td>
3047
<td>No column metadata.</td>
3051
<td>MYSQL_TYPE_LONGLONG</td><td>8</td>
3053
<td>No column metadata.</td>
3057
<td>MYSQL_TYPE_DATE</td><td>10</td>
3059
<td>No column metadata.</td>
3063
<td>MYSQL_TYPE_TIME</td><td>11</td>
3065
<td>No column metadata.</td>
3069
<td>MYSQL_TYPE_DATETIME</td><td>12</td>
3071
<td>No column metadata.</td>
3075
<td>MYSQL_TYPE_YEAR</td><td>13</td>
3077
<td>No column metadata.</td>
3081
<td><i>MYSQL_TYPE_NEWDATE</i></td><td><i>14</i></td>
3083
<td><i>This enumeration value is only used internally and cannot
3084
exist in a binlog.</i></td>
3088
<td>MYSQL_TYPE_VARCHAR</td><td>15</td>
3090
<td>2 byte unsigned integer representing the maximum length of
3095
<td>MYSQL_TYPE_NEWDECIMAL</td><td>246</td>
3097
<td>A 1 byte unsigned int representing the precision, followed
3098
by a 1 byte unsigned int representing the number of decimals.</td>
3102
<td><i>MYSQL_TYPE_ENUM</i></td><td><i>247</i></td>
3104
<td><i>This enumeration value is only used internally and cannot
3105
exist in a binlog.</i></td>
3109
<td><i>MYSQL_TYPE_SET</i></td><td><i>248</i></td>
3111
<td><i>This enumeration value is only used internally and cannot
3112
exist in a binlog.</i></td>
3116
<td>MYSQL_TYPE_TINY_BLOB</td><td>249</td>
3118
<td><i>This enumeration value is only used internally and cannot
3119
exist in a binlog.</i></td>
3123
<td><i>MYSQL_TYPE_MEDIUM_BLOB</i></td><td><i>250</i></td>
3125
<td><i>This enumeration value is only used internally and cannot
3126
exist in a binlog.</i></td>
3130
<td><i>MYSQL_TYPE_LONG_BLOB</i></td><td><i>251</i></td>
3132
<td><i>This enumeration value is only used internally and cannot
3133
exist in a binlog.</i></td>
3137
<td>MYSQL_TYPE_BLOB</td><td>252</td>
3139
<td>The pack length, i.e., the number of bytes needed to represent
3140
the length of the blob: 1, 2, 3, or 4.</td>
3144
<td>MYSQL_TYPE_VAR_STRING</td><td>253</td>
3146
<td>This is used to store both strings and enumeration values.
3147
The first byte is a enumeration value storing the <i>real
3148
type</i>, which may be either MYSQL_TYPE_VAR_STRING or
3149
MYSQL_TYPE_ENUM. The second byte is a 1 byte unsigned integer
3150
representing the field size, i.e., the number of bytes needed to
3151
store the length of the string.</td>
3155
<td>MYSQL_TYPE_STRING</td><td>254</td>
3157
<td>The first byte is always MYSQL_TYPE_VAR_STRING (i.e., 253).
3158
The second byte is the field size, i.e., the number of bytes in
3159
the representation of size of the string: 3 or 4.</td>
3164
class Table_map_log_event : public Log_event
3170
TYPE_CODE = TABLE_MAP_EVENT
3174
Enumeration of the errors that can be returned.
3178
ERR_OPEN_FAILURE = -1, /**< Failure to open table */
3179
ERR_OK = 0, /**< No error */
3180
ERR_TABLE_LIMIT_EXCEEDED = 1, /**< No more room for tables */
3181
ERR_OUT_OF_MEM = 2, /**< Out of memory */
3182
ERR_BAD_TABLE_DEF = 3, /**< Table definition does not match */
3183
ERR_RBR_TO_SBR = 4 /**< daisy-chanining RBR to SBR not allowed */
3189
Nothing here right now, but the flags support is there in
3190
preparation for changes that are coming. Need to add a
3191
constant to make it compile under HP-UX: aCC does not like
3197
typedef uint16 flag_set;
3199
/* Special constants representing sets of flags */
3205
void set_flags(flag_set flag) { m_flags |= flag; }
3206
void clear_flags(flag_set flag) { m_flags &= ~flag; }
3207
flag_set get_flags(flag_set flag) const { return m_flags & flag; }
3209
#ifndef MYSQL_CLIENT
3210
Table_map_log_event(THD *thd, TABLE *tbl, ulong tid,
3211
bool is_transactional, uint16 flags);
3213
#ifdef HAVE_REPLICATION
3214
Table_map_log_event(const char *buf, uint event_len,
3215
const Format_description_log_event *description_event);
3218
~Table_map_log_event();
3220
virtual Log_event_type get_type_code() { return TABLE_MAP_EVENT; }
3221
virtual bool is_valid() const { return m_memory != NULL; /* we check malloc */ }
3223
virtual int get_data_size() { return m_data_size; }
3224
#ifndef MYSQL_CLIENT
3225
virtual int save_field_metadata();
3226
virtual bool write_data_header(IO_CACHE *file);
3227
virtual bool write_data_body(IO_CACHE *file);
3228
virtual const char *get_db() { return m_dbnam; }
3231
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3232
virtual void pack_info(Protocol *protocol);
3236
virtual void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
3241
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3242
virtual int do_apply_event(Relay_log_info const *rli);
3243
virtual int do_update_pos(Relay_log_info *rli);
3244
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
3247
#ifndef MYSQL_CLIENT
3250
char const *m_dbnam;
3252
char const *m_tblnam;
3263
uchar *m_field_metadata; // buffer for field metadata
3265
The size of field metadata buffer set by calling save_field_metadata()
3267
ulong m_field_metadata_size;
3269
uchar *m_meta_memory;
3274
@class Rows_log_event
3276
Common base class for all row-containing log events.
3280
Encode the common parts of all events containing rows, which are:
3281
- Write data header and data body to an IO_CACHE.
3282
- Provide an interface for adding an individual row to the event.
3284
@section Rows_log_event_binary_format Binary Format
3288
class Rows_log_event : public Log_event
3292
Enumeration of the errors that can be returned.
3296
ERR_OPEN_FAILURE = -1, /**< Failure to open table */
3297
ERR_OK = 0, /**< No error */
3298
ERR_TABLE_LIMIT_EXCEEDED = 1, /**< No more room for tables */
3299
ERR_OUT_OF_MEM = 2, /**< Out of memory */
3300
ERR_BAD_TABLE_DEF = 3, /**< Table definition does not match */
3301
ERR_RBR_TO_SBR = 4 /**< daisy-chanining RBR to SBR not allowed */
3305
These definitions allow you to combine the flags into an
3306
appropriate flag set using the normal bitwise operators. The
3307
implicit conversion from an enum-constant to an integer is
3308
accepted by the compiler, which is then used to set the real set
3313
/* Last event of a statement */
3314
STMT_END_F = (1U << 0),
3316
/* Value of the OPTION_NO_FOREIGN_KEY_CHECKS flag in thd->options */
3317
NO_FOREIGN_KEY_CHECKS_F = (1U << 1),
3319
/* Value of the OPTION_RELAXED_UNIQUE_CHECKS flag in thd->options */
3320
RELAXED_UNIQUE_CHECKS_F = (1U << 2),
3323
Indicates that rows in this event are complete, that is contain
3324
values for all columns of the table.
3326
COMPLETE_ROWS_F = (1U << 3)
3329
typedef uint16 flag_set;
3331
/* Special constants representing sets of flags */
3337
virtual ~Rows_log_event();
3339
void set_flags(flag_set flags_arg) { m_flags |= flags_arg; }
3340
void clear_flags(flag_set flags_arg) { m_flags &= ~flags_arg; }
3341
flag_set get_flags(flag_set flags_arg) const { return m_flags & flags_arg; }
3343
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3344
virtual void pack_info(Protocol *protocol);
3348
/* not for direct call, each derived has its own ::print() */
3349
virtual void print(FILE *file, PRINT_EVENT_INFO *print_event_info)= 0;
3352
#ifndef MYSQL_CLIENT
3353
int add_row_data(uchar *data, size_t length)
3355
return do_add_row_data(data,length);
3359
/* Member functions to implement superclass interface */
3360
virtual int get_data_size();
3362
MY_BITMAP const *get_cols() const { return &m_cols; }
3363
size_t get_width() const { return m_width; }
3364
ulong get_table_id() const { return m_table_id; }
3366
#ifndef MYSQL_CLIENT
3367
virtual bool write_data_header(IO_CACHE *file);
3368
virtual bool write_data_body(IO_CACHE *file);
3369
virtual const char *get_db() { return m_table->s->db.str; }
3372
Check that malloc() succeeded in allocating memory for the rows
3373
buffer and the COLS vector. Checking that an Update_rows_log_event
3374
is valid is done in the Update_rows_log_event::is_valid()
3377
virtual bool is_valid() const
3379
return m_rows_buf && m_cols.bitmap;
3382
uint m_row_count; /* The number of rows added to the event */
3386
The constructors are protected since you're supposed to inherit
3387
this class, not create instances of this class.
3389
#ifndef MYSQL_CLIENT
3390
Rows_log_event(THD*, TABLE*, ulong table_id,
3391
MY_BITMAP const *cols, bool is_transactional);
3393
Rows_log_event(const char *row_data, uint event_len,
3394
Log_event_type event_type,
3395
const Format_description_log_event *description_event);
3398
void print_helper(FILE *, PRINT_EVENT_INFO *, char const *const name);
3401
#ifndef MYSQL_CLIENT
3402
virtual int do_add_row_data(uchar *data, size_t length);
3405
#ifndef MYSQL_CLIENT
3406
TABLE *m_table; /* The table the rows belong to */
3408
ulong m_table_id; /* Table ID */
3409
MY_BITMAP m_cols; /* Bitmap denoting columns available */
3410
ulong m_width; /* The width of the columns bitmap */
3412
Bitmap for columns available in the after image, if present. These
3413
fields are only available for Update_rows events. Observe that the
3414
width of both the before image COLS vector and the after image
3415
COLS vector is the same: the number of columns of the table on the
3418
MY_BITMAP m_cols_ai;
3420
ulong m_master_reclength; /* Length of record on master side */
3422
/* Bit buffers in the same memory as the class */
3423
uint32 m_bitbuf[128/(sizeof(uint32)*8)];
3424
uint32 m_bitbuf_ai[128/(sizeof(uint32)*8)];
3426
uchar *m_rows_buf; /* The rows in packed format */
3427
uchar *m_rows_cur; /* One-after the end of the data */
3428
uchar *m_rows_end; /* One-after the end of the allocated space */
3430
flag_set m_flags; /* Flags for row-level events */
3432
/* helper functions */
3434
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3435
const uchar *m_curr_row; /* Start of the row being processed */
3436
const uchar *m_curr_row_end; /* One-after the end of the current row */
3437
uchar *m_key; /* Buffer to keep key value during searches */
3439
int find_row(const Relay_log_info *const);
3440
int write_row(const Relay_log_info *const, const bool);
3442
// Unpack the current row into m_table->record[0]
3443
int unpack_current_row(const Relay_log_info *const rli,
3444
MY_BITMAP const *cols)
3446
DBUG_ASSERT(m_table);
3447
ASSERT_OR_RETURN_ERROR(m_curr_row < m_rows_end, HA_ERR_CORRUPT_EVENT);
3448
int const result= ::unpack_row(rli, m_table, m_width, m_curr_row, cols,
3449
&m_curr_row_end, &m_master_reclength);
3450
if (m_curr_row_end > m_rows_end)
3451
my_error(ER_SLAVE_CORRUPT_EVENT, MYF(0));
3452
ASSERT_OR_RETURN_ERROR(m_curr_row_end <= m_rows_end, HA_ERR_CORRUPT_EVENT);
3459
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3460
virtual int do_apply_event(Relay_log_info const *rli);
3461
virtual int do_update_pos(Relay_log_info *rli);
3462
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
3465
Primitive to prepare for a sequence of row executions.
3469
Before doing a sequence of do_prepare_row() and do_exec_row()
3470
calls, this member function should be called to prepare for the
3471
entire sequence. Typically, this member function will allocate
3472
space for any buffers that are needed for the two member
3473
functions mentioned above.
3477
The member function will return 0 if all went OK, or a non-zero
3478
error code otherwise.
3481
int do_before_row_operations(const Slave_reporting_capability *const log) = 0;
3484
Primitive to clean up after a sequence of row executions.
3488
After doing a sequence of do_prepare_row() and do_exec_row(),
3489
this member function should be called to clean up and release
3490
any allocated buffers.
3492
The error argument, if non-zero, indicates an error which happened during
3493
row processing before this function was called. In this case, even if
3494
function is successful, it should return the error code given in the argument.
3497
int do_after_row_operations(const Slave_reporting_capability *const log,
3501
Primitive to do the actual execution necessary for a row.
3504
The member function will do the actual execution needed to handle a row.
3505
The row is located at m_curr_row. When the function returns,
3506
m_curr_row_end should point at the next row (one byte after the end
3507
of the current row).
3510
0 if execution succeeded, 1 if execution failed.
3513
virtual int do_exec_row(const Relay_log_info *const rli) = 0;
3514
#endif /* !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION) */
3516
friend class Old_rows_log_event;
3520
@class Write_rows_log_event
3522
Log row insertions and updates. The event contain several
3523
insert/update rows for a table. Note that each event contains only
3526
@section Write_rows_log_event_binary_format Binary Format
3528
class Write_rows_log_event : public Rows_log_event
3533
/* Support interface to THD::binlog_prepare_pending_rows_event */
3534
TYPE_CODE = WRITE_ROWS_EVENT
3537
#if !defined(MYSQL_CLIENT)
3538
Write_rows_log_event(THD*, TABLE*, ulong table_id,
3539
bool is_transactional);
3541
#ifdef HAVE_REPLICATION
3542
Write_rows_log_event(const char *buf, uint event_len,
3543
const Format_description_log_event *description_event);
3545
#if !defined(MYSQL_CLIENT)
3546
static bool binlog_row_logging_function(THD *thd, TABLE *table,
3547
bool is_transactional,
3548
const uchar *before_record
3549
__attribute__((unused)),
3550
const uchar *after_record)
3552
return thd->binlog_write_row(table, is_transactional, after_record);
3557
virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }
3560
void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
3563
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3564
virtual int do_before_row_operations(const Slave_reporting_capability *const);
3565
virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
3566
virtual int do_exec_row(const Relay_log_info *const);
3572
@class Update_rows_log_event
3574
Log row updates with a before image. The event contain several
3575
update rows for a table. Note that each event contains only rows for
3578
Also note that the row data consists of pairs of row data: one row
3579
for the old data and one row for the new data.
3581
@section Update_rows_log_event_binary_format Binary Format
3583
class Update_rows_log_event : public Rows_log_event
3588
/* Support interface to THD::binlog_prepare_pending_rows_event */
3589
TYPE_CODE = UPDATE_ROWS_EVENT
3592
#ifndef MYSQL_CLIENT
3593
Update_rows_log_event(THD*, TABLE*, ulong table_id,
3594
bool is_transactional);
3596
void init(MY_BITMAP const *cols);
3599
virtual ~Update_rows_log_event();
3601
#ifdef HAVE_REPLICATION
3602
Update_rows_log_event(const char *buf, uint event_len,
3603
const Format_description_log_event *description_event);
3606
#if !defined(MYSQL_CLIENT)
3607
static bool binlog_row_logging_function(THD *thd, TABLE *table,
3608
bool is_transactional,
3609
const uchar *before_record,
3610
const uchar *after_record)
3612
return thd->binlog_update_row(table, is_transactional,
3613
before_record, after_record);
3617
virtual bool is_valid() const
3619
return Rows_log_event::is_valid() && m_cols_ai.bitmap;
3623
virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }
3626
void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
3629
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3630
virtual int do_before_row_operations(const Slave_reporting_capability *const);
3631
virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
3632
virtual int do_exec_row(const Relay_log_info *const);
3633
#endif /* !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION) */
3637
@class Delete_rows_log_event
3639
Log row deletions. The event contain several delete rows for a
3640
table. Note that each event contains only rows for one table.
3644
- Act as a container for rows that has been deleted on the master
3645
and should be deleted on the slave.
3650
Create the event and add rows to the event.
3652
Extract the rows from the event.
3654
@section Delete_rows_log_event_binary_format Binary Format
3656
class Delete_rows_log_event : public Rows_log_event
3661
/* Support interface to THD::binlog_prepare_pending_rows_event */
3662
TYPE_CODE = DELETE_ROWS_EVENT
3665
#ifndef MYSQL_CLIENT
3666
Delete_rows_log_event(THD*, TABLE*, ulong,
3667
bool is_transactional);
3669
#ifdef HAVE_REPLICATION
3670
Delete_rows_log_event(const char *buf, uint event_len,
3671
const Format_description_log_event *description_event);
3673
#if !defined(MYSQL_CLIENT)
3674
static bool binlog_row_logging_function(THD *thd, TABLE *table,
3675
bool is_transactional,
3676
const uchar *before_record,
3677
const uchar *after_record
3678
__attribute__((unused)))
3680
return thd->binlog_delete_row(table, is_transactional, before_record);
3685
virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }
3688
void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
3691
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3692
virtual int do_before_row_operations(const Slave_reporting_capability *const);
3693
virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
3694
virtual int do_exec_row(const Relay_log_info *const);
3700
@class Incident_log_event
3702
Class representing an incident, an occurance out of the ordinary,
3703
that happened on the master.
3705
The event is used to inform the slave that something out of the
3706
ordinary happened on the master that might cause the database to be
3707
in an inconsistent state.
3709
<table id="IncidentFormat">
3710
<caption>Incident event format</caption>
3714
<th>Description</th>
3718
<td align="right">2</td>
3719
<td>Incident number as an unsigned integer</td>
3723
<td align="right">1</td>
3724
<td>Message length as an unsigned integer</td>
3728
<td align="right">MSGLEN</td>
3729
<td>The message, if present. Not null terminated.</td>
3733
@section Delete_rows_log_event_binary_format Binary Format
3735
class Incident_log_event : public Log_event {
3737
#ifndef MYSQL_CLIENT
3738
Incident_log_event(THD *thd_arg, Incident incident)
3739
: Log_event(thd_arg, 0, FALSE), m_incident(incident)
3741
DBUG_ENTER("Incident_log_event::Incident_log_event");
3742
DBUG_PRINT("enter", ("m_incident: %d", m_incident));
3743
m_message.str= NULL; /* Just as a precaution */
3744
m_message.length= 0;
3748
Incident_log_event(THD *thd_arg, Incident incident, LEX_STRING const msg)
3749
: Log_event(thd_arg, 0, FALSE), m_incident(incident)
3751
DBUG_ENTER("Incident_log_event::Incident_log_event");
3752
DBUG_PRINT("enter", ("m_incident: %d", m_incident));
3758
#ifndef MYSQL_CLIENT
3759
void pack_info(Protocol*);
3762
Incident_log_event(const char *buf, uint event_len,
3763
const Format_description_log_event *descr_event);
3765
virtual ~Incident_log_event();
3768
virtual void print(FILE *file, PRINT_EVENT_INFO *print_event_info);
3771
#if !defined(MYSQL_CLIENT) && defined(HAVE_REPLICATION)
3772
virtual int do_apply_event(Relay_log_info const *rli);
3775
virtual bool write_data_header(IO_CACHE *file);
3776
virtual bool write_data_body(IO_CACHE *file);
3778
virtual Log_event_type get_type_code() { return INCIDENT_EVENT; }
3780
virtual bool is_valid() const { return 1; }
3781
virtual int get_data_size() {
3782
return INCIDENT_HEADER_LEN + 1 + m_message.length;
3786
const char *description() const;
3788
Incident m_incident;
3789
LEX_STRING m_message;
3792
static inline bool copy_event_cache_to_file_and_reinit(IO_CACHE *cache,
3796
my_b_copy_to_file(cache, file) ||
3797
reinit_io_cache(cache, WRITE_CACHE, 0, FALSE, TRUE);
3800
#ifndef MYSQL_CLIENT
3801
/*****************************************************************************
3803
Heartbeat Log Event class
3805
Replication event to ensure to slave that master is alive.
3806
The event is originated by master's dump thread and sent straight to
3807
slave without being logged. Slave itself does not store it in relay log
3808
but rather uses a data for immediate checks and throws away the event.
3810
Two members of the class log_ident and Log_event::log_pos comprise
3811
@see the event_coordinates instance. The coordinates that a heartbeat
3812
instance carries correspond to the last event master has sent from
3815
****************************************************************************/
3816
class Heartbeat_log_event: public Log_event
3819
Heartbeat_log_event(const char* buf, uint event_len,
3820
const Format_description_log_event* description_event);
3821
Log_event_type get_type_code() { return HEARTBEAT_LOG_EVENT; }
3822
bool is_valid() const
3824
return (log_ident != NULL &&
3825
log_pos >= BIN_LOG_HEADER_SIZE);
3827
const char * get_log_ident() { return log_ident; }
3828
uint get_ident_len() { return ident_len; }
3831
const char* log_ident;
3837
@} (end of group Replication)
3840
#endif /* _log_event_h */
added
removed
sql/log_event.h
