MySQL 8.4.0
Source Code Documentation
table_replication_applier_filters.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2016, 2024, Oracle and/or its affiliates.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License, version 2.0,
6 as published by the Free Software Foundation.
7
8 This program is designed to work with certain software (including
9 but not limited to OpenSSL) that is licensed under separate terms,
10 as designated in a particular file or component or in included license
11 documentation. The authors of MySQL hereby grant you an additional
12 permission to link the program and your derivative works with the
13 separately licensed software that they have either included with
14 the program or referenced in the documentation.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License, version 2.0, for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
24
25#ifndef TABLE_REPLICATION_APPLIER_FILTERS_H
26#define TABLE_REPLICATION_APPLIER_FILTERS_H
27
28/**
29 @file storage/perfschema/table_replication_applier_filters.h
30 Table replication_applier_filters (declarations).
31*/
32
33#include <sys/types.h>
34
35#include "my_base.h"
36#include "my_inttypes.h"
37#include "mysql_com.h"
38#include "sql/rpl_filter.h"
39#include "sql/rpl_info.h" /* CHANNEL_NAME_LENGTH*/
40#include "sql_string.h"
42
43class Field;
44class Plugin_table;
45struct TABLE;
46struct THR_LOCK;
47
48/** A row in the table */
50 /* The name of the channel */
53 /*
54 REPLICATE_DO_DB, REPLICATE_IGNORE_DB, REPLICATE_DO_TABLE,
55 REPLICATE_IGNORE_TABLE, REPLICATE_WILD_DO_TABLE,
56 REPLICATE_WILD_IGNORE_TABLE, REPLICATE_REWRITE_DB.
57 */
60 /*
61 The replication filter configured by startup options: --replicate-*,
62 CHANGE REPLICATION FILTER, or DEFAULT_FILTER (every channel copyies
63 global replication filters to its per-channel replication filters
64 if there are no per-channel replication filters and there are global
65 filters on the filter type when it is created).
66 */
68 /*
69 The per-channel replication filters can be configured with the following
70 four states:
71 STARTUP_OPTIONS, //STARTUP_OPTIONS: --REPLICATE-*
72 CHANGE_REPLICATION_FILTER, //CHANGE REPLICATION FILTER filter [, filter...]
73 STARTUP_OPTIONS_FOR_CHANNEL, //STARTUP_OPTIONS: --REPLICATE-* (FOR_CHANNEL)
74 CHANGE_REPLICATION_FILTER_FOR_CHANNEL //CHANGE REPLICATION FILTER filter [,
75 filter...] FOR CHANNEL <channel_name>
76 */
78
79 /* Timestamp of when the configuration took place */
81
82 /* The hit counter of the filter since last configuration. */
84};
85
86/** Table PERFORMANCE_SCHEMA.replication_applier_filters */
89
90 private:
91 /**
92 Make a row by an object of Rpl_pfs_filter.
93
94 @param rpl_pfs_filter a pointer to a Rpl_pfs_filter object.
95 */
96 void make_row(Rpl_pfs_filter *rpl_pfs_filter);
97
98 /** Table share lock. */
100 /** Table definition. */
102
103 /** Current row */
105 /** True is the current row exists. */
107 /** Current position. */
109 /** Next position. */
111
112 protected:
113 /**
114 Read the current row values.
115 @param table Table handle
116 @param buf row buffer
117 @param fields Table fields
118 @param read_all true if all columns are read.
119
120 @retval 0 if HAVE_REPLICATION is defined, else HA_ERR_RECORD_DELETED.
121 */
122 int read_row_values(TABLE *table, unsigned char *buf, Field **fields,
123 bool read_all) override;
124
126
127 public:
129
130 /** Table share. */
133 /**
134 Get the table count.
135
136 @retval return the table count.
137 */
138 static ha_rows get_row_count();
139 /**
140 Fetch the next row in this cursor.
141
142 @retval
143 0 Did not reach the end of the table.
144 HA_ERR_END_OF_FILE reached the end of the table.
145 */
146 int rnd_next() override;
147 /**
148 Fetch a row by position.
149
150 @param pos position to fetch
151 */
152 int rnd_pos(const void *pos) override;
153 void reset_position() override;
154};
155
156#endif
Definition: field.h:575
An abstract PERFORMANCE_SCHEMA table.
Definition: pfs_engine_table.h:70
Class to hold information regarding a table to be created on behalf of a plugin.
Definition: plugin_table.h:40
The class Rpl_pfs_filter is introduced to serve the performance_schema.replication_applier_filters ta...
Definition: rpl_filter.h:167
Using this class is fraught with peril, and you need to be very careful when doing so.
Definition: sql_string.h:167
Table PERFORMANCE_SCHEMA.replication_applier_filters.
Definition: table_replication_applier_filters.h:87
void reset_position() override
Reset the cursor position to the beginning of the table.
Definition: table_replication_applier_filters.cc:100
pos_t m_pos
Current position.
Definition: table_replication_applier_filters.h:108
pos_t m_next_pos
Next position.
Definition: table_replication_applier_filters.h:110
bool m_row_exists
True is the current row exists.
Definition: table_replication_applier_filters.h:106
int rnd_pos(const void *pos) override
Fetch a row by position.
Definition: table_replication_applier_filters.cc:134
int read_row_values(TABLE *table, unsigned char *buf, Field **fields, bool read_all) override
Read the current row values.
Definition: table_replication_applier_filters.cc:177
st_row_applier_filters m_row
Current row.
Definition: table_replication_applier_filters.h:104
PFS_simple_index pos_t
Definition: table_replication_applier_filters.h:88
static PFS_engine_table * create(PFS_engine_table_share *)
Definition: table_replication_applier_filters.cc:86
static Plugin_table m_table_def
Table definition.
Definition: table_replication_applier_filters.h:101
void make_row(Rpl_pfs_filter *rpl_pfs_filter)
Make a row by an object of Rpl_pfs_filter.
Definition: table_replication_applier_filters.cc:152
table_replication_applier_filters()
Definition: table_replication_applier_filters.cc:91
static THR_LOCK m_table_lock
Table share lock.
Definition: table_replication_applier_filters.h:99
static ha_rows get_row_count()
Get the table count.
Definition: table_replication_applier_filters.cc:105
static PFS_engine_table_share m_share
Table share.
Definition: table_replication_applier_filters.h:131
int rnd_next() override
Fetch the next row in this cursor.
Definition: table_replication_applier_filters.cc:113
This file includes constants used by all storage engines.
my_off_t ha_rows
Definition: my_base.h:1141
Some integer typedefs for easier portability.
unsigned long long int ulonglong
Definition: my_inttypes.h:56
Common definition between mysql server & client.
#define NAME_LEN
Definition: mysql_com.h:67
static PFS_engine_table_share_proxy table
Definition: pfs.cc:61
Definition: buf0block_hint.cc:30
Performance schema tables (declarations).
enum_configured_by
Enum values for CONFIGURED_BY column.
Definition: rpl_filter.h:84
#define CHANNEL_NAME_LENGTH
Definition: rpl_info.h:41
Our own string classes, used pervasively throughout the executor.
A PERFORMANCE_SCHEMA table share.
Definition: pfs_engine_table.h:358
Position of a cursor, for simple iterations.
Definition: pfs_engine_table.h:558
Definition: table.h:1405
Definition: thr_lock.h:139
A row in the table.
Definition: table_replication_applier_filters.h:49
ulonglong counter
Definition: table_replication_applier_filters.h:83
ulonglong active_since
Definition: table_replication_applier_filters.h:80
enum_configured_by configured_by
Definition: table_replication_applier_filters.h:77
uint filter_name_length
Definition: table_replication_applier_filters.h:59
char channel_name[CHANNEL_NAME_LENGTH]
Definition: table_replication_applier_filters.h:51
String filter_rule
Definition: table_replication_applier_filters.h:67
uint channel_name_length
Definition: table_replication_applier_filters.h:52
char filter_name[NAME_LEN]
Definition: table_replication_applier_filters.h:58