1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008 Sun Microsystems
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; version 2 of the License.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
@addtogroup Replication
26
@brief Binary log event definitions. This includes generic code
27
common to all types of log events, as well as specific code for each
32
#ifndef DRIZZLED_LOG_EVENT_H
33
#define DRIZZLED_LOG_EVENT_H
36
#include <mysys/my_bitmap.h>
37
#include <drizzled/replication/constants.h>
38
#include <drizzled/replication/record.h>
39
#include <drizzled/replication/reporting.h>
40
#include <drizzled/session.h>
43
#include <drizzled/sql_string.h> /* append_query_string() needs String declaration */
46
Either assert or return an error.
48
In debug build, the condition will be checked, but in non-debug
49
builds, the error code given will be returned instead.
51
@param COND Condition to check
52
@param ERRNO Error number to return in non-debug builds
54
#define ASSERT_OR_RETURN_ERROR(COND, ERRNO) \
57
#define LOG_READ_EOF -1
58
#define LOG_READ_BOGUS -2
59
#define LOG_READ_IO -3
60
#define LOG_READ_MEM -5
61
#define LOG_READ_TRUNC -6
62
#define LOG_READ_TOO_LARGE -7
64
#define LOG_EVENT_OFFSET 4
67
3 is MySQL 4.x; 4 is MySQL 5.0.0.
68
Compared to version 3, version 4 has:
69
- a different Start_log_event, which includes info about the binary log
70
(sizes of headers); this info is included for better compatibility if the
71
master's MySQL version is different from the slave's.
72
- all events have a unique ID (the triplet (server_id, timestamp at server
73
start, other) to be sure an event is not executed more than once in a
74
multimaster setup, example:
82
if a query is run on M1, it will arrive twice on S, so we need that S
83
remembers the last unique ID it has processed, to compare and know if the
84
event should be skipped or not. Example of ID: we already have the server id
86
timestamp_when_the_master_started (4 bytes), a counter (a sequence number
87
which increments every time we write an event to the binlog) (3 bytes).
88
Q: how do we handle when the counter is overflowed and restarts from 0 ?
90
- Query and Load (Create or Execute) events may have a more precise
91
timestamp (with microseconds), number of matched/affected/warnings rows
92
and fields of session variables: SQL_MODE,
93
FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, SQL_AUTO_IS_NULL, the collations and
94
charsets, the PASSWORD() version (old/new/...).
96
#define BINLOG_VERSION 4
99
We could have used SERVER_VERSION_LENGTH, but this introduces an
100
obscure dependency - if somebody decided to change SERVER_VERSION_LENGTH
101
this would break the replication protocol
103
#define ST_SERVER_VER_LEN 50
106
These are flags and structs to handle all the LOAD DATA INFILE options (LINES
111
These are flags and structs to handle all the LOAD DATA INFILE options (LINES
113
DUMPFILE_FLAG is probably useless (DUMPFILE is a clause of SELECT, not of LOAD
116
#define DUMPFILE_FLAG 0x1
117
#define OPT_ENCLOSED_FLAG 0x2
118
#define REPLACE_FLAG 0x4
119
#define IGNORE_FLAG 0x8
121
#define FIELD_TERM_EMPTY 0x1
122
#define ENCLOSED_EMPTY 0x2
123
#define LINE_TERM_EMPTY 0x4
124
#define LINE_START_EMPTY 0x8
125
#define ESCAPED_EMPTY 0x10
127
#define NUM_LOAD_DELIM_STRS 5
129
/*****************************************************************************
133
****************************************************************************/
136
sql_ex_info() {} /* Remove gcc warning */
137
const char* field_term;
138
const char* enclosed;
139
const char* line_term;
140
const char* line_start;
142
int cached_new_format;
143
uint8_t field_term_len,enclosed_len,line_term_len,line_start_len, escaped_len;
147
/* store in new format even if old is possible */
148
void force_new_format() { cached_new_format = 1;}
151
return (new_format() ?
152
field_term_len + enclosed_len + line_term_len +
153
line_start_len + escaped_len + 6 : 7);
155
bool write_data(IO_CACHE* file);
156
const char* init(const char* buf, const char* buf_end, bool use_new_format);
159
return ((cached_new_format != -1) ? cached_new_format :
160
(cached_new_format=(field_term_len > 1 ||
162
line_term_len > 1 || line_start_len > 1 ||
167
/*****************************************************************************
171
This log consists of events. Each event has a fixed-length header,
172
possibly followed by a variable length data body.
174
The data body consists of an optional fixed length segment (post-header)
175
and an optional variable length segment.
177
See the #defines below for the format specifics.
179
The events which really update data are Query_log_event,
180
Execute_load_query_log_event and old Load_log_event and
181
Execute_load_log_event events (Execute_load_query is used together with
182
Begin_load_query and Append_block events to replicate LOAD DATA INFILE.
183
Create_file/Append_block/Execute_load (which includes Load_log_event)
184
were used to replicate LOAD DATA before the 5.0.3).
186
****************************************************************************/
188
#define LOG_EVENT_HEADER_LEN 19 /* the fixed header length */
189
#define OLD_HEADER_LEN 13 /* the fixed header length in 3.23 */
191
Fixed header length, where 4.x and 5.0 agree. That is, 5.0 may have a longer
192
header (it will for sure when we have the unique event's ID), but at least
193
the first 19 bytes are the same in 4.x and 5.0. So when we have the unique
194
event's ID, LOG_EVENT_HEADER_LEN will be something like 26, but
195
LOG_EVENT_MINIMAL_HEADER_LEN will remain 19.
197
#define LOG_EVENT_MINIMAL_HEADER_LEN (uint8_t)19
199
/* event-specific post-header sizes */
200
// where 3.23, 4.x and 5.0 agree
201
#define QUERY_HEADER_MINIMAL_LEN (4 + 4 + 1 + 2)
202
// where 5.0 differs: 2 for len of N-bytes vars.
203
#define QUERY_HEADER_LEN (QUERY_HEADER_MINIMAL_LEN + 2)
204
#define LOAD_HEADER_LEN (4 + 4 + 4 + 1 +1 + 4)
205
#define START_V3_HEADER_LEN (2 + ST_SERVER_VER_LEN + 4)
206
#define ROTATE_HEADER_LEN 8 // this is FROZEN (the Rotate post-header is frozen)
207
#define CREATE_FILE_HEADER_LEN 4
208
#define APPEND_BLOCK_HEADER_LEN 4
209
#define EXEC_LOAD_HEADER_LEN 4
210
#define DELETE_FILE_HEADER_LEN 4
211
#define FORMAT_DESCRIPTION_HEADER_LEN (START_V3_HEADER_LEN+1+LOG_EVENT_TYPES)
212
#define ROWS_HEADER_LEN 8
213
#define TABLE_MAP_HEADER_LEN 8
214
#define EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN (4 + 4 + 4 + 1)
215
#define EXECUTE_LOAD_QUERY_HEADER_LEN (QUERY_HEADER_LEN + EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN)
216
#define INCIDENT_HEADER_LEN 2
217
#define HEARTBEAT_HEADER_LEN 0
219
Max number of possible extra bytes in a replication event compared to a
220
packet (i.e. a query) sent from client to master;
221
First, an auxiliary log_event status vars estimation:
223
#define MAX_SIZE_LOG_EVENT_STATUS (4 /* flags2 */ + \
225
1 + 1 + 255 /* catalog */ + \
228
MAX_TIME_ZONE_NAME_LENGTH)
229
#define MAX_LOG_EVENT_HEADER ( /* in order of Query_log_event::write */ \
230
LOG_EVENT_HEADER_LEN + /* write_header */ \
231
QUERY_HEADER_LEN + /* write_data */ \
232
EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN + /*write_post_header_for_derived */ \
233
MAX_SIZE_LOG_EVENT_STATUS + /* status */ \
237
Event header offsets;
238
these point to places inside the fixed header.
241
#define EVENT_TYPE_OFFSET 4
242
#define SERVER_ID_OFFSET 5
243
#define EVENT_LEN_OFFSET 9
244
#define LOG_POS_OFFSET 13
245
#define FLAGS_OFFSET 17
247
/* start event post-header (for v3 and v4) */
249
#define ST_BINLOG_VER_OFFSET 0
250
#define ST_SERVER_VER_OFFSET 2
251
#define ST_CREATED_OFFSET (ST_SERVER_VER_OFFSET + ST_SERVER_VER_LEN)
252
#define ST_COMMON_HEADER_LEN_OFFSET (ST_CREATED_OFFSET + 4)
254
/* slave event post-header (this event is never written) */
256
#define SL_MASTER_PORT_OFFSET 8
257
#define SL_MASTER_POS_OFFSET 0
258
#define SL_MASTER_HOST_OFFSET 10
260
/* query event post-header */
262
#define Q_THREAD_ID_OFFSET 0
263
#define Q_EXEC_TIME_OFFSET 4
264
#define Q_DB_LEN_OFFSET 8
265
#define Q_ERR_CODE_OFFSET 9
266
#define Q_STATUS_VARS_LEN_OFFSET 11
267
#define Q_DATA_OFFSET QUERY_HEADER_LEN
268
/* these are codes, not offsets; not more than 256 values (1 byte). */
269
#define Q_FLAGS2_CODE 0
271
#define Q_LC_TIME_NAMES_CODE 7
273
#define Q_CHARSET_DATABASE_CODE 8
274
/* Intvar event post-header */
276
#define I_TYPE_OFFSET 0
277
#define I_VAL_OFFSET 1
279
/* Rand event post-header */
281
#define RAND_SEED1_OFFSET 0
282
#define RAND_SEED2_OFFSET 8
284
/* User_var event post-header */
286
#define UV_VAL_LEN_SIZE 4
287
#define UV_VAL_IS_NULL 1
288
#define UV_VAL_TYPE_SIZE 1
289
#define UV_NAME_LEN_SIZE 4
290
#define UV_CHARSET_NUMBER_SIZE 4
292
/* Load event post-header */
294
#define L_THREAD_ID_OFFSET 0
295
#define L_EXEC_TIME_OFFSET 4
296
#define L_SKIP_LINES_OFFSET 8
297
#define L_TBL_LEN_OFFSET 12
298
#define L_DB_LEN_OFFSET 13
299
#define L_NUM_FIELDS_OFFSET 14
300
#define L_SQL_EX_OFFSET 18
301
#define L_DATA_OFFSET LOAD_HEADER_LEN
303
/* Rotate event post-header */
305
#define R_POS_OFFSET 0
306
#define R_IDENT_OFFSET 8
308
/* CF to DF handle LOAD DATA INFILE */
310
/* CF = "Create File" */
311
#define CF_FILE_ID_OFFSET 0
312
#define CF_DATA_OFFSET CREATE_FILE_HEADER_LEN
314
/* AB = "Append Block" */
315
#define AB_FILE_ID_OFFSET 0
316
#define AB_DATA_OFFSET APPEND_BLOCK_HEADER_LEN
318
/* EL = "Execute Load" */
319
#define EL_FILE_ID_OFFSET 0
321
/* DF = "Delete File" */
322
#define DF_FILE_ID_OFFSET 0
324
/* TM = "Table Map" */
325
#define TM_MAPID_OFFSET 0
326
#define TM_FLAGS_OFFSET 6
329
#define RW_MAPID_OFFSET 0
330
#define RW_FLAGS_OFFSET 6
332
/* ELQ = "Execute Load Query" */
333
#define ELQ_FILE_ID_OFFSET QUERY_HEADER_LEN
334
#define ELQ_FN_POS_START_OFFSET ELQ_FILE_ID_OFFSET + 4
335
#define ELQ_FN_POS_END_OFFSET ELQ_FILE_ID_OFFSET + 8
336
#define ELQ_DUP_HANDLING_OFFSET ELQ_FILE_ID_OFFSET + 12
338
/* 4 bytes which all binlogs should begin with */
339
#define BINLOG_MAGIC "\xfe\x62\x69\x6e"
342
This flag only makes sense for Format_description_log_event. It is set
343
when the event is written, and *reset* when a binlog file is
344
closed (yes, it's the only case when MySQL modifies already written
345
part of binlog). Thus it is a reliable indicator that binlog was
346
closed correctly. (Stop_log_event is not enough, there's always a
347
small chance that mysqld crashes in the middle of insert and end of
348
the binlog would look like a Stop_log_event).
350
This flag is used to detect a restart after a crash, and to provide
351
"unbreakable" binlog. The problem is that on a crash storage engines
352
rollback automatically, while binlog does not. To solve this we use this
353
flag and automatically append ROLLBACK to every non-closed binlog (append
354
virtually, on reading, file itself is not changed). If this flag is found,
355
mysqlbinlog simply prints "ROLLBACK" Replication master does not abort on
356
binlog corruption, but takes it as EOF, and replication slave forces a
357
rollback in this case.
359
Note, that old binlogs does not have this flag set, so we get a
360
a backward-compatible behaviour.
363
#define LOG_EVENT_BINLOG_IN_USE_F 0x1
366
@def LOG_EVENT_THREAD_SPECIFIC_F
368
If the query depends on the thread (for example: TEMPORARY Table).
369
Currently this is used by mysqlbinlog to know it must print
370
SET @@PSEUDO_THREAD_ID=xx; before the query (it would not hurt to print it
371
for every query but this would be slow).
373
#define LOG_EVENT_THREAD_SPECIFIC_F 0x4
376
@def LOG_EVENT_SUPPRESS_USE_F
378
Suppress the generation of 'USE' statements before the actual
379
statement. This flag should be set for any events that does not need
380
the current database set to function correctly. Most notable cases
381
are 'CREATE DATABASE' and 'DROP DATABASE'.
383
This flags should only be used in exceptional circumstances, since
384
it introduce a significant change in behaviour regarding the
385
replication logic together with the flags --binlog-do-db and
388
#define LOG_EVENT_SUPPRESS_USE_F 0x8
391
The table map version internal to the log should be increased after
392
the event has been written to the binary log.
394
#define LOG_EVENT_UPDATE_TABLE_MAP_VERSION_F 0x10
397
@def OPTIONS_WRITTEN_TO_BIN_LOG
399
OPTIONS_WRITTEN_TO_BIN_LOG are the bits of session->options which must
400
be written to the binlog. OPTIONS_WRITTEN_TO_BIN_LOG could be
401
written into the Format_description_log_event, so that if later we
402
don't want to replicate a variable we did replicate, or the
403
contrary, it's doable. But it should not be too hard to decide once
404
for all of what we replicate and what we don't, among the fixed 32
405
bits of session->options.
407
I (Guilhem) have read through every option's usage, and it looks
408
like OPTION_AUTO_IS_NULL and OPTION_NO_FOREIGN_KEYS are the only
409
ones which alter how the query modifies the table. It's good to
410
replicate OPTION_RELAXED_UNIQUE_CHECKS too because otherwise, the
411
slave may insert data slower than the master, in InnoDB.
412
OPTION_BIG_SELECTS is not needed (the slave thread runs with
413
max_join_size=HA_POS_ERROR) and OPTION_BIG_TABLES is not needed
414
either, as the manual says (because a too big in-memory temp table
415
is automatically written to disk).
417
#define OPTIONS_WRITTEN_TO_BIN_LOG \
418
(OPTION_AUTO_IS_NULL | OPTION_NO_FOREIGN_KEY_CHECKS | \
419
OPTION_RELAXED_UNIQUE_CHECKS | OPTION_NOT_AUTOCOMMIT)
421
/* Shouldn't be defined before */
422
#define EXPECTED_OPTIONS \
423
((1U << 14) | (1U << 26) | (1U << 27) | (1U << 19))
425
#if OPTIONS_WRITTEN_TO_BIN_LOG != EXPECTED_OPTIONS
426
#error OPTIONS_WRITTEN_TO_BIN_LOG must NOT change their values!
428
#undef EXPECTED_OPTIONS /* You shouldn't use this one */
433
Enumeration type for the different types of log events.
438
Every time you update this enum (when you add a type), you have to
439
fix Format_description_log_event::Format_description_log_event().
449
CREATE_FILE_EVENT= 8,
450
APPEND_BLOCK_EVENT= 9,
452
DELETE_FILE_EVENT= 11,
454
NEW_LOAD_EVENT is like LOAD_EVENT except that it has a longer
455
sql_ex, allowing multibyte TERMINATED BY etc; both types share the
456
same class (Load_log_event)
461
FORMAT_DESCRIPTION_EVENT= 15,
463
BEGIN_LOAD_QUERY_EVENT= 17,
464
EXECUTE_LOAD_QUERY_EVENT= 18,
466
TABLE_MAP_EVENT = 19,
469
These event numbers are used from 5.1.16 and forward
471
WRITE_ROWS_EVENT = 23,
472
UPDATE_ROWS_EVENT = 24,
473
DELETE_ROWS_EVENT = 25,
476
Something out of the ordinary happened on the master
481
Heartbeat event to be send by master at its idle time
482
to ensure master's online status to slave
484
HEARTBEAT_LOG_EVENT= 27,
487
Add new events here - right above this comment!
488
Existing events (except ENUM_END_EVENT) should never change their numbers
491
ENUM_END_EVENT /* end marker */
495
The number of types we handle in Format_description_log_event (UNKNOWN_EVENT
496
is not to be handled, it does not exist in binlogs, it does not have a
499
#define LOG_EVENT_TYPES (ENUM_END_EVENT-1)
503
INVALID_INT_EVENT = 0, LAST_INSERT_ID_EVENT = 1, INSERT_ID_EVENT = 2
508
class DRIZZLE_BIN_LOG;
511
class Format_description_log_event;
512
class Relay_log_info;
515
the struct aggregates two paramenters that identify an event
516
uniquely in scope of communication of a particular master and slave couple.
517
I.e there can not be 2 events from the same staying connected master which
518
have the same coordinates.
520
Such identifier is not yet unique generally as the event originating master
521
is resetable. Also the crashed master can be replaced with some other.
523
struct event_coordinates
525
char * file_name; // binlog file name (directories stripped)
526
my_off_t pos; // event's position in the binlog file
532
This is the abstract base class for binary log events.
534
@section Log_event_binary_format Binary Format
536
Any @c Log_event saved on disk consists of the following three
543
The Common-Header, documented in the table @ref Table_common_header
544
"below", always has the same form and length within one version of
545
MySQL. Each event type specifies a format and length of the
546
Post-Header. The length of the Common-Header is the same for all
547
events of the same type. The Body may be of different format and
548
length even for different events of the same type. The binary
549
formats of Post-Header and Body are documented separately in each
550
subclass. The binary format of Common-Header is as follows.
553
<caption>Common-Header</caption>
563
<td>4 byte unsigned integer</td>
564
<td>The time when the query started, in seconds since 1970.
570
<td>1 byte enumeration</td>
571
<td>See enum #Log_event_type.</td>
576
<td>4 byte unsigned integer</td>
577
<td>Server ID of the server that created the event.</td>
582
<td>4 byte unsigned integer</td>
583
<td>The total size of this event, in bytes. In other words, this
584
is the sum of the sizes of Common-Header, Post-Header, and Body.
589
<td>master_position</td>
590
<td>4 byte unsigned integer</td>
591
<td>The position of the next event in the master binary log, in
592
bytes from the beginning of the file. In a binlog that is not a
593
relay log, this is just the position of the next event, in bytes
594
from the beginning of the file. In a relay log, this is
595
the position of the next event in the master's binlog.
601
<td>2 byte bitfield</td>
602
<td>See Log_event::flags.</td>
606
Summing up the numbers above, we see that the total size of the
607
common header is 19 bytes.
609
@subsection Log_event_format_of_atomic_primitives Format of Atomic Primitives
611
- All numbers, whether they are 16-, 24-, 32-, or 64-bit numbers,
612
are stored in little endian, i.e., the least significant byte first,
613
unless otherwise specified.
615
@anchor packed_integer
616
- Some events use a special format for efficient representation of
617
unsigned integers, called Packed Integer. A Packed Integer has the
618
capacity of storing up to 8-byte integers, while small integers
619
still can use 1, 3, or 4 bytes. The value of the first byte
620
determines how to read the number, according to the following table:
623
<caption>Format of Packed Integer</caption>
632
<td>The first byte is the number (in the range 0-250), and no more
638
<td>Two more bytes are used. The number is in the range
644
<td>Three more bytes are used. The number is in the range
645
0xffff-0xffffff.</td>
650
<td>Eight more bytes are used. The number is in the range
651
0xffffff-0xffffffffffffffff.</td>
656
- Strings are stored in various formats. The format of each string
657
is documented separately.
663
Enumeration of what kinds of skipping (and non-skipping) that can
664
occur when the slave executes an event.
669
enum enum_skip_reason {
676
Skip event by ignoring it.
678
This means that the slave skip counter will not be changed.
683
Skip event and decrease skip counter.
690
The following type definition is to be used whenever data is placed
691
and manipulated in a common buffer. Use this typedef for buffers
692
that contain data containing binary and character data.
694
typedef unsigned char Byte;
697
The offset in the log where this event originally appeared (it is
698
preserved in relay logs, making SHOW SLAVE STATUS able to print
699
coordinates of the event in the master's binlog). Note: when a
700
transaction is written by the master to its binlog (wrapped in
701
BEGIN/COMMIT) the log_pos of all the queries it contains is the
702
one of the BEGIN (this way, when one does SHOW SLAVE STATUS it
703
sees the offset of the BEGIN, which is logical as rollback may
704
occur), except the COMMIT query which has its real offset.
708
A temp buffer for read_log_event; it is later analysed according to the
709
event's type, and its content is distributed in the event-specific fields.
713
Timestamp on the master(for debugging and replication of
714
NOW()/TIMESTAMP). It is important for queries and LOAD DATA
715
INFILE. This is set at the event's creation time, except for Query
716
and Load (et al.) events where this is set at the query's
717
execution time, which guarantees good replication (otherwise, we
718
could have a query and its event with different timestamps).
721
/* The number of seconds the query took to run on the master. */
723
/* Number of bytes written by write() function */
727
The master's server id (is preserved in the relay log; used to
728
prevent from infinite loops in circular replication).
733
Some 16 flags. See the definitions above for LOG_EVENT_TIME_F,
734
LOG_EVENT_FORCED_ROTATE_F, LOG_EVENT_THREAD_SPECIFIC_F, and
735
LOG_EVENT_SUPPRESS_USE_F for notes.
742
A storage to cache the global system variable's value.
743
Handling of a separate event will be governed its member.
745
ulong slave_exec_mode;
750
Log_event(Session* session_arg, uint16_t flags_arg, bool cache_stmt);
752
read_log_event() functions read an event from a binlog or relay
753
log; used by SHOW BINLOG EVENTS, the binlog_dump thread on the
754
master (reads master's binlog), the slave IO thread (reads the
755
event sent by binlog_dump), the slave SQL thread (reads the event
756
from the relay log). If mutex is 0, the read will proceed without
757
mutex. We need the description_event to be able to parse the
758
event (to know the post-header's size); in fact in read_log_event
759
we detect the event's type, then call the specific event's
760
constructor and pass description_event as an argument.
762
static Log_event* read_log_event(IO_CACHE* file,
763
pthread_mutex_t* log_lock,
764
const Format_description_log_event
766
static int read_log_event(IO_CACHE* file, String* packet,
767
pthread_mutex_t* log_lock);
769
init_show_field_list() prepares the column names and types for the
770
output of SHOW BINLOG EVENTS; it is used only by SHOW BINLOG
773
static void init_show_field_list(List<Item>* field_list);
774
int net_send(Protocol *protocol, const char* log_name, my_off_t pos);
777
pack_info() is used by SHOW BINLOG EVENTS; as print() it prepares and sends
778
a string to display to the user, so it resembles print().
781
virtual void pack_info(Protocol *protocol);
783
virtual const char* get_db();
785
static void *operator new(size_t size)
787
return (void*) malloc(size);
790
static void operator delete(void *ptr, size_t)
792
free((unsigned char*) ptr);
795
/* Placement version of the above operators */
796
static void *operator new(size_t, void* ptr) { return ptr; }
797
static void operator delete(void*, void*) { }
799
bool write_header(IO_CACHE* file, ulong data_length);
800
virtual bool write(IO_CACHE* file)
802
return (write_header(file, get_data_size()) ||
803
write_data_header(file) ||
804
write_data_body(file));
806
virtual bool write_data_header(IO_CACHE*)
808
virtual bool write_data_body(IO_CACHE*)
811
virtual Log_event_type get_type_code() = 0;
812
virtual bool is_valid() const = 0;
813
virtual bool is_artificial_event() { return 0; }
814
inline bool get_cache_stmt() const { return cache_stmt; }
815
Log_event(const char* buf, const Format_description_log_event
817
virtual ~Log_event() { free_temp_buf();}
818
void register_temp_buf(char* buf) { temp_buf = buf; }
828
Get event length for simple events. For complicated events the length
829
is calculated during write()
831
virtual int get_data_size() { return 0;}
832
static Log_event* read_log_event(const char* buf, uint32_t event_len,
834
const Format_description_log_event
837
Returns the human readable name of the given event type.
839
static const char* get_type_str(Log_event_type type);
841
Returns the human readable name of this event's type.
843
const char* get_type_str();
845
/* Return start of query time or current time */
850
Apply the event to the database.
852
This function represents the public interface for applying an
857
int apply_event(Relay_log_info const *rli)
859
return do_apply_event(rli);
864
Update the relay log position.
866
This function represents the public interface for "stepping over"
867
the event and will update the relay log information.
871
int update_pos(Relay_log_info *rli)
873
return do_update_pos(rli);
877
Decide if the event shall be skipped, and the reason for skipping
882
enum_skip_reason shall_skip(Relay_log_info *rli)
884
return do_shall_skip(rli);
890
Helper function to ignore an event w.r.t. the slave skip counter.
892
This function can be used inside do_shall_skip() for functions
893
that cannot end a group. If the slave skip counter is 1 when
894
seeing such an event, the event shall be ignored, the counter
895
left intact, and processing continue with the next event.
899
enum_skip_reason do_shall_skip(Relay_log_info *rli) {
900
return continue_group(rli);
906
enum_skip_reason continue_group(Relay_log_info *rli);
909
Primitive to apply an event to the database.
911
This is where the change to the database is made.
913
@note The primitive is protected instead of private, since there
914
is a hierarchy of actions to be performed in some cases.
916
@see Format_description_log_event::do_apply_event()
918
@param rli Pointer to relay log info structure
920
@retval 0 Event applied successfully
921
@retval errno Error code if event application failed
923
virtual int do_apply_event(Relay_log_info const *)
925
return 0; /* Default implementation does nothing */
930
Advance relay log coordinates.
932
This function is called to advance the relay log coordinates to
933
just after the event. It is essential that both the relay log
934
coordinate and the group log position is updated correctly, since
935
this function is used also for skipping events.
937
Normally, each implementation of do_update_pos() shall:
939
- Update the event position to refer to the position just after
942
- Update the group log position to refer to the position just
943
after the event <em>if the event is last in a group</em>
945
@param rli Pointer to relay log info structure
947
@retval 0 Coordinates changed successfully
948
@retval errno Error code if advancing failed (usually just
949
1). Observe that handler errors are returned by the
950
do_apply_event() function, and not by this one.
952
virtual int do_update_pos(Relay_log_info *rli);
956
Decide if this event shall be skipped or not and the reason for
959
The default implementation decide that the event shall be skipped
962
- the server id of the event is the same as the server id of the
963
server and <code>rli->replicate_same_server_id</code> is true,
966
- if <code>rli->slave_skip_counter</code> is greater than zero.
971
@retval Log_event::EVENT_SKIP_NOT
972
The event shall not be skipped and should be applied.
974
@retval Log_event::EVENT_SKIP_IGNORE
975
The event shall be skipped by just ignoring it, i.e., the slave
976
skip counter shall not be changed. This happends if, for example,
977
the originating server id of the event is the same as the server
980
@retval Log_event::EVENT_SKIP_COUNT
981
The event shall be skipped because the slave skip counter was
982
non-zero. The caller shall decrease the counter by one.
984
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
989
One class for each type of event.
990
Two constructors for each class:
991
- one to create the event for logging (when the server acts as a master),
992
called after an update to the database is done,
993
which accepts parameters like the query, the database, the options for LOAD
995
- one to create the event from a packet (when the server acts as a slave),
996
called before reproducing the update, which accepts parameters (like a
997
buffer). Used to read from the master, from the relay log, and in
998
mysqlbinlog. This constructor must be format-tolerant.
1002
@class Query_log_event
1004
A @c Query_log_event is created for each query that modifies the
1005
database, unless the query is logged row-based.
1007
@section Query_log_event_binary_format Binary format
1009
See @ref Log_event_binary_format "Binary format for log events" for
1010
a general discussion and introduction to the binary format of binlog
1013
The Post-Header has five components:
1016
<caption>Post-Header for Query_log_event</caption>
1021
<th>Description</th>
1025
<td>slave_proxy_id</td>
1026
<td>4 byte unsigned integer</td>
1027
<td>An integer identifying the client thread that issued the
1028
query. The id is unique per server. (Note, however, that two
1029
threads on different servers may have the same slave_proxy_id.)
1030
This is used when a client thread creates a temporary table local
1031
to the client. The slave_proxy_id is used to distinguish
1032
temporary tables that belong to different clients.
1038
<td>4 byte unsigned integer</td>
1039
<td>The time from when the query started to when it was logged in
1040
the binlog, in seconds.</td>
1045
<td>1 byte integer</td>
1046
<td>The length of the name of the currently selected database.</td>
1051
<td>2 byte unsigned integer</td>
1052
<td>Error code generated by the master. If the master fails, the
1053
slave will fail with the same error code, except for the error
1054
codes ER_DB_CREATE_EXISTS == 1007 and ER_DB_DROP_EXISTS == 1008.
1059
<td>status_vars_len</td>
1060
<td>2 byte unsigned integer</td>
1061
<td>The length of the status_vars block of the Body, in bytes. See
1062
@ref query_log_event_status_vars "below".
1067
The Body has the following components:
1070
<caption>Body for Query_log_event</caption>
1075
<th>Description</th>
1079
<td>@anchor query_log_event_status_vars status_vars</td>
1080
<td>status_vars_len bytes</td>
1081
<td>Zero or more status variables. Each status variable consists
1082
of one byte identifying the variable stored, followed by the value
1083
of the variable. The possible variables are listed separately in
1084
the table @ref Table_query_log_event_status_vars "below". MySQL
1085
always writes events in the order defined below; however, it is
1086
capable of reading them in any order. </td>
1092
<td>The currently selected database, as a null-terminated string.
1094
(The trailing zero is redundant since the length is already known;
1095
it is db_len from Post-Header.)
1101
<td>variable length string without trailing zero, extending to the
1102
end of the event (determined by the length field of the
1105
<td>The SQL query.</td>
1109
The following table lists the status variables that may appear in
1110
the status_vars field.
1112
@anchor Table_query_log_event_status_vars
1114
<caption>Status variables for Query_log_event</caption>
1117
<th>Status variable</th>
1118
<th>1 byte identifier</th>
1120
<th>Description</th>
1125
<td>Q_FLAGS2_CODE == 0</td>
1126
<td>4 byte bitfield</td>
1127
<td>The flags in @c session->options, binary AND-ed with @c
1128
OPTIONS_WRITTEN_TO_BIN_LOG. The @c session->options bitfield contains
1129
options for "SELECT". @c OPTIONS_WRITTEN identifies those options
1130
that need to be written to the binlog (not all do). Specifically,
1131
@c OPTIONS_WRITTEN_TO_BIN_LOG equals (@c OPTION_AUTO_IS_NULL | @c
1132
OPTION_NO_FOREIGN_KEY_CHECKS | @c OPTION_RELAXED_UNIQUE_CHECKS |
1133
@c OPTION_NOT_AUTOCOMMIT), or 0x0c084000 in hex.
1135
These flags correspond to the SQL variables SQL_AUTO_IS_NULL,
1136
FOREIGN_KEY_CHECKS, UNIQUE_CHECKS, and AUTOCOMMIT, documented in
1137
the "SET Syntax" section of the MySQL Manual.
1139
This field is always written to the binlog in version >= 5.0, and
1140
never written in version < 5.0.
1146
<td>Q_SQL_MODE_CODE == 1</td>
1147
<td>8 byte bitfield</td>
1148
<td>The @c sql_mode variable. See the section "SQL Modes" in the
1149
MySQL manual, and see mysql_priv.h for a list of the possible
1150
flags. Currently (2007-10-04), the following flags are available:
1152
MODE_REAL_AS_FLOAT==0x1
1153
MODE_PIPES_AS_CONCAT==0x2
1154
MODE_ANSI_QUOTES==0x4
1155
MODE_IGNORE_SPACE==0x8
1157
MODE_ONLY_FULL_GROUP_BY==0x20
1158
MODE_NO_UNSIGNED_SUBTRACTION==0x40
1159
MODE_NO_DIR_IN_CREATE==0x80
1160
MODE_POSTGRESQL==0x100
1165
MODE_NO_KEY_OPTIONS==0x2000
1166
MODE_NO_TABLE_OPTIONS==0x4000
1167
MODE_NO_FIELD_OPTIONS==0x8000
1168
MODE_MYSQL323==0x10000
1169
MODE_MYSQL323==0x20000
1170
MODE_MYSQL40==0x40000
1172
MODE_NO_AUTO_VALUE_ON_ZERO==0x100000
1173
MODE_NO_BACKSLASH_ESCAPES==0x200000
1174
MODE_STRICT_TRANS_TABLES==0x400000
1175
MODE_STRICT_ALL_TABLES==0x800000
1176
MODE_NO_ZERO_IN_DATE==0x1000000
1177
MODE_NO_ZERO_DATE==0x2000000
1178
MODE_INVALID_DATES==0x4000000
1179
MODE_ERROR_FOR_DIVISION_BY_ZERO==0x8000000
1180
MODE_TRADITIONAL==0x10000000
1181
MODE_NO_AUTO_CREATE_USER==0x20000000
1182
MODE_HIGH_NOT_PRECEDENCE==0x40000000
1183
MODE_PAD_CHAR_TO_FULL_LENGTH==0x80000000
1185
All these flags are replicated from the server. However, all
1186
flags except @c MODE_NO_DIR_IN_CREATE are honored by the slave;
1187
the slave always preserves its old value of @c
1188
MODE_NO_DIR_IN_CREATE. For a rationale, see comment in
1189
@c Query_log_event::do_apply_event in @c log_event.cc.
1191
This field is always written to the binlog.
1197
<td>Q_CATALOG_NZ_CODE == 6</td>
1198
<td>Variable-length string: the length in bytes (1 byte) followed
1199
by the characters (at most 255 bytes)
1201
<td>Stores the client's current catalog. Every database belongs
1202
to a catalog, the same way that every table belongs to a
1203
database. Currently, there is only one catalog, "std".
1205
This field is written if the length of the catalog is > 0;
1206
otherwise it is not written.
1211
<td>auto_increment</td>
1212
<td>Q_AUTO_INCREMENT == 3</td>
1213
<td>two 2 byte unsigned integers, totally 2+2=4 bytes</td>
1215
<td>The two variables auto_increment_increment and
1216
auto_increment_offset, in that order. For more information, see
1217
"System variables" in the MySQL manual.
1219
This field is written if auto_increment > 1. Otherwise, it is not
1226
<td>Q_CHARSET_CODE == 4</td>
1227
<td>three 2 byte unsigned integers, totally 2+2+2=6 bytes</td>
1228
<td>The three variables character_set_client,
1229
collation_connection, and collation_server, in that order.
1230
character_set_client is a code identifying the character set and
1231
collation used by the client to encode the query.
1232
collation_connection identifies the character set and collation
1233
that the master converts the query to when it receives it; this is
1234
useful when comparing literal strings. collation_server is the
1235
default character set and collation used when a new database is
1238
See also "Connection Character Sets and Collations" in the MySQL
1241
All three variables are codes identifying a (character set,
1242
collation) pair. To see which codes map to which pairs, run the
1243
query "SELECT id, character_set_name, collation_name FROM
1246
Cf. Q_CHARSET_DATABASE_CODE below.
1248
This field is always written.
1254
<td>Q_TIME_ZONE_CODE == 5</td>
1255
<td>Variable-length string: the length in bytes (1 byte) followed
1256
by the characters (at most 255 bytes).
1257
<td>The time_zone of the master.
1259
See also "System Variables" and "MySQL Server Time Zone Support"
1260
in the MySQL manual.
1262
This field is written if the length of the time zone string is >
1263
0; otherwise, it is not written.
1268
<td>lc_time_names_number</td>
1269
<td>Q_LC_TIME_NAMES_CODE == 7</td>
1270
<td>2 byte integer</td>
1271
<td>A code identifying a table of month and day names. The
1272
mapping from codes to languages is defined in @c sql_locale.cc.
1274
This field is written if it is not 0, i.e., if the locale is not
1280
<td>charset_database_number</td>
1281
<td>Q_CHARSET_DATABASE_CODE == 8</td>
1282
<td>2 byte integer</td>
1284
<td>The value of the collation_database system variable (in the
1285
source code stored in @c session->variables.collation_database), which
1286
holds the code for a (character set, collation) pair as described
1287
above (see Q_CHARSET_CODE).
1289
collation_database was used in old versions (???WHEN). Its value
1290
was loaded when issuing a "use db" query and could be changed by
1291
issuing a "SET collation_database=xxx" query. It used to affect
1292
the "LOAD DATA INFILE" and "CREATE TABLE" commands.
1294
In newer versions, "CREATE TABLE" has been changed to take the
1295
character set from the database of the created table, rather than
1296
the character set of the current database. This makes a
1297
difference when creating a table in another database than the
1298
current one. "LOAD DATA INFILE" has not yet changed to do this,
1299
but there are plans to eventually do it, and to make
1300
collation_database read-only.
1302
This field is written if it is not 0.
1307
@subsection Query_log_event_notes_on_previous_versions Notes on Previous Versions
1309
* Status vars were introduced in version 5.0. To read earlier
1310
versions correctly, check the length of the Post-Header.
1312
* The status variable Q_CATALOG_CODE == 2 existed in MySQL 5.0.x,
1313
where 0<=x<=3. It was identical to Q_CATALOG_CODE, except that the
1314
string had a trailing '\0'. The '\0' was removed in 5.0.4 since it
1315
was redundant (the string length is stored before the string). The
1316
Q_CATALOG_CODE will never be written by a new master, but can still
1317
be understood by a new slave.
1319
* See Q_CHARSET_DATABASE_CODE in the table above.
1322
class Query_log_event: public Log_event
1325
Log_event::Byte* data_buf;
1328
const char* catalog;
1331
If we already know the length of the query string
1332
we pass it with q_len, so we would not have to call strlen()
1333
otherwise, set it to 0, in which case, we compute it with strlen()
1337
uint16_t error_code;
1340
For events created by Query_log_event::do_apply_event (and
1341
Load_log_event::do_apply_event()) we need the *original* thread
1342
id, to be able to log the event with the original (=master's)
1343
thread id (fix for BUG#1686).
1345
ulong slave_proxy_id;
1348
Binlog format 3 and 4 start to differ (as far as class members are
1349
concerned) from here.
1352
uint32_t catalog_len; // <= 255 char; 0 means uninited
1355
We want to be able to store a variable number of N-bit status vars:
1356
(generally N=32; but N=64 for SQL_MODE) a user may want to log the number
1357
of affected rows (for debugging) while another does not want to lose 4
1359
The storage on disk is the following:
1360
status_vars_len is part of the post-header,
1361
status_vars are in the variable-length part, after the post-header, before
1363
status_vars on disk is a sequence of pairs (code, value) where 'code' means
1364
'sql_mode', 'affected' etc. Sometimes 'value' must be a short string, so
1365
its first byte is its length. For now the order of status vars is:
1366
flags2 - sql_mode - catalog - autoinc - charset
1367
We should add the same thing to Load_log_event, but in fact
1368
LOAD DATA INFILE is going to be logged with a new type of event (logging of
1369
the plain text query), so Load_log_event would be frozen, so no need. The
1370
new way of logging LOAD DATA INFILE would use a derived class of
1371
Query_log_event, so automatically benefit from the work already done for
1372
status variables in Query_log_event.
1374
uint16_t status_vars_len;
1377
'flags2' is a second set of flags (on top of those in Log_event), for
1378
session variables. These are session->options which is & against a mask
1379
(OPTIONS_WRITTEN_TO_BIN_LOG).
1380
flags2_inited helps make a difference between flags2==0 (3.23 or 4.x
1381
master, we don't know flags2, so use the slave server's global options) and
1382
flags2==0 (5.0 master, we know this has a meaning of flags all down which
1383
must influence the query).
1386
bool sql_mode_inited;
1387
bool charset_inited;
1390
/* In connections sql_mode is 32 bits now but will be 64 bits soon */
1392
ulong auto_increment_increment, auto_increment_offset;
1394
uint32_t time_zone_len; /* 0 means uninited */
1395
const char *time_zone_str;
1396
uint32_t lc_time_names_number; /* 0 means en_US */
1397
uint32_t charset_database_number;
1400
Query_log_event(Session* session_arg, const char* query_arg, ulong query_length,
1401
bool using_trans, bool suppress_use,
1402
Session::killed_state killed_err_arg= Session::KILLED_NO_VALUE);
1403
const char* get_db() { return db; }
1404
void pack_info(Protocol* protocol);
1407
Query_log_event(const char* buf, uint32_t event_len,
1408
const Format_description_log_event *description_event,
1409
Log_event_type event_type);
1413
free((unsigned char*) data_buf);
1415
Log_event_type get_type_code() { return QUERY_EVENT; }
1416
bool write(IO_CACHE* file);
1417
virtual bool write_post_header_for_derived(IO_CACHE*)
1419
bool is_valid() const { return query != 0; }
1422
Returns number of bytes additionaly written to post header by derived
1423
events (so far it is only Execute_load_query event).
1425
virtual ulong get_post_header_size_for_derived() { return 0; }
1426
/* Writes derived event-specific part of post header. */
1428
public: /* !!! Public in this patch to allow old usage */
1429
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
1430
virtual int do_apply_event(Relay_log_info const *rli);
1431
virtual int do_update_pos(Relay_log_info *rli);
1433
int do_apply_event(Relay_log_info const *rli,
1434
const char *query_arg,
1435
uint32_t q_len_arg);
1440
@class Slave_log_event
1442
Note that this class is currently not used at all; no code writes a
1443
@c Slave_log_event (though some code in @c repl_failsafe.cc reads @c
1444
Slave_log_event). So it's not a problem if this code is not
1447
@section Slave_log_event_binary_format Binary Format
1449
This event type has no Post-Header. The Body has the following
1453
<caption>Body for Slave_log_event</caption>
1458
<th>Description</th>
1463
<td>8 byte integer</td>
1469
<td>master_port</td>
1470
<td>2 byte integer</td>
1475
<td>master_host</td>
1476
<td>null-terminated string</td>
1482
<td>null-terminated string</td>
1488
class Slave_log_event: public Log_event
1492
void init_from_mem_pool();
1495
std::string master_host;
1496
std::string master_log;
1497
uint16_t master_port;
1499
Slave_log_event(Session* session_arg, Relay_log_info* rli);
1500
void pack_info(Protocol* protocol);
1502
Slave_log_event(const char* buf, uint32_t event_len);
1504
int get_data_size();
1505
bool is_valid() const { return master_host.length() != 0; }
1506
Log_event_type get_type_code() { return SLAVE_EVENT; }
1507
bool write(IO_CACHE* file);
1510
virtual int do_apply_event(Relay_log_info const* rli);
1515
@class Load_log_event
1517
This log event corresponds to a "LOAD DATA INFILE" SQL query on the
1522
(2) LOAD DATA [LOCAL] INFILE 'file_name'
1523
(3) [REPLACE | IGNORE]
1524
(4) INTO Table 'table_name'
1526
(6) [TERMINATED BY 'field_term']
1527
(7) [[OPTIONALLY] ENCLOSED BY 'enclosed']
1528
(8) [ESCAPED BY 'escaped']
1531
(11) [TERMINATED BY 'line_term']
1532
(12) [LINES STARTING BY 'line_start']
1534
(14) [IGNORE skip_lines LINES]
1535
(15) (field_1, field_2, ..., field_n)@endverbatim
1537
@section Load_log_event_binary_format Binary Format
1539
The Post-Header consists of the following six components.
1542
<caption>Post-Header for Load_log_event</caption>
1547
<th>Description</th>
1551
<td>slave_proxy_id</td>
1552
<td>4 byte unsigned integer</td>
1553
<td>An integer identifying the client thread that issued the
1554
query. The id is unique per server. (Note, however, that two
1555
threads on different servers may have the same slave_proxy_id.)
1556
This is used when a client thread creates a temporary table local
1557
to the client. The slave_proxy_id is used to distinguish
1558
temporary tables that belong to different clients.
1564
<td>4 byte unsigned integer</td>
1565
<td>The time from when the query started to when it was logged in
1566
the binlog, in seconds.</td>
1571
<td>4 byte unsigned integer</td>
1572
<td>The number on line (14) above, if present, or 0 if line (14)
1578
<td>table_name_len</td>
1579
<td>1 byte unsigned integer</td>
1580
<td>The length of 'table_name' on line (4) above.</td>
1585
<td>1 byte unsigned integer</td>
1586
<td>The length of 'db' on line (1) above.</td>
1591
<td>4 byte unsigned integer</td>
1592
<td>The number n of fields on line (15) above.</td>
1596
The Body contains the following components.
1599
<caption>Body of Load_log_event</caption>
1604
<th>Description</th>
1609
<td>variable length</td>
1611
<td>Describes the part of the query on lines (3) and
1612
(5)–(13) above. More precisely, it stores the five strings
1613
(on lines) field_term (6), enclosed (7), escaped (8), line_term
1614
(11), and line_start (12); as well as a bitfield indicating the
1615
presence of the keywords REPLACE (3), IGNORE (3), and OPTIONALLY
1618
The data is stored in one of two formats, called "old" and "new".
1619
The type field of Common-Header determines which of these two
1620
formats is used: type LOAD_EVENT means that the old format is
1621
used, and type NEW_LOAD_EVENT means that the new format is used.
1622
When MySQL writes a Load_log_event, it uses the new format if at
1623
least one of the five strings is two or more bytes long.
1624
Otherwise (i.e., if all strings are 0 or 1 bytes long), the old
1627
The new and old format differ in the way the five strings are
1631
<li> In the new format, the strings are stored in the order
1632
field_term, enclosed, escaped, line_term, line_start. Each string
1633
consists of a length (1 byte), followed by a sequence of
1634
characters (0-255 bytes). Finally, a boolean combination of the
1635
following flags is stored in 1 byte: REPLACE_FLAG==0x4,
1636
IGNORE_FLAG==0x8, and OPT_ENCLOSED_FLAG==0x2. If a flag is set,
1637
it indicates the presence of the corresponding keyword in the SQL
1640
<li> In the old format, we know that each string has length 0 or
1641
1. Therefore, only the first byte of each string is stored. The
1642
order of the strings is the same as in the new format. These five
1643
bytes are followed by the same 1 byte bitfield as in the new
1644
format. Finally, a 1 byte bitfield called empty_flags is stored.
1645
The low 5 bits of empty_flags indicate which of the five strings
1646
have length 0. For each of the following flags that is set, the
1647
corresponding string has length 0; for the flags that are not set,
1648
the string has length 1: FIELD_TERM_EMPTY==0x1,
1649
ENCLOSED_EMPTY==0x2, LINE_TERM_EMPTY==0x4, LINE_START_EMPTY==0x8,
1650
ESCAPED_EMPTY==0x10.
1653
Thus, the size of the new format is 6 bytes + the sum of the sizes
1654
of the five strings. The size of the old format is always 7
1661
<td>num_fields 1 byte unsigned integers</td>
1662
<td>An array of num_fields integers representing the length of
1663
each field in the query. (num_fields is from the Post-Header).
1669
<td>num_fields null-terminated strings</td>
1670
<td>An array of num_fields null-terminated strings, each
1671
representing a field in the query. (The trailing zero is
1672
redundant, since the length are stored in the num_fields array.)
1673
The total length of all strings equals to the sum of all
1674
field_lens, plus num_fields bytes for all the trailing zeros.
1680
<td>null-terminated string of length table_len+1 bytes</td>
1681
<td>The 'table_name' from the query, as a null-terminated string.
1682
(The trailing zero is actually redundant since the table_len is
1683
known from Post-Header.)
1689
<td>null-terminated string of length db_len+1 bytes</td>
1690
<td>The 'db' from the query, as a null-terminated string.
1691
(The trailing zero is actually redundant since the db_len is known
1698
<td>variable length string without trailing zero, extending to the
1699
end of the event (determined by the length field of the
1702
<td>The 'file_name' from the query.
1708
@subsection Load_log_event_notes_on_previous_versions Notes on Previous Versions
1710
This event type is understood by current versions, but only
1711
generated by MySQL 3.23 and earlier.
1713
class Load_log_event: public Log_event
1716
uint32_t get_query_buffer_length();
1717
void print_query(bool need_db, char *buf, char **end,
1718
char **fn_start, char **fn_end);
1720
int copy_log_event(const char *buf, ulong event_len,
1722
const Format_description_log_event* description_event);
1726
ulong slave_proxy_id;
1727
uint32_t table_name_len;
1729
No need to have a catalog, as these events can only come from 4.x.
1730
TODO: this may become false if Dmitri pushes his new LOAD DATA INFILE in
1731
5.0 only (not in 4.x).
1735
uint32_t num_fields;
1737
const unsigned char* field_lens;
1738
uint32_t field_block_len;
1740
const char* table_name;
1743
uint32_t skip_lines;
1747
/* fname doesn't point to memory inside Log_event::temp_buf */
1748
void set_fname_outside_temp_buf(const char *afname, uint32_t alen)
1754
/* fname doesn't point to memory inside Log_event::temp_buf */
1755
int check_fname_outside_temp_buf()
1760
String field_lens_buf;
1763
Load_log_event(Session* session, sql_exchange* ex, const char* db_arg,
1764
const char* table_name_arg,
1765
List<Item>& fields_arg, enum enum_duplicates handle_dup, bool ignore,
1767
void set_fields(const char* db, List<Item> &fields_arg,
1768
Name_resolution_context *context);
1769
const char* get_db() { return db; }
1770
void pack_info(Protocol* protocol);
1773
Note that for all the events related to LOAD DATA (Load_log_event,
1774
Create_file/Append/Exec/Delete, we pass description_event; however as
1775
logging of LOAD DATA is going to be changed in 4.1 or 5.0, this is only used
1776
for the common_header_len (post_header_len will not be changed).
1778
Load_log_event(const char* buf, uint32_t event_len,
1779
const Format_description_log_event* description_event);
1782
Log_event_type get_type_code()
1784
return sql_ex.new_format() ? NEW_LOAD_EVENT: LOAD_EVENT;
1786
bool write_data_header(IO_CACHE* file);
1787
bool write_data_body(IO_CACHE* file);
1788
bool is_valid() const { return table_name != 0; }
1791
return (table_name_len + db_len + 2 + fname_len
1793
+ sql_ex.data_size() + field_block_len + num_fields);
1796
public: /* !!! Public in this patch to allow old usage */
1797
virtual int do_apply_event(Relay_log_info const* rli)
1799
return do_apply_event(session->slave_net,rli,0);
1802
int do_apply_event(NET *net, Relay_log_info const *rli,
1803
bool use_rli_only_for_errors);
1806
extern char server_version[SERVER_VERSION_LENGTH];
1809
@class Start_log_event_v3
1811
Start_log_event_v3 is the Start_log_event of binlog format 3 (MySQL 3.23 and
1814
Format_description_log_event derives from Start_log_event_v3; it is
1815
the Start_log_event of binlog format 4 (MySQL 5.0), that is, the
1816
event that describes the other events' Common-Header/Post-Header
1817
lengths. This event is sent by MySQL 5.0 whenever it starts sending
1818
a new binlog if the requested position is >4 (otherwise if ==4 the
1819
event will be sent naturally).
1821
@section Start_log_event_v3_binary_format Binary Format
1823
class Start_log_event_v3: public Log_event
1827
If this event is at the start of the first binary log since server
1828
startup 'created' should be the timestamp when the event (and the
1829
binary log) was created. In the other case (i.e. this event is at
1830
the start of a binary log created by FLUSH LOGS or automatic
1831
rotation), 'created' should be 0. This "trick" is used by MySQL
1832
>=4.0.14 slaves to know whether they must drop stale temporary
1833
tables and whether they should abort unfinished transaction.
1835
Note that when 'created'!=0, it is always equal to the event's
1836
timestamp; indeed Start_log_event is written only in log.cc where
1837
the first constructor below is called, in which 'created' is set
1838
to 'when'. So in fact 'created' is a useless variable. When it is
1839
0 we can read the actual value from timestamp ('when') and when it
1840
is non-zero we can read the same value from timestamp
1841
('when'). Conclusion:
1842
- we use timestamp to print when the binlog was created.
1843
- we use 'created' only to know if this is a first binlog or not.
1844
In 3.23.57 we did not pay attention to this identity, so mysqlbinlog in
1845
3.23.57 does not print 'created the_date' if created was zero. This is now
1849
uint16_t binlog_version;
1850
char server_version[ST_SERVER_VER_LEN];
1852
artifical_event is 1 in the case where this is a generated event that
1853
should not case any cleanup actions. We handle this in the log by
1854
setting log_event == 0 (for now).
1856
bool artificial_event;
1858
We set this to 1 if we don't want to have the created time in the log,
1859
which is the case when we rollover to a new log.
1861
bool dont_set_created;
1863
Start_log_event_v3();
1864
void pack_info(Protocol* protocol);
1866
Start_log_event_v3(const char* buf,
1867
const Format_description_log_event* description_event);
1868
~Start_log_event_v3() {}
1869
Log_event_type get_type_code() { return START_EVENT_V3;}
1870
bool write(IO_CACHE* file);
1871
bool is_valid() const { return 1; }
1874
return START_V3_HEADER_LEN; //no variable-sized part
1876
virtual bool is_artificial_event() { return artificial_event; }
1879
virtual int do_apply_event(Relay_log_info const *rli);
1880
virtual enum_skip_reason do_shall_skip(Relay_log_info*)
1883
Events from ourself should be skipped, but they should not
1884
decrease the slave skip counter.
1886
if (this->server_id == ::server_id)
1887
return Log_event::EVENT_SKIP_IGNORE;
1889
return Log_event::EVENT_SKIP_NOT;
1895
@class Format_description_log_event
1897
For binlog version 4.
1898
This event is saved by threads which read it, as they need it for future
1899
use (to decode the ordinary events).
1901
@section Format_description_log_event_binary_format Binary Format
1904
class Format_description_log_event: public Start_log_event_v3
1908
The size of the fixed header which _all_ events have
1909
(for binlogs written by this version, this is equal to
1910
LOG_EVENT_HEADER_LEN), except FORMAT_DESCRIPTION_EVENT and ROTATE_EVENT
1911
(those have a header of size LOG_EVENT_MINIMAL_HEADER_LEN).
1913
uint8_t common_header_len;
1914
uint8_t number_of_event_types;
1915
/* The list of post-headers' lengthes */
1916
uint8_t *post_header_len;
1917
unsigned char server_version_split[3];
1918
const uint8_t *event_type_permutation;
1920
Format_description_log_event(uint8_t binlog_ver, const char* server_ver=0);
1921
Format_description_log_event(const char* buf, uint32_t event_len,
1922
const Format_description_log_event
1923
*description_event);
1924
~Format_description_log_event()
1926
free((unsigned char*)post_header_len);
1928
Log_event_type get_type_code() { return FORMAT_DESCRIPTION_EVENT;}
1929
bool write(IO_CACHE* file);
1930
bool is_valid() const
1932
return ((common_header_len >= ((binlog_version==1) ? OLD_HEADER_LEN :
1933
LOG_EVENT_MINIMAL_HEADER_LEN)) &&
1934
(post_header_len != NULL));
1939
The vector of post-header lengths is considered as part of the
1940
post-header, because in a given version it never changes (contrary to the
1941
query in a Query_log_event).
1943
return FORMAT_DESCRIPTION_HEADER_LEN;
1946
void calc_server_version_split();
1949
virtual int do_apply_event(Relay_log_info const *rli);
1950
virtual int do_update_pos(Relay_log_info *rli);
1951
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
1955
@class Xid_log_event
1957
Logs xid of the transaction-to-be-committed in the 2pc protocol.
1958
Has no meaning in replication, slaves ignore it.
1960
@section Xid_log_event_binary_format Binary Format
1962
class Xid_log_event: public Log_event
1967
Xid_log_event(Session* session_arg, my_xid x): Log_event(session_arg,0,0), xid(x) {}
1968
void pack_info(Protocol* protocol);
1970
Xid_log_event(const char* buf,
1971
const Format_description_log_event *description_event);
1973
Log_event_type get_type_code() { return XID_EVENT;}
1974
int get_data_size() { return sizeof(xid); }
1975
bool write(IO_CACHE* file);
1976
bool is_valid() const { return 1; }
1979
virtual int do_apply_event(Relay_log_info const *rli);
1980
enum_skip_reason do_shall_skip(Relay_log_info *rli);
1985
@class Stop_log_event
1987
@section Stop_log_event_binary_format Binary Format
1989
The Post-Header and Body for this event type are empty; it only has
1992
class Stop_log_event: public Log_event
1995
Stop_log_event() :Log_event()
1998
Stop_log_event(const char* buf,
1999
const Format_description_log_event *description_event):
2000
Log_event(buf, description_event)
2002
~Stop_log_event() {}
2003
Log_event_type get_type_code() { return STOP_EVENT;}
2004
bool is_valid() const { return 1; }
2007
virtual int do_update_pos(Relay_log_info *rli);
2008
virtual enum_skip_reason do_shall_skip(Relay_log_info *)
2011
Events from ourself should be skipped, but they should not
2012
decrease the slave skip counter.
2014
if (this->server_id == ::server_id)
2015
return Log_event::EVENT_SKIP_IGNORE;
2017
return Log_event::EVENT_SKIP_NOT;
2022
@class Rotate_log_event
2024
This will be deprecated when we move to using sequence ids.
2026
@section Rotate_log_event_binary_format Binary Format
2028
The Post-Header has one component:
2031
<caption>Post-Header for Rotate_log_event</caption>
2036
<th>Description</th>
2041
<td>8 byte integer</td>
2042
<td>The position within the binlog to rotate to.</td>
2047
The Body has one component:
2050
<caption>Body for Rotate_log_event</caption>
2055
<th>Description</th>
2060
<td>variable length string without trailing zero, extending to the
2061
end of the event (determined by the length field of the
2064
<td>Name of the binlog to rotate to.</td>
2070
class Rotate_log_event: public Log_event
2074
DUP_NAME= 2 // if constructor should dup the string argument
2076
std::string new_log_ident;
2080
Rotate_log_event(const char* new_log_ident_arg,
2081
uint32_t ident_len_arg,
2082
uint64_t pos_arg, uint32_t flags);
2083
void pack_info(Protocol* protocol);
2085
Rotate_log_event(const char* buf, uint32_t event_len,
2086
const Format_description_log_event* description_event);
2087
Log_event_type get_type_code() { return ROTATE_EVENT;}
2088
int get_data_size() { return ident_len + ROTATE_HEADER_LEN;}
2089
bool is_valid() const { return new_log_ident.size() != 0; }
2090
bool write(IO_CACHE* file);
2093
virtual int do_update_pos(Relay_log_info *rli);
2094
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2098
/* the classes below are for the new LOAD DATA INFILE logging */
2101
@class Create_file_log_event
2103
@section Create_file_log_event_binary_format Binary Format
2106
class Create_file_log_event: public Load_log_event
2110
Pretend we are Load event, so we can write out just
2111
our Load part - used on the slave when writing event out to
2112
SQL_LOAD-*.info file
2116
unsigned char* block;
2117
const char *event_buf;
2120
bool inited_from_old;
2122
Create_file_log_event(Session* session, sql_exchange* ex, const char* db_arg,
2123
const char* table_name_arg,
2124
List<Item>& fields_arg,
2125
enum enum_duplicates handle_dup, bool ignore,
2126
unsigned char* block_arg, uint32_t block_len_arg,
2128
void pack_info(Protocol* protocol);
2130
Create_file_log_event(const char* buf, uint32_t event_len,
2131
const Format_description_log_event* description_event);
2132
~Create_file_log_event()
2134
free((char*) event_buf);
2137
Log_event_type get_type_code()
2139
return fake_base ? Load_log_event::get_type_code() : CREATE_FILE_EVENT;
2143
return (fake_base ? Load_log_event::get_data_size() :
2144
Load_log_event::get_data_size() +
2147
bool is_valid() const { return inited_from_old || block != 0; }
2148
bool write_data_header(IO_CACHE* file);
2149
bool write_data_body(IO_CACHE* file);
2151
Cut out Create_file extentions and
2152
write it as Load event - used on the slave
2154
bool write_base(IO_CACHE* file);
2157
virtual int do_apply_event(Relay_log_info const *rli);
2162
@class Append_block_log_event
2164
@section Append_block_log_event_binary_format Binary Format
2167
class Append_block_log_event: public Log_event
2170
unsigned char* block;
2174
'db' is filled when the event is created in mysql_load() (the
2175
event needs to have a 'db' member to be well filtered by
2176
binlog-*-db rules). 'db' is not written to the binlog (it's not
2177
used by Append_block_log_event::write()), so it can't be read in
2178
the Append_block_log_event(const char* buf, int event_len)
2179
constructor. In other words, 'db' is used only for filtering by
2180
binlog-*-db rules. Create_file_log_event is different: it's 'db'
2181
(which is inherited from Load_log_event) is written to the binlog
2186
Append_block_log_event(Session* session, const char* db_arg, unsigned char* block_arg,
2187
uint32_t block_len_arg, bool using_trans);
2188
void pack_info(Protocol* protocol);
2189
virtual int get_create_or_append() const;
2191
Append_block_log_event(const char* buf, uint32_t event_len,
2192
const Format_description_log_event
2193
*description_event);
2194
~Append_block_log_event() {}
2195
Log_event_type get_type_code() { return APPEND_BLOCK_EVENT;}
2196
int get_data_size() { return block_len + APPEND_BLOCK_HEADER_LEN ;}
2197
bool is_valid() const { return block != 0; }
2198
bool write(IO_CACHE* file);
2199
const char* get_db() { return db; }
2202
virtual int do_apply_event(Relay_log_info const *rli);
2207
@class Delete_file_log_event
2209
@section Delete_file_log_event_binary_format Binary Format
2212
class Delete_file_log_event: public Log_event
2216
const char* db; /* see comment in Append_block_log_event */
2218
Delete_file_log_event(Session* session, const char* db_arg, bool using_trans);
2219
void pack_info(Protocol* protocol);
2221
Delete_file_log_event(const char* buf, uint32_t event_len,
2222
const Format_description_log_event* description_event);
2223
~Delete_file_log_event() {}
2224
Log_event_type get_type_code() { return DELETE_FILE_EVENT;}
2225
int get_data_size() { return DELETE_FILE_HEADER_LEN ;}
2226
bool is_valid() const { return file_id != 0; }
2227
bool write(IO_CACHE* file);
2228
const char* get_db() { return db; }
2231
virtual int do_apply_event(Relay_log_info const *rli);
2236
@class Execute_load_log_event
2238
@section Delete_file_log_event_binary_format Binary Format
2241
class Execute_load_log_event: public Log_event
2245
const char* db; /* see comment in Append_block_log_event */
2247
Execute_load_log_event(Session* session, const char* db_arg, bool using_trans);
2248
void pack_info(Protocol* protocol);
2250
Execute_load_log_event(const char* buf, uint32_t event_len,
2251
const Format_description_log_event
2252
*description_event);
2253
~Execute_load_log_event() {}
2254
Log_event_type get_type_code() { return EXEC_LOAD_EVENT;}
2255
int get_data_size() { return EXEC_LOAD_HEADER_LEN ;}
2256
bool is_valid() const { return file_id != 0; }
2257
bool write(IO_CACHE* file);
2258
const char* get_db() { return db; }
2261
virtual int do_apply_event(Relay_log_info const *rli);
2266
@class Begin_load_query_log_event
2268
Event for the first block of file to be loaded, its only difference from
2269
Append_block event is that this event creates or truncates existing file
2270
before writing data.
2272
@section Begin_load_query_log_event_binary_format Binary Format
2274
class Begin_load_query_log_event: public Append_block_log_event
2277
Begin_load_query_log_event(Session* session_arg, const char *db_arg,
2278
unsigned char* block_arg, uint32_t block_len_arg,
2280
Begin_load_query_log_event(Session* session);
2281
int get_create_or_append() const;
2282
Begin_load_query_log_event(const char* buf, uint32_t event_len,
2283
const Format_description_log_event
2284
*description_event);
2285
~Begin_load_query_log_event() {}
2286
Log_event_type get_type_code() { return BEGIN_LOAD_QUERY_EVENT; }
2288
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2293
Elements of this enum describe how LOAD DATA handles duplicates.
2295
enum enum_load_dup_handling { LOAD_DUP_ERROR= 0, LOAD_DUP_IGNORE,
2299
@class Execute_load_query_log_event
2301
Event responsible for LOAD DATA execution, it similar to Query_log_event
2302
but before executing the query it substitutes original filename in LOAD DATA
2303
query with name of temporary file.
2305
@section Execute_load_query_log_event_binary_format Binary Format
2307
class Execute_load_query_log_event: public Query_log_event
2310
uint32_t file_id; // file_id of temporary file
2311
uint32_t fn_pos_start; // pointer to the part of the query that should
2313
uint32_t fn_pos_end; // pointer to the end of this part of query
2315
We have to store type of duplicate handling explicitly, because
2316
for LOAD DATA it also depends on LOCAL option. And this part
2317
of query will be rewritten during replication so this information
2320
enum_load_dup_handling dup_handling;
2322
Execute_load_query_log_event(Session* session, const char* query_arg,
2323
ulong query_length, uint32_t fn_pos_start_arg,
2324
uint32_t fn_pos_end_arg,
2325
enum_load_dup_handling dup_handling_arg,
2326
bool using_trans, bool suppress_use,
2327
Session::killed_state
2328
killed_err_arg= Session::KILLED_NO_VALUE);
2329
void pack_info(Protocol* protocol);
2330
Execute_load_query_log_event(const char* buf, uint32_t event_len,
2331
const Format_description_log_event
2332
*description_event);
2333
~Execute_load_query_log_event() {}
2335
Log_event_type get_type_code() { return EXECUTE_LOAD_QUERY_EVENT; }
2336
bool is_valid() const { return Query_log_event::is_valid() && file_id != 0; }
2338
ulong get_post_header_size_for_derived();
2339
bool write_post_header_for_derived(IO_CACHE* file);
2342
virtual int do_apply_event(Relay_log_info const *rli);
2346
char *str_to_hex(char *to, const char *from, uint32_t len);
2349
@class Table_map_log_event
2351
In row-based mode, every row operation event is preceded by a
2352
Table_map_log_event which maps a table definition to a number. The
2353
table definition consists of database name, table name, and column
2356
@section Table_map_log_event_binary_format Binary Format
2358
The Post-Header has the following components:
2361
<caption>Post-Header for Table_map_log_event</caption>
2366
<th>Description</th>
2371
<td>6 bytes unsigned integer</td>
2372
<td>The number that identifies the table.</td>
2377
<td>2 byte bitfield</td>
2378
<td>Reserved for future use; currently always 0.</td>
2383
The Body has the following components:
2386
<caption>Body for Table_map_log_event</caption>
2391
<th>Description</th>
2395
<td>database_name</td>
2396
<td>one byte string length, followed by null-terminated string</td>
2397
<td>The name of the database in which the table resides. The name
2398
is represented as a one byte unsigned integer representing the
2399
number of bytes in the name, followed by length bytes containing
2400
the database name, followed by a terminating 0 byte. (Note the
2401
redundancy in the representation of the length.) </td>
2406
<td>one byte string length, followed by null-terminated string</td>
2407
<td>The name of the table, encoded the same way as the database
2412
<td>column_count</td>
2413
<td>@ref packed_integer "Packed Integer"</td>
2414
<td>The number of columns in the table, represented as a packed
2415
variable-length integer.</td>
2419
<td>column_type</td>
2420
<td>List of column_count 1 byte enumeration values</td>
2421
<td>The type of each column in the table, listed from left to
2422
right. Each byte is mapped to a column type according to the
2423
enumeration type enum_field_types defined in mysql_com.h. The
2424
mapping of types to numbers is listed in the table @ref
2425
Table_table_map_log_event_column_types "below" (along with
2426
description of the associated metadata field). </td>
2430
<td>metadata_length</td>
2431
<td>@ref packed_integer "Packed Integer"</td>
2432
<td>The length of the following metadata block</td>
2437
<td>list of metadata for each column</td>
2438
<td>For each column from left to right, a chunk of data who's
2439
length and semantics depends on the type of the column. The
2440
length and semantics for the metadata for each column are listed
2441
in the table @ref Table_table_map_log_event_column_types
2447
<td>column_count bits, rounded up to nearest byte</td>
2448
<td>For each column, a bit indicating whether data in the column
2449
can be NULL or not. The number of bytes needed for this is
2450
int((column_count+7)/8). The flag for the first column from the
2451
left is in the least-significant bit of the first byte, the second
2452
is in the second least significant bit of the first byte, the
2453
ninth is in the least significant bit of the second byte, and so
2459
The table below lists all column types, along with the numerical
2460
identifier for it and the size and interpretation of meta-data used
2461
to describe the type.
2463
@anchor Table_table_map_log_event_column_types
2465
<caption>Table_map_log_event column types: numerical identifier and
2470
<th>Size of metadata in bytes</th>
2471
<th>Description of metadata</th>
2475
<td>DRIZZLE_TYPE_TINY</td><td>1</td>
2477
<td>No column metadata.</td>
2481
<td>DRIZZLE_TYPE_SHORT</td><td>2</td>
2483
<td>No column metadata.</td>
2487
<td>DRIZZLE_TYPE_LONG</td><td>3</td>
2489
<td>No column metadata.</td>
2493
<td>DRIZZLE_TYPE_DOUBLE</td><td>5</td>
2495
<td>1 byte unsigned integer, representing the "pack_length", which
2496
is equal to sizeof(double) on the server from which the event
2501
<td>DRIZZLE_TYPE_NULL</td><td>6</td>
2503
<td>No column metadata.</td>
2507
<td>DRIZZLE_TYPE_TIMESTAMP</td><td>7</td>
2509
<td>No column metadata.</td>
2513
<td>DRIZZLE_TYPE_LONGLONG</td><td>8</td>
2515
<td>No column metadata.</td>
2519
<td>DRIZZLE_TYPE_DATE</td><td>10</td>
2521
<td>No column metadata.</td>
2525
<td>DRIZZLE_TYPE_TIME</td><td>11</td>
2527
<td>No column metadata.</td>
2531
<td>DRIZZLE_TYPE_DATETIME</td><td>12</td>
2533
<td>No column metadata.</td>
2537
<td>DRIZZLE_TYPE_YEAR</td><td>13</td>
2539
<td>No column metadata.</td>
2543
<td><i>DRIZZLE_TYPE_DATE</i></td><td><i>14</i></td>
2545
<td><i>This enumeration value is only used internally and cannot
2546
exist in a binlog.</i></td>
2550
<td>DRIZZLE_TYPE_VARCHAR</td><td>15</td>
2552
<td>2 byte unsigned integer representing the maximum length of
2557
<td>DRIZZLE_TYPE_NEWDECIMAL</td><td>246</td>
2559
<td>A 1 byte unsigned int representing the precision, followed
2560
by a 1 byte unsigned int representing the number of decimals.</td>
2564
<td><i>DRIZZLE_TYPE_ENUM</i></td><td><i>247</i></td>
2566
<td><i>This enumeration value is only used internally and cannot
2567
exist in a binlog.</i></td>
2571
<td><i>DRIZZLE_TYPE_SET</i></td><td><i>248</i></td>
2573
<td><i>This enumeration value is only used internally and cannot
2574
exist in a binlog.</i></td>
2578
<td>DRIZZLE_TYPE_BLOB</td><td>252</td>
2580
<td>The pack length, i.e., the number of bytes needed to represent
2581
the length of the blob: 1, 2, 3, or 4.</td>
2585
<td>DRIZZLE_TYPE_STRING</td><td>254</td>
2587
<td>The first byte is always DRIZZLE_TYPE_VAR_STRING (i.e., 253).
2588
The second byte is the field size, i.e., the number of bytes in
2589
the representation of size of the string: 3 or 4.</td>
2594
class Table_map_log_event : public Log_event
2600
TYPE_CODE = TABLE_MAP_EVENT
2604
Enumeration of the errors that can be returned.
2608
ERR_OPEN_FAILURE = -1, /**< Failure to open table */
2609
ERR_OK = 0, /**< No error */
2610
ERR_TABLE_LIMIT_EXCEEDED = 1, /**< No more room for tables */
2611
ERR_OUT_OF_MEM = 2, /**< Out of memory */
2612
ERR_BAD_TABLE_DEF = 3, /**< Table definition does not match */
2613
ERR_RBR_TO_SBR = 4 /**< daisy-chanining RBR to SBR not allowed */
2619
Nothing here right now, but the flags support is there in
2620
preparation for changes that are coming. Need to add a
2621
constant to make it compile under HP-UX: aCC does not like
2627
typedef uint16_t flag_set;
2629
/* Special constants representing sets of flags */
2635
void set_flags(flag_set flag) { m_flags |= flag; }
2636
void clear_flags(flag_set flag) { m_flags &= ~flag; }
2637
flag_set get_flags(flag_set flag) const { return m_flags & flag; }
2639
Table_map_log_event(Session *session, Table *tbl, ulong tid,
2640
bool is_transactional, uint16_t flags);
2641
Table_map_log_event(const char *buf, uint32_t event_len,
2642
const Format_description_log_event *description_event);
2644
~Table_map_log_event();
2646
virtual Log_event_type get_type_code() { return TABLE_MAP_EVENT; }
2647
virtual bool is_valid() const { return m_memory != NULL; /* we check malloc */ }
2649
virtual int get_data_size() { return m_data_size; }
2650
virtual int save_field_metadata();
2651
virtual bool write_data_header(IO_CACHE *file);
2652
virtual bool write_data_body(IO_CACHE *file);
2653
virtual const char *get_db() { return m_dbnam; }
2654
virtual void pack_info(Protocol *protocol);
2657
virtual int do_apply_event(Relay_log_info const *rli);
2658
virtual int do_update_pos(Relay_log_info *rli);
2659
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2662
char const *m_dbnam;
2664
char const *m_tblnam;
2667
unsigned char *m_coltype;
2669
unsigned char *m_memory;
2675
unsigned char *m_field_metadata; // buffer for field metadata
2677
The size of field metadata buffer set by calling save_field_metadata()
2679
ulong m_field_metadata_size;
2680
unsigned char *m_null_bits;
2681
unsigned char *m_meta_memory;
2686
@class Rows_log_event
2688
Common base class for all row-containing log events.
2692
Encode the common parts of all events containing rows, which are:
2693
- Write data header and data body to an IO_CACHE.
2694
- Provide an interface for adding an individual row to the event.
2696
@section Rows_log_event_binary_format Binary Format
2700
class Rows_log_event : public Log_event
2704
Enumeration of the errors that can be returned.
2708
ERR_OPEN_FAILURE = -1, /**< Failure to open table */
2709
ERR_OK = 0, /**< No error */
2710
ERR_TABLE_LIMIT_EXCEEDED = 1, /**< No more room for tables */
2711
ERR_OUT_OF_MEM = 2, /**< Out of memory */
2712
ERR_BAD_TABLE_DEF = 3, /**< Table definition does not match */
2713
ERR_RBR_TO_SBR = 4 /**< daisy-chanining RBR to SBR not allowed */
2717
These definitions allow you to combine the flags into an
2718
appropriate flag set using the normal bitwise operators. The
2719
implicit conversion from an enum-constant to an integer is
2720
accepted by the compiler, which is then used to set the real set
2725
/* Last event of a statement */
2726
STMT_END_F = (1U << 0),
2728
/* Value of the OPTION_NO_FOREIGN_KEY_CHECKS flag in session->options */
2729
NO_FOREIGN_KEY_CHECKS_F = (1U << 1),
2731
/* Value of the OPTION_RELAXED_UNIQUE_CHECKS flag in session->options */
2732
RELAXED_UNIQUE_CHECKS_F = (1U << 2),
2735
Indicates that rows in this event are complete, that is contain
2736
values for all columns of the table.
2738
COMPLETE_ROWS_F = (1U << 3)
2741
typedef uint16_t flag_set;
2743
/* Special constants representing sets of flags */
2749
virtual ~Rows_log_event();
2751
void set_flags(flag_set flags_arg) { m_flags |= flags_arg; }
2752
void clear_flags(flag_set flags_arg) { m_flags &= ~flags_arg; }
2753
flag_set get_flags(flag_set flags_arg) const { return m_flags & flags_arg; }
2755
virtual void pack_info(Protocol *protocol);
2757
int add_row_data(unsigned char *data, size_t length)
2759
return do_add_row_data(data,length);
2762
/* Member functions to implement superclass interface */
2763
virtual int get_data_size();
2765
MY_BITMAP const *get_cols() const { return &m_cols; }
2766
size_t get_width() const { return m_width; }
2767
ulong get_table_id() const { return m_table_id; }
2769
virtual bool write_data_header(IO_CACHE *file);
2770
virtual bool write_data_body(IO_CACHE *file);
2771
virtual const char *get_db() { return m_table->s->db.str; }
2773
Check that malloc() succeeded in allocating memory for the rows
2774
buffer and the COLS vector. Checking that an Update_rows_log_event
2775
is valid is done in the Update_rows_log_event::is_valid()
2778
virtual bool is_valid() const
2780
return m_rows_buf && m_cols.bitmap;
2783
uint32_t m_row_count; /* The number of rows added to the event */
2787
The constructors are protected since you're supposed to inherit
2788
this class, not create instances of this class.
2790
Rows_log_event(Session*, Table*, ulong table_id,
2791
MY_BITMAP const *cols, bool is_transactional);
2792
Rows_log_event(const char *row_data, uint32_t event_len,
2793
Log_event_type event_type,
2794
const Format_description_log_event *description_event);
2796
virtual int do_add_row_data(unsigned char *data, size_t length);
2798
Table *m_table; /* The table the rows belong to */
2799
ulong m_table_id; /* Table ID */
2800
MY_BITMAP m_cols; /* Bitmap denoting columns available */
2801
ulong m_width; /* The width of the columns bitmap */
2803
Bitmap for columns available in the after image, if present. These
2804
fields are only available for Update_rows events. Observe that the
2805
width of both the before image COLS vector and the after image
2806
COLS vector is the same: the number of columns of the table on the
2809
MY_BITMAP m_cols_ai;
2811
ulong m_master_reclength; /* Length of record on master side */
2813
/* Bit buffers in the same memory as the class */
2814
uint32_t m_bitbuf[128/(sizeof(uint32_t)*8)];
2815
uint32_t m_bitbuf_ai[128/(sizeof(uint32_t)*8)];
2817
unsigned char *m_rows_buf; /* The rows in packed format */
2818
unsigned char *m_rows_cur; /* One-after the end of the data */
2819
unsigned char *m_rows_end; /* One-after the end of the allocated space */
2821
flag_set m_flags; /* Flags for row-level events */
2823
/* helper functions */
2825
const unsigned char *m_curr_row; /* Start of the row being processed */
2826
const unsigned char *m_curr_row_end; /* One-after the end of the current row */
2827
unsigned char *m_key; /* Buffer to keep key value during searches */
2829
int find_row(const Relay_log_info *const);
2830
int write_row(const Relay_log_info *const, const bool);
2832
// Unpack the current row into m_table->record[0]
2833
int unpack_current_row(const Relay_log_info *const rli,
2834
MY_BITMAP const *cols);
2838
virtual int do_apply_event(Relay_log_info const *rli);
2839
virtual int do_update_pos(Relay_log_info *rli);
2840
virtual enum_skip_reason do_shall_skip(Relay_log_info *rli);
2843
Primitive to prepare for a sequence of row executions.
2847
Before doing a sequence of do_prepare_row() and do_exec_row()
2848
calls, this member function should be called to prepare for the
2849
entire sequence. Typically, this member function will allocate
2850
space for any buffers that are needed for the two member
2851
functions mentioned above.
2855
The member function will return 0 if all went OK, or a non-zero
2856
error code otherwise.
2859
int do_before_row_operations(const Slave_reporting_capability *const log) = 0;
2862
Primitive to clean up after a sequence of row executions.
2866
After doing a sequence of do_prepare_row() and do_exec_row(),
2867
this member function should be called to clean up and release
2868
any allocated buffers.
2870
The error argument, if non-zero, indicates an error which happened during
2871
row processing before this function was called. In this case, even if
2872
function is successful, it should return the error code given in the argument.
2875
int do_after_row_operations(const Slave_reporting_capability *const log,
2879
Primitive to do the actual execution necessary for a row.
2882
The member function will do the actual execution needed to handle a row.
2883
The row is located at m_curr_row. When the function returns,
2884
m_curr_row_end should point at the next row (one byte after the end
2885
of the current row).
2888
0 if execution succeeded, 1 if execution failed.
2891
virtual int do_exec_row(const Relay_log_info *const rli) = 0;
2893
friend class Old_rows_log_event;
2897
@class Write_rows_log_event
2899
Log row insertions and updates. The event contain several
2900
insert/update rows for a table. Note that each event contains only
2903
@section Write_rows_log_event_binary_format Binary Format
2905
class Write_rows_log_event : public Rows_log_event
2910
/* Support interface to Session::binlog_prepare_pending_rows_event */
2911
TYPE_CODE = WRITE_ROWS_EVENT
2914
Write_rows_log_event(Session*, Table*, ulong table_id,
2915
bool is_transactional);
2916
Write_rows_log_event(const char *buf, uint32_t event_len,
2917
const Format_description_log_event *description_event);
2920
virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }
2922
virtual int do_before_row_operations(const Slave_reporting_capability *const);
2923
virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
2924
virtual int do_exec_row(const Relay_log_info *const);
2929
@class Update_rows_log_event
2931
Log row updates with a before image. The event contain several
2932
update rows for a table. Note that each event contains only rows for
2935
Also note that the row data consists of pairs of row data: one row
2936
for the old data and one row for the new data.
2938
@section Update_rows_log_event_binary_format Binary Format
2940
class Update_rows_log_event : public Rows_log_event
2945
/* Support interface to Session::binlog_prepare_pending_rows_event */
2946
TYPE_CODE = UPDATE_ROWS_EVENT
2949
Update_rows_log_event(Session*, Table*, ulong table_id,
2950
bool is_transactional);
2952
void init(MY_BITMAP const *cols);
2954
virtual ~Update_rows_log_event();
2956
Update_rows_log_event(const char *buf, uint32_t event_len,
2957
const Format_description_log_event *description_event);
2959
virtual bool is_valid() const
2961
return Rows_log_event::is_valid() && m_cols_ai.bitmap;
2965
virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }
2967
virtual int do_before_row_operations(const Slave_reporting_capability *const);
2968
virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
2969
virtual int do_exec_row(const Relay_log_info *const);
2973
@class Delete_rows_log_event
2975
Log row deletions. The event contain several delete rows for a
2976
table. Note that each event contains only rows for one table.
2980
- Act as a container for rows that has been deleted on the master
2981
and should be deleted on the slave.
2986
Create the event and add rows to the event.
2988
Extract the rows from the event.
2990
@section Delete_rows_log_event_binary_format Binary Format
2992
class Delete_rows_log_event : public Rows_log_event
2997
/* Support interface to Session::binlog_prepare_pending_rows_event */
2998
TYPE_CODE = DELETE_ROWS_EVENT
3001
Delete_rows_log_event(Session*, Table*, ulong,
3002
bool is_transactional);
3003
Delete_rows_log_event(const char *buf, uint32_t event_len,
3004
const Format_description_log_event *description_event);
3006
virtual Log_event_type get_type_code() { return (Log_event_type)TYPE_CODE; }
3008
virtual int do_before_row_operations(const Slave_reporting_capability *const);
3009
virtual int do_after_row_operations(const Slave_reporting_capability *const,int);
3010
virtual int do_exec_row(const Relay_log_info *const);
3015
@class Incident_log_event
3017
Class representing an incident, an occurance out of the ordinary,
3018
that happened on the master.
3020
The event is used to inform the slave that something out of the
3021
ordinary happened on the master that might cause the database to be
3022
in an inconsistent state.
3024
<table id="IncidentFormat">
3025
<caption>Incident event format</caption>
3029
<th>Description</th>
3033
<td align="right">2</td>
3034
<td>Incident number as an unsigned integer</td>
3038
<td align="right">1</td>
3039
<td>Message length as an unsigned integer</td>
3043
<td align="right">MSGLEN</td>
3044
<td>The message, if present. Not null terminated.</td>
3048
@section Delete_rows_log_event_binary_format Binary Format
3050
class Incident_log_event : public Log_event {
3052
Incident_log_event(Session *session_arg, Incident incident)
3053
: Log_event(session_arg, 0, false), m_incident(incident)
3055
m_message.str= NULL; /* Just as a precaution */
3056
m_message.length= 0;
3060
Incident_log_event(Session *session_arg, Incident incident, LEX_STRING const msg)
3061
: Log_event(session_arg, 0, false), m_incident(incident)
3067
void pack_info(Protocol*);
3069
Incident_log_event(const char *buf, uint32_t event_len,
3070
const Format_description_log_event *descr_event);
3072
virtual ~Incident_log_event();
3074
virtual int do_apply_event(Relay_log_info const *rli);
3076
virtual bool write_data_header(IO_CACHE *file);
3077
virtual bool write_data_body(IO_CACHE *file);
3079
virtual Log_event_type get_type_code() { return INCIDENT_EVENT; }
3081
virtual bool is_valid() const { return 1; }
3082
virtual int get_data_size() {
3083
return INCIDENT_HEADER_LEN + 1 + m_message.length;
3087
const char *description() const;
3089
Incident m_incident;
3090
LEX_STRING m_message;
3093
int append_query_string(const CHARSET_INFO * const csinfo,
3094
String const *from, String *to);
3096
static inline bool copy_event_cache_to_file_and_reinit(IO_CACHE *cache,
3100
my_b_copy_to_file(cache, file) ||
3101
reinit_io_cache(cache, WRITE_CACHE, 0, false, true);
3104
/*****************************************************************************
3106
Heartbeat Log Event class
3108
Replication event to ensure to slave that master is alive.
3109
The event is originated by master's dump thread and sent straight to
3110
slave without being logged. Slave itself does not store it in relay log
3111
but rather uses a data for immediate checks and throws away the event.
3113
Two members of the class log_ident and Log_event::log_pos comprise
3114
@see the event_coordinates instance. The coordinates that a heartbeat
3115
instance carries correspond to the last event master has sent from
3118
****************************************************************************/
3119
class Heartbeat_log_event: public Log_event
3122
Heartbeat_log_event(const char* buf, uint32_t event_len,
3123
const Format_description_log_event* description_event);
3124
Log_event_type get_type_code() { return HEARTBEAT_LOG_EVENT; }
3125
bool is_valid() const
3127
return (log_ident != NULL &&
3128
log_pos >= BIN_LOG_HEADER_SIZE);
3130
const char * get_log_ident() { return log_ident; }
3131
uint32_t get_ident_len() { return ident_len; }
3134
const char* log_ident;
3139
@} (end of group Replication)
3142
#endif /* DRIZZLED_LOG_EVENT_H */
added
removed
drizzled/log_event.h
