MySQL 8.4.0
Source Code Documentation
mysql::binlog::event::Begin_load_query_event Class Reference

Event for the first block of file to be loaded, its only difference from Append_block event is that this event creates or truncates existing file before writing data. More...

#include <load_data_events.h>

Inheritance diagram for mysql::binlog::event::Begin_load_query_event:
[legend]

Public Member Functions

 Begin_load_query_event (const char *buf, const Format_description_event *fde)
 The buffer layout for fixed data part is as follows: More...
 
 ~Begin_load_query_event () override=default
 
- Public Member Functions inherited from mysql::binlog::event::Append_block_event
 Append_block_event (const char *buf, const Format_description_event *fde)
 Appends the buffered data, received as a parameter, to the file being loaded via LOAD_DATA_FILE. More...
 
 ~Append_block_event () override=default
 
- Public Member Functions inherited from mysql::binlog::event::Binary_log_event
virtual ~Binary_log_event ()=0
 
 Binary_log_event (const Binary_log_event &)=default
 
 Binary_log_event (Binary_log_event &&)=default
 
Binary_log_eventoperator= (const Binary_log_event &)=default
 
Binary_log_eventoperator= (Binary_log_event &&)=default
 
enum Log_event_type get_event_type () const
 Helper method. More...
 
const Log_event_headerheader () const
 Return a const pointer to the header of the log event. More...
 
Log_event_headerheader ()
 Return a non-const pointer to the header of the log event. More...
 
const Log_event_footerfooter () const
 Return a const pointer to the footer of the log event. More...
 
Log_event_footerfooter ()
 Return a non-const pointer to the footer of the log event. More...
 
Event_readerreader ()
 Returns a reference to the event Event_reader object. More...
 

Protected Member Functions

 Begin_load_query_event ()
 
- Protected Member Functions inherited from mysql::binlog::event::Append_block_event
 Append_block_event (const char *db_arg, unsigned char *block_arg, unsigned int block_len_arg, uint32_t file_id_arg)
 This constructor is used by the MySQL server. More...
 
 Append_block_event (Log_event_type type_arg=APPEND_BLOCK_EVENT)
 
- Protected Member Functions inherited from mysql::binlog::event::Binary_log_event
 Binary_log_event (Log_event_type type_code)
 This constructor is used to initialize the type_code of header object m_header. More...
 
 Binary_log_event (const char **buf, const Format_description_event *fde)
 This constructor will create a new object of Log_event_header and initialize the variable m_header, which in turn will be used to initialize Log_event's member common_header. More...
 

Additional Inherited Members

- Public Types inherited from mysql::binlog::event::Append_block_event
enum  Append_block_offset { AB_FILE_ID_OFFSET = 0 , AB_DATA_OFFSET = APPEND_BLOCK_HEADER_LEN }
 
- Public Types inherited from mysql::binlog::event::Binary_log_event
enum  enum_post_header_length {
  QUERY_HEADER_MINIMAL_LEN = (4 + 4 + 1 + 2) , QUERY_HEADER_LEN = (QUERY_HEADER_MINIMAL_LEN + 2) , STOP_HEADER_LEN = 0 , START_V3_HEADER_LEN = (2 + ST_SERVER_VER_LEN + 4) ,
  ROTATE_HEADER_LEN = 8 , INTVAR_HEADER_LEN = 0 , APPEND_BLOCK_HEADER_LEN = 4 , DELETE_FILE_HEADER_LEN = 4 ,
  RAND_HEADER_LEN = 0 , USER_VAR_HEADER_LEN = 0 , FORMAT_DESCRIPTION_HEADER_LEN = (START_V3_HEADER_LEN + 1 + LOG_EVENT_TYPES) , XID_HEADER_LEN = 0 ,
  BEGIN_LOAD_QUERY_HEADER_LEN = APPEND_BLOCK_HEADER_LEN , ROWS_HEADER_LEN_V1 = 8 , TABLE_MAP_HEADER_LEN = 8 , EXECUTE_LOAD_QUERY_EXTRA_HEADER_LEN = (4 + 4 + 4 + 1) ,
  EXECUTE_LOAD_QUERY_HEADER_LEN , INCIDENT_HEADER_LEN = 2 , HEARTBEAT_HEADER_LEN = 0 , IGNORABLE_HEADER_LEN = 0 ,
  ROWS_HEADER_LEN_V2 = 10 , TRANSACTION_CONTEXT_HEADER_LEN = 18 , VIEW_CHANGE_HEADER_LEN = 52 , XA_PREPARE_HEADER_LEN = 0 ,
  TRANSACTION_PAYLOAD_HEADER_LEN = 0
}
 The lengths for the fixed data part of each event. More...
 
- Public Attributes inherited from mysql::binlog::event::Append_block_event
unsigned char * block
 
unsigned int block_len
 
uint32_t file_id
 
const char * db
 'db' is filled when the event is created in mysql_load() (the event needs to have a 'db' member to be well filtered by binlog-*-db rules). More...
 
- Static Public Attributes inherited from mysql::binlog::event::Binary_log_event
static const int LOG_EVENT_TYPES = (ENUM_END_EVENT - 1)
 

Detailed Description

Event for the first block of file to be loaded, its only difference from Append_block event is that this event creates or truncates existing file before writing data.

Binary Format

The Post-Header and Body for this event type are empty; it only has the Common-Header.

Constructor & Destructor Documentation

◆ Begin_load_query_event() [1/2]

mysql::binlog::event::Begin_load_query_event::Begin_load_query_event ( )
inlineprotected

◆ Begin_load_query_event() [2/2]

mysql::binlog::event::Begin_load_query_event::Begin_load_query_event ( const char *  buf,
const Format_description_event fde 
)

The buffer layout for fixed data part is as follows:

+---------+
| file_id |
+---------+

The buffer layout for variable data part is as follows:

+-------------------+
| block | block_len |
+-------------------+
Parameters
bufContains the serialized event.
fdeAn FDE event (see Rotate_event constructor for more info).

◆ ~Begin_load_query_event()

mysql::binlog::event::Begin_load_query_event::~Begin_load_query_event ( )
overridedefault

The documentation for this class was generated from the following files: