- 关于 TiDB
- 快速上手
- 部署标准集群
- 数据迁移
- 运维操作
- 监控与告警
- 故障诊断
- 性能调优
- 系统调优
- 软件调优
- SQL 性能调优
- SQL 性能调优概览
- 理解 TiDB 执行计划
- SQL 优化流程
- 控制执行计划
- 教程
- TiDB 工具
- 功能概览
- 适用场景
- 工具下载
- TiUP
- TiDB Operator
- Dumpling
- TiDB Lightning
- TiDB Data Migration
- Backup & Restore (BR)
- TiDB Binlog
- TiCDC
- sync-diff-inspector
- TiSpark
- 参考指南
- 架构
- 监控指标
- 安全加固
- 权限
- SQL
- SQL 语言结构和语法
- SQL 语句
ADD COLUMN
ADD INDEX
ADMIN
ADMIN CANCEL DDL
ADMIN CHECKSUM TABLE
ADMIN CHECK [TABLE|INDEX]
ADMIN SHOW DDL [JOBS|QUERIES]
ALTER DATABASE
ALTER INDEX
ALTER INSTANCE
ALTER TABLE
ALTER USER
ANALYZE TABLE
BACKUP
BEGIN
CHANGE COLUMN
CHANGE DRAINER
CHANGE PUMP
COMMIT
CREATE [GLOBAL|SESSION] BINDING
CREATE DATABASE
CREATE INDEX
CREATE ROLE
CREATE SEQUENCE
CREATE TABLE LIKE
CREATE TABLE
CREATE USER
CREATE VIEW
DEALLOCATE
DELETE
DESC
DESCRIBE
DO
DROP [GLOBAL|SESSION] BINDING
DROP COLUMN
DROP DATABASE
DROP INDEX
DROP ROLE
DROP SEQUENCE
DROP STATS
DROP TABLE
DROP USER
DROP VIEW
EXECUTE
EXPLAIN ANALYZE
EXPLAIN
FLASHBACK TABLE
FLUSH PRIVILEGES
FLUSH STATUS
FLUSH TABLES
GRANT <privileges>
GRANT <role>
INSERT
KILL [TIDB]
LOAD DATA
LOAD STATS
MODIFY COLUMN
PREPARE
RECOVER TABLE
RENAME INDEX
RENAME TABLE
REPLACE
RESTORE
REVOKE <privileges>
REVOKE <role>
ROLLBACK
SELECT
SET DEFAULT ROLE
SET [NAMES|CHARACTER SET]
SET PASSWORD
SET ROLE
SET TRANSACTION
SET [GLOBAL|SESSION] <variable>
SHOW [BACKUPS|RESTORES]
SHOW ANALYZE STATUS
SHOW [GLOBAL|SESSION] BINDINGS
SHOW BUILTINS
SHOW CHARACTER SET
SHOW COLLATION
SHOW [FULL] COLUMNS FROM
SHOW CONFIG
SHOW CREATE SEQUENCE
SHOW CREATE TABLE
SHOW CREATE USER
SHOW DATABASES
SHOW DRAINER STATUS
SHOW ENGINES
SHOW ERRORS
SHOW [FULL] FIELDS FROM
SHOW GRANTS
SHOW INDEX [FROM|IN]
SHOW INDEXES [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW MASTER STATUS
SHOW PLUGINS
SHOW PRIVILEGES
SHOW [FULL] PROCESSSLIST
SHOW PROFILES
SHOW PUMP STATUS
SHOW SCHEMAS
SHOW STATS_HEALTHY
SHOW STATS_HISTOGRAMS
SHOW STATS_META
SHOW STATUS
SHOW TABLE NEXT_ROW_ID
SHOW TABLE REGIONS
SHOW TABLE STATUS
SHOW [FULL] TABLES
SHOW [GLOBAL|SESSION] VARIABLES
SHOW WARNINGS
SHUTDOWN
SPLIT REGION
START TRANSACTION
TABLE
TRACE
TRUNCATE
UPDATE
USE
- 数据类型
- 函数与操作符
- 聚簇索引
- 约束
- 生成列
- SQL 模式
- 事务
- 垃圾回收 (GC)
- 视图
- 分区表
- 字符集和排序规则
- 系统表
mysql
- INFORMATION_SCHEMA
- Overview
ANALYZE_STATUS
CLIENT_ERRORS_SUMMARY_BY_HOST
CLIENT_ERRORS_SUMMARY_BY_USER
CLIENT_ERRORS_SUMMARY_GLOBAL
CHARACTER_SETS
CLUSTER_CONFIG
CLUSTER_HARDWARE
CLUSTER_INFO
CLUSTER_LOAD
CLUSTER_LOG
CLUSTER_SYSTEMINFO
COLLATIONS
COLLATION_CHARACTER_SET_APPLICABILITY
COLUMNS
DDL_JOBS
ENGINES
INSPECTION_RESULT
INSPECTION_RULES
INSPECTION_SUMMARY
KEY_COLUMN_USAGE
METRICS_SUMMARY
METRICS_TABLES
PARTITIONS
PROCESSLIST
SCHEMATA
SEQUENCES
SESSION_VARIABLES
SLOW_QUERY
STATISTICS
TABLES
TABLE_CONSTRAINTS
TABLE_STORAGE_STATS
TIDB_HOT_REGIONS
TIDB_INDEXES
TIDB_SERVERS_INFO
TIFLASH_REPLICA
TIKV_REGION_PEERS
TIKV_REGION_STATUS
TIKV_STORE_STATUS
USER_PRIVILEGES
VIEWS
METRICS_SCHEMA
- UI
- CLI
- 命令行参数
- 配置文件参数
- 系统变量
- 存储引擎
- 遥测
- 错误码
- 通过拓扑 label 进行副本调度
- 常见问题解答 (FAQ)
- 版本发布历史
- 发布版本汇总
- v5.0
- v4.0
- v3.1
- v3.0
- v2.1
- v2.0
- v1.0
- 术语表
表库过滤
TiDB 生态工具默认情况下作用于所有数据库,但实际使用中,往往只需要作用于其中的部分子集。例如,用户只想处理 foo*
和 bar*
形式的表,而无需对其他表进行操作。
从 TiDB 4.0 起,所有 TiDB 生态系统工具都使用一个通用的过滤语法来定义子集。本文档介绍如何使用表库过滤功能。
使用表库过滤
命令行
在命令行中使用多个 -f
或 --filter
参数,即可在 TiDB 生态工具中应用表库过滤规则。每个过滤规则均采用 db.table
形式,支持通配符(详情见下一节)。以下为各个工具中的使用示例:
BR:
./br backup full -f 'foo*.*' -f 'bar*.*' -s 'local:///tmp/backup' # ^~~~~~~~~~~~~~~~~~~~~~~ ./br restore full -f 'foo*.*' -f 'bar*.*' -s 'local:///tmp/backup' # ^~~~~~~~~~~~~~~~~~~~~~~
./dumpling -f 'foo*.*' -f 'bar*.*' -P 3306 -o /tmp/data/ # ^~~~~~~~~~~~~~~~~~~~~~~
./tidb-lightning -f 'foo*.*' -f 'bar*.*' -d /tmp/data/ --backend tidb # ^~~~~~~~~~~~~~~~~~~~~~~
TOML 配置文件
在 TOML 文件中,表库过滤规则以字符串数组的形式指定。以下为各个工具中的使用示例:
TiDB Lightning:
[mydumper] filter = ['foo*.*', 'bar*.*']
[filter] rules = ['foo*.*', 'bar*.*'] [[sink.dispatchers]] matcher = ['db1.*', 'db2.*', 'db3.*'] dispatcher = 'ts'
表库过滤语法
直接使用表名
每条表库过滤规则由“库”和“表”组成,两部分之间以英文句号 (.
) 分隔。只有表名与规则完全相符的表才会被接受。
db1.tbl1
db2.tbl2
db3.tbl3
表名只由有效的标识符组成,例如:
- 数字(
0
到9
) - 字母(
a
到z
,A
到Z
) $
_
- 非 ASCII 字符(
U+0080
到U+10FFFF
)
其他 ASCII 字符均为保留字。部分标点符号有特殊含义,详情见下一节。
使用通配符
表名的两个部分均支持使用通配符(详情见 fnmatch(3))。
*
:匹配零个或多个字符。?
:匹配一个字符。[a-z]
:匹配 “a” 和 “z” 之间的一个字符。[!a-z]
:匹配不在 “a” 和 “z” 之间的一个字符。
db[0-9].tbl[0-9a-f][0-9a-f]
data.*
*.backup_*
此处,“字符”指的是一个 Unicode 码位,例如:
U+00E9
(é) 是 1 个字符。U+0065 U+0301
(é) 是 2 个字符。U+1F926 U+1F3FF U+200D U+2640 U+FE0F
(🤦🏿♀️) 是 5 个字符。
使用文件导入
如需导入一个文件作为过滤规则,请在规则的开头加上一个 “@” 来指定文件名。库表过滤解析器将导入文件中的每一行都解析为一条额外的过滤规则。
例如,config/filter.txt
文件有以下内容:
employees.*
*.WorkOrder
以下两条表库过滤命令是等价的:
./dumpling -f '@config/filter.txt'
./dumpling -f 'employees.*' -f '*.WorkOrder'
导入的文件里不能使用过滤规则导入另一个文件。
注释与空行
导入的过滤规则文件中,每一行开头和结尾的空格都会被去除。此外,空行(空字符串)也将被忽略。
行首的 #
表示该行是注释,会被忽略。而不在行首的 #
则会被认为是语法错误。
# 这是一行注释
db.table # 这一部分不是注释,且可能引起错误
排除规则
在一条过滤规则的开头加上 !
,则表示符合这条规则的表不会被 TiDB 生态工具处理。通过应用排除规则,库表过滤可以作为屏蔽名单来使用。
*.*
#^ 注意:必须先添加 *.* 规则来包括所有表
!*.Password
!employees.salaries
转义字符
如果需要将特殊字符转化为标识符,可以在特殊字符前加上反斜杠 \
。
db\.with\.dots.*
为了简化语法并向上兼容,不支持下列字符序列:
- 在行尾去除空格后使用
\
(使用[ ]
来匹配行尾的空格)。 - 在
\
后使用数字或字母 ([0-9a-zA-Z]
)。特别是类似 C 的转义序列,如\0
、\r
、\n
、\t
等序列,目前在表库过滤规则中无意义。
引号包裹的标识符
除了 \
之外,还可以用 "
和 `
来控制特殊字符。
"db.with.dots"."tbl\1"
`db.with.dots`.`tbl\2`
也可以通过输入两次引号,将引号包含在标识符内。
"foo""bar".`foo``bar`
# 等价于:
foo\"bar.foo\`bar
用引号包裹的标识符不可以跨越多行。
用引号只包裹标识符的一部分是无效的,例如:
"this is "invalid*.*
正则表达式
如果你需要使用较复杂的过滤规则,可以将每个匹配模型写为正则表达式,以 /
为分隔符:
/^db\d{2,}$/./^tbl\d{2,}$/
这类正则表示使用 Go dialect。只要标识符中有一个子字符串与正则表达式匹配,则视为匹配该模型。例如,/b/
匹配 db01
。
正则表达式中的每一个 /
都需要转义为 \/
,包括在 [...]
里面的 /
。不允许在 \Q...\E
之间放置一个未转义的 /
。
使用多个过滤规则
当表的名称与过滤列表中所有规则均不匹配时,默认情况下这些表被忽略。
要建立一个屏蔽名单,必须使用显式的 *.*
作为第一条过滤规则,否则所有表均被排除。
# 所有表均被过滤掉
./dumpling -f '!*.Password'
# 只有 “Password” 表被过滤掉,其余表仍保留
./dumpling -f '*.*' -f '!*.Password'
如果一个表的名称与过滤列表中的多个规则匹配,则以最后匹配的规则为准。例如:
# rule 1
employees.*
# rule 2
!*.dep*
# rule 3
*.departments
过滤结果如下:
表名 | 规则 1 | 规则 2 | 规则 3 | 结果 |
---|---|---|---|---|
irrelevant.table | 默认(拒绝) | |||
employees.employees | ✓ | 规则 1(接受) | ||
employees.dept_emp | ✓ | ✓ | 规则 2(拒绝) | |
employees.departments | ✓ | ✓ | ✓ | 规则 3(接受) |
else.departments | ✓ | ✓ | 规则 3(接受) |
在 TiDB 生态工具的默认配置中,系统库总是被排除。系统库有以下六个:
INFORMATION_SCHEMA
PERFORMANCE_SCHEMA
METRICS_SCHEMA
INSPECTION_SCHEMA
mysql
sys