Skip to content

Commit

Permalink
improve IncludeTableRegex and ExcludeTableRegex comment
Browse files Browse the repository at this point in the history
  • Loading branch information
Jijun Gao committed May 10, 2024
1 parent 16ba343 commit 6e703dd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions canal/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,12 @@ type Config struct {
HeartbeatPeriod time.Duration `toml:"heartbeat_period"`
ReadTimeout time.Duration `toml:"read_timeout"`

// IncludeTableRegex or ExcludeTableRegex should contain database name
// IncludeTableRegex or ExcludeTableRegex should contain database name.
// IncludeTableRegex defines the tables that will be included, if empty, all tables will be included.
// ExcludeTableRegex defines the tables that will be excluded from the ones defined by IncludeTableRegex.
// Only a table which matches IncludeTableRegex and dismatches ExcludeTableRegex will be processed
// eg, IncludeTableRegex : [".*\\.canal"], ExcludeTableRegex : ["mysql\\..*"]
// this will include all database's 'canal' table, except database 'mysql'
// this will include all database's 'canal' table, except database 'mysql'.
// Default IncludeTableRegex and ExcludeTableRegex are empty, this will include all tables
IncludeTableRegex []string `toml:"include_table_regex"`
ExcludeTableRegex []string `toml:"exclude_table_regex"`
Expand Down

0 comments on commit 6e703dd

Please sign in to comment.