filter

README

Filter

filter provides a library to filter replicate on schema/table by given rules

Rules

rules like replication rules in MySQL, ref document: hhttps://dev.mysql.com/doc/refman/8.0/en/replication-rules-db-options.html https://dev.mysql.com/doc/refman/8.0/en/replication-rules-table-options.html

Priority and Key Points

• DoDBs > IgnoreDBs
  • which rules to use?
    • If there are some DoDB rules, only use DoDB Rules
    • Otherwise if there are some IgnoreDB rules, use IgnoreDB rules
    • tables that are not filtered out or there are empty DoDBs/IgnoreDBs rules would go to filter on DoTables/IgnoreTables rules
• DoTables > IgnoreTables
  • if there are DoTable Rules, but no one is matched, we would ignore corresponding table

Documentation

Index

• Variables
• func IsSystemSchema(schema string) bool
• type ActionType
• type Filter
  • func New(caseSensitive bool, rules *Rules) (*Filter, error)
  • func (f *Filter) ApplyOn(stbs []*Table) []*Table
  • func (f *Filter) Match(tb *Table) bool
• type Rules
  • func (r *Rules) ToLower()
• type Table
  • func (t *Table) String() string

Variables

var (
	// DMHeartbeatSchema is the heartbeat schema name
	DMHeartbeatSchema = "DM_HEARTBEAT"
	// DMHeartbeatTable is heartbeat table name
	DMHeartbeatTable = "HEARTBEAT"
	// InformationSchemaName is the `INFORMATION_SCHEMA` database name.
	InformationSchemaName = "INFORMATION_SCHEMA"
	// PerformanceSchemaName is the `PERFORMANCE_SCHEMA` database name.
	PerformanceSchemaName = "PERFORMANCE_SCHEMA"
	// MetricSchemaName is the `METRIC_SCHEMA` database name.
	MetricSchemaName = "METRIC_SCHEMA"
	// InspectionSchemaName is the `INSPECTION_SCHEMA` database name
	InspectionSchemaName = "INSPECTION_SCHEMA"
)

Functions

func IsSystemSchema

func IsSystemSchema(schema string) bool

IsSystemSchema checks whether schema is system schema or not. case insensitive

Types

type ActionType

type ActionType bool

ActionType is do or ignore something

const (
	Do     ActionType = true
	Ignore ActionType = false
)

builtin actiontype variable

type Filter

type Filter struct {
	selector.Selector
	// contains filtered or unexported fields
}

Filter implements whitelist and blacklist filters.

func New

func New(caseSensitive bool, rules *Rules) (*Filter, error)

New creates a filter use the rules.

func (*Filter) ApplyOn

func (f *Filter) ApplyOn(stbs []*Table) []*Table

ApplyOn applies filter rules on tables rules like https://dev.mysql.com/doc/refman/8.0/en/replication-rules-table-options.html https://dev.mysql.com/doc/refman/8.0/en/replication-rules-db-options.html

func (*Filter) Match

func (f *Filter) Match(tb *Table) bool

Match returns true if the specified table should not be removed.

type Rules

type Rules struct {
	DoTables []*Table `json:"do-tables" toml:"do-tables" yaml:"do-tables"`
	DoDBs    []string `json:"do-dbs" toml:"do-dbs" yaml:"do-dbs"`

	IgnoreTables []*Table `json:"ignore-tables" toml:"ignore-tables" yaml:"ignore-tables"`
	IgnoreDBs    []string `json:"ignore-dbs" toml:"ignore-dbs" yaml:"ignore-dbs"`
}

Rules contains Filter rules.

func (*Rules) ToLower

func (r *Rules) ToLower()

ToLower convert all entries to lowercase

type Table

type Table struct {
	Schema string `toml:"db-name" json:"db-name" yaml:"db-name"`
	Name   string `toml:"tbl-name" json:"tbl-name" yaml:"tbl-name"`
}

Table represents a table.

func (*Table) String

func (t *Table) String() string

String implements the fmt.Stringer interface.