MySQL 8.4.2
Source Code Documentation
Backup_page_tracker Class Reference

#include <backup_page_tracker.h>

Static Public Member Functions

static mysql_service_status_t register_udfs ()
 Register backup page-track UDFs. More...
 
static mysql_service_status_t unregister_udfs ()
 Un-Register backup page-track UDFs. More...
 
static bool set_page_tracking_init (UDF_INIT *initid, UDF_ARGS *, char *)
 Callback function for initialization of UDF "mysqlbackup_page_track_set". More...
 
static void set_page_tracking_deinit (UDF_INIT *initid)
 Callback method for initialization of UDF "mysqlbackup_page_track_set". More...
 
static long long set_page_tracking (UDF_INIT *initid, UDF_ARGS *, unsigned char *is_null, unsigned char *error)
 UDF for "mysqlbackup_page_track_set" See include/mysql/udf_registration_types.h. More...
 
static bool page_track_get_changed_pages_init (UDF_INIT *initid, UDF_ARGS *, char *)
 Callback function for initialization of UDF "mysqlbackup_page_track_get_changed_pages". More...
 
static void page_track_get_changed_pages_deinit (UDF_INIT *initid)
 Callback method for initialization of UDF "mysqlbackup_page_track_get_changed_pages". More...
 
static long long page_track_get_changed_pages (UDF_INIT *initid, UDF_ARGS *, unsigned char *is_null, unsigned char *error)
 UDF for "mysqlbackup_page_track_get_changed_pages" See include/mysql/udf_registration_types.h. More...
 
static bool page_track_get_start_lsn_init (UDF_INIT *initid, UDF_ARGS *, char *)
 Callback function for initialization of UDF "mysqlbackup_page_track_get_start_lsn". More...
 
static void page_track_get_start_lsn_deinit (UDF_INIT *initid)
 Callback method for initialization of UDF "mysqlbackup_page_track_get_start_lsn". More...
 
static long long page_track_get_start_lsn (UDF_INIT *initid, UDF_ARGS *, unsigned char *is_null, unsigned char *error)
 UDF for "mysqlbackup_page_track_get_start_lsn" See include/mysql/udf_registration_types.h. More...
 
static bool page_track_get_changed_page_count_init (UDF_INIT *initid, UDF_ARGS *, char *)
 Callback function for initialization of UDF "mysqlbackup_page_track_get_changed_page_count". More...
 
static void page_track_get_changed_page_count_deinit (UDF_INIT *initid)
 Callback method for initialization of UDF "mysqlbackup_page_track_get_changed_page_count". More...
 
static long long page_track_get_changed_page_count (UDF_INIT *initid, UDF_ARGS *, unsigned char *is_null, unsigned char *error)
 UDF for "mysqlbackup_page_track_get_changed_page_count" See include/mysql/udf_registration_types.h. More...
 
static bool page_track_purge_up_to_init (UDF_INIT *initid, UDF_ARGS *, char *)
 Callback function for initialization of UDF "mysqlbackup_page_track_purge_up_to". More...
 
static void page_track_purge_up_to_deinit (UDF_INIT *initid)
 Callback method for deinitialization of UDF "mysqlbackup_page_track_purge_up_to". More...
 
static long long page_track_purge_up_to (UDF_INIT *initid, UDF_ARGS *, unsigned char *is_null, unsigned char *error)
 UDF for "mysqlbackup_page_track_purge_up_to" See include/mysql/udf_registration_types.h. More...
 
static bool backup_id_update ()
 
static void deinit ()
 Method to de-allocate the memory allocated for the buffer holding path value for the page-track file, if not done before. More...
 

Static Public Attributes

static bool m_receive_changed_page_data = false
 
static char * m_changed_pages_file = nullptr
 

Static Private Member Functions

static void initialize_udf_list ()
 Make a list of the UDFs exposed by mysqlbackup page_tracking. More...
 

Static Private Attributes

static ucharm_changed_pages_buf = nullptr
 
static std::list< udf_data_t * > m_udf_list
 

Member Function Documentation

◆ backup_id_update()

bool Backup_page_tracker::backup_id_update ( )
static

◆ deinit()

void Backup_page_tracker::deinit ( )
static

Method to de-allocate the memory allocated for the buffer holding path value for the page-track file, if not done before.

◆ initialize_udf_list()

void Backup_page_tracker::initialize_udf_list ( )
staticprivate

Make a list of the UDFs exposed by mysqlbackup page_tracking.

◆ page_track_get_changed_page_count()

long long Backup_page_tracker::page_track_get_changed_page_count ( UDF_INIT initid,
UDF_ARGS args,
unsigned char *  is_null,
unsigned char *  error 
)
static

UDF for "mysqlbackup_page_track_get_changed_page_count" See include/mysql/udf_registration_types.h.

Returns
lsn at which page-tracking is started/stopped.

◆ page_track_get_changed_page_count_deinit()

void Backup_page_tracker::page_track_get_changed_page_count_deinit ( UDF_INIT initid)
static

Callback method for initialization of UDF "mysqlbackup_page_track_get_changed_page_count".

◆ page_track_get_changed_page_count_init()

bool Backup_page_tracker::page_track_get_changed_page_count_init ( UDF_INIT initid,
UDF_ARGS ,
char *   
)
static

Callback function for initialization of UDF "mysqlbackup_page_track_get_changed_page_count".

Returns
Status of initialization
Return values
falseon success
trueon failure

◆ page_track_get_changed_pages()

long long Backup_page_tracker::page_track_get_changed_pages ( UDF_INIT initid,
UDF_ARGS args,
unsigned char *  is_null,
unsigned char *  error 
)
static

UDF for "mysqlbackup_page_track_get_changed_pages" See include/mysql/udf_registration_types.h.

Returns
an int status

◆ page_track_get_changed_pages_deinit()

void Backup_page_tracker::page_track_get_changed_pages_deinit ( UDF_INIT initid)
static

Callback method for initialization of UDF "mysqlbackup_page_track_get_changed_pages".

◆ page_track_get_changed_pages_init()

bool Backup_page_tracker::page_track_get_changed_pages_init ( UDF_INIT initid,
UDF_ARGS ,
char *   
)
static

Callback function for initialization of UDF "mysqlbackup_page_track_get_changed_pages".

Returns
Status of initialization
Return values
falseon success
trueon failure

◆ page_track_get_start_lsn()

long long Backup_page_tracker::page_track_get_start_lsn ( UDF_INIT initid,
UDF_ARGS args,
unsigned char *  is_null,
unsigned char *  error 
)
static

UDF for "mysqlbackup_page_track_get_start_lsn" See include/mysql/udf_registration_types.h.

Returns
lsn at which page-tracking is started/stopped.

◆ page_track_get_start_lsn_deinit()

void Backup_page_tracker::page_track_get_start_lsn_deinit ( UDF_INIT initid)
static

Callback method for initialization of UDF "mysqlbackup_page_track_get_start_lsn".

◆ page_track_get_start_lsn_init()

bool Backup_page_tracker::page_track_get_start_lsn_init ( UDF_INIT initid,
UDF_ARGS ,
char *   
)
static

Callback function for initialization of UDF "mysqlbackup_page_track_get_start_lsn".

Returns
Status of initialization
Return values
falseon success
trueon failure

◆ page_track_purge_up_to()

long long Backup_page_tracker::page_track_purge_up_to ( UDF_INIT initid,
UDF_ARGS args,
unsigned char *  is_null,
unsigned char *  error 
)
static

UDF for "mysqlbackup_page_track_purge_up_to" See include/mysql/udf_registration_types.h.

The function takes the following parameter: lsn the lsn up to which the page-track data shall be purged.

The lsn is fixed down to the last start-lsn.

Returns
Status
Return values
lsnup to which page-track data was purged on success
-1on failure

◆ page_track_purge_up_to_deinit()

void Backup_page_tracker::page_track_purge_up_to_deinit ( UDF_INIT initid)
static

Callback method for deinitialization of UDF "mysqlbackup_page_track_purge_up_to".

◆ page_track_purge_up_to_init()

bool Backup_page_tracker::page_track_purge_up_to_init ( UDF_INIT initid,
UDF_ARGS args,
char *  message 
)
static

Callback function for initialization of UDF "mysqlbackup_page_track_purge_up_to".

Returns
Status of initialization
Return values
falseon success
trueon failure

◆ register_udfs()

mysql_service_status_t Backup_page_tracker::register_udfs ( )
static

Register backup page-track UDFs.

Returns
Status of UDF registration
Return values
0success
non-zerofailure

◆ set_page_tracking()

long long Backup_page_tracker::set_page_tracking ( UDF_INIT initid,
UDF_ARGS args,
unsigned char *  is_null,
unsigned char *  error 
)
static

UDF for "mysqlbackup_page_track_set" See include/mysql/udf_registration_types.h.

Returns
lsn at which page-tracking is started/stopped.

◆ set_page_tracking_deinit()

void Backup_page_tracker::set_page_tracking_deinit ( UDF_INIT initid)
static

Callback method for initialization of UDF "mysqlbackup_page_track_set".

◆ set_page_tracking_init()

bool Backup_page_tracker::set_page_tracking_init ( UDF_INIT initid,
UDF_ARGS ,
char *   
)
static

Callback function for initialization of UDF "mysqlbackup_page_track_set".

Returns
Status of initialization
Return values
falseon success
trueon failure

◆ unregister_udfs()

mysql_service_status_t Backup_page_tracker::unregister_udfs ( )
static

Un-Register backup page-track UDFs.

Returns
Status of UDF un-registration
Return values
0success
non-zerofailure

Member Data Documentation

◆ m_changed_pages_buf

uchar * Backup_page_tracker::m_changed_pages_buf = nullptr
staticprivate

◆ m_changed_pages_file

char * Backup_page_tracker::m_changed_pages_file = nullptr
static

◆ m_receive_changed_page_data

bool Backup_page_tracker::m_receive_changed_page_data = false
static

◆ m_udf_list

std::list< udf_data_t * > Backup_page_tracker::m_udf_list
staticprivate

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