MySQL 9.0.0
Source Code Documentation
cs::util::ColumnFilterFactory Class Reference

This class allows the developer to create a filter instance given a type. More...

#include <column_filter_factory.h>

Public Types

enum class  ColumnFilterType { outbound_func_index , inbound_func_index , inbound_gipk }
 The different types of filters for column iteration. More...
 

Static Public Member Functions

static std::unique_ptr< ColumnFiltercreate_filter (ColumnFilterType filter_type)
 Create a filter object. More...
 
static bool is_filter_needed (THD const &thd, TABLE *table, table_def const *tabledef, ColumnFilterType filter_type)
 Returns if a filter is needed given the parameters. More...
 

Detailed Description

This class allows the developer to create a filter instance given a type.

Member Enumeration Documentation

◆ ColumnFilterType

The different types of filters for column iteration.

Enumerator
outbound_func_index 
inbound_func_index 
inbound_gipk 

Member Function Documentation

◆ create_filter()

static std::unique_ptr< ColumnFilter > cs::util::ColumnFilterFactory::create_filter ( ColumnFilterType  filter_type)
inlinestatic

Create a filter object.

Parameters
filter_typethe filter to be created
Returns
a unique pointer to a sub class of ColumnFilter

◆ is_filter_needed()

static bool cs::util::ColumnFilterFactory::is_filter_needed ( THD const &  thd,
TABLE table,
table_def const *  tabledef,
ColumnFilterType  filter_type 
)
inlinestatic

Returns if a filter is needed given the parameters.

Parameters
thdThe thread being used in this context
tableThe table being filtered
tabledefThe replicated table context if applicable
filter_typeThe filter type being tested
Returns
true if the filter should be used
false if the filter is not needed

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