- 关于 TiDB
- 快速上手
- 部署标准集群
- 数据迁移
- 运维操作
- 监控与告警
- 故障诊断
- 性能调优
- 系统调优
- 软件调优
- SQL 性能调优
- SQL 性能调优概览
- 理解 TiDB 执行计划
- SQL 优化流程
- 控制执行计划
- 教程
- 同城多中心部署
- 两地三中心部署
- 同城两中心部署
- 读取历史数据
- 使用 Stale Read 功能读取历史数据(推荐)
- 使用系统变量
tidb_snapshot
读取历史数据
- 最佳实践
- Placement Rules 使用文档
- Load Base Split 使用文档
- Store Limit 使用文档
- TiDB 工具
- 功能概览
- 适用场景
- 工具下载
- TiUP
- 文档地图
- 概览
- 术语及核心概念
- TiUP 组件管理
- FAQ
- 故障排查
- TiUP 命令参考手册
- 命令概览
- TiUP 命令
- TiUP Cluster 命令
- TiUP Cluster 命令概览
- tiup cluster audit
- tiup cluster check
- tiup cluster clean
- tiup cluster deploy
- tiup cluster destroy
- tiup cluster disable
- tiup cluster display
- tiup cluster edit-config
- tiup cluster enable
- tiup cluster help
- tiup cluster import
- tiup cluster list
- tiup cluster patch
- tiup cluster prune
- tiup cluster reload
- tiup cluster rename
- tiup cluster replay
- tiup cluster restart
- tiup cluster scale-in
- tiup cluster scale-out
- tiup cluster start
- tiup cluster stop
- tiup cluster template
- tiup cluster upgrade
- TiUP DM 命令
- TiUP DM 命令概览
- tiup dm audit
- tiup dm deploy
- tiup dm destroy
- tiup dm disable
- tiup dm display
- tiup dm edit-config
- tiup dm enable
- tiup dm help
- tiup dm import
- tiup dm list
- tiup dm patch
- tiup dm prune
- tiup dm reload
- tiup dm replay
- tiup dm restart
- tiup dm scale-in
- tiup dm scale-out
- tiup dm start
- tiup dm stop
- tiup dm template
- tiup dm upgrade
- TiDB 集群拓扑文件配置
- DM 集群拓扑文件配置
- TiUP 镜像参考指南
- 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]
ADMIN SHOW TELEMETRY
ALTER DATABASE
ALTER INDEX
ALTER INSTANCE
ALTER PLACEMENT POLICY
ALTER TABLE
ALTER USER
ANALYZE TABLE
BACKUP
BEGIN
CHANGE COLUMN
CHANGE DRAINER
CHANGE PUMP
COMMIT
CREATE [GLOBAL|SESSION] BINDING
CREATE DATABASE
CREATE INDEX
CREATE PLACEMENT POLICY
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 PLACEMENT POLICY
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 PLACEMENT POLICY
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 PLACEMENT
SHOW PLACEMENT FOR
SHOW PLACEMENT LABELS
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
WITH
- 数据类型
- 函数与操作符
- 聚簇索引
- 约束
- 生成列
- SQL 模式
- 表属性
- 事务
- 垃圾回收 (GC)
- 视图
- 分区表
- 临时表
- 字符集和排序
- Placement Rules in SQL
- 系统表
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
DATA_LOCK_WAITS
DDL_JOBS
DEADLOCKS
ENGINES
INSPECTION_RESULT
INSPECTION_RULES
INSPECTION_SUMMARY
KEY_COLUMN_USAGE
METRICS_SUMMARY
METRICS_TABLES
PARTITIONS
PLACEMENT_RULES
PROCESSLIST
REFERENTIAL_CONSTRAINTS
SCHEMATA
SEQUENCES
SESSION_VARIABLES
SLOW_QUERY
STATISTICS
TABLES
TABLE_CONSTRAINTS
TABLE_STORAGE_STATS
TIDB_HOT_REGIONS
TIDB_HOT_REGIONS_HISTORY
TIDB_INDEXES
TIDB_SERVERS_INFO
TIDB_TRX
TIFLASH_REPLICA
TIKV_REGION_PEERS
TIKV_REGION_STATUS
TIKV_STORE_STATUS
USER_PRIVILEGES
VIEWS
METRICS_SCHEMA
- UI
- CLI
- 命令行参数
- 配置文件参数
- 系统变量
- 存储引擎
- 遥测
- 错误码
- 通过拓扑 label 进行副本调度
- 常见问题解答 (FAQ)
- 版本发布历史
- 术语表
TiDB 配置参数
在启动 TiDB 时,你可以使用命令行参数或环境变量来配置 TiDB。
要快速了解 TiDB 的参数体系与参数作用域,建议先观看下面的培训视频(时长 17 分钟)。
本文将详细介绍 TiDB 的命令行启动参数。TiDB 的默认端口为 4000(客户端请求)与 10080(状态报告)。
--advertise-address
- 登录 TiDB 的 IP 地址
- 默认:""
- 必须确保用户和集群中的其他机器都能够访问到该 IP 地址
--config
- 配置文件
- 默认:""
- 如果你指定了配置文件,TiDB 会首先读取配置文件的配置。如果对应的配置在命令行参数里面也存在,TiDB 就会使用命令行参数的配置来覆盖配置文件中的配置。详细的配置项请参阅 TiDB 配置文件描述。
--config-check
- 检查配置文件的有效性并退出
- 默认:false
--config-strict
- 增强配置文件的有效性
- 默认:false
--cors
- 用于设置 TiDB HTTP 状态服务的 Access-Control-Allow-Origin
- 默认:""
--host
- TiDB 服务监听的 host
- 默认:"0.0.0.0"
- 0.0.0.0 默认会监听所有的网卡地址。如果有多块网卡,可以指定对外提供服务的网卡,如 192.168.100.113
--enable-binlog
- 是否产生 TiDB Binlog
- 默认:false
-L
- Log 级别
- 默认:"info"
- 可选:"debug","info","warn","error","fatal"
--lease
- Schema lease 的持续时间。除非你知道更改该值带来的后果,否则你的更改操作是危险的。
- 默认:45s
--log-file
- Log 文件
- 默认:""
- 如果未设置该参数,log 会默认输出到 "stderr";如果设置了该参数,log 会输出到对应的文件中。
--log-slow-query
- 慢查询日志文件路径
- 默认:""
- 如果未设置该参数,log 会默认输出到
--log-file
指定的文件中
--metrics-addr
- Prometheus Pushgateway 地址
- 默认:""
- 如果该参数为空,TiDB 不会将统计信息推送给 Pushgateway。参数格式示例:
--metrics-addr=192.168.100.115:9091
--metrics-interval
- 推送统计信息到 Prometheus Pushgateway 的时间间隔
- 默认:15s
- 设置为 0 表示不推送统计信息给 Pushgateway。示例:
--metrics-interval=2
指每两秒推送到 Pushgateway
-P
- TiDB 服务监听端口
- 默认:"4000"
- TiDB 服务会使用该端口接受 MySQL 客户端发来的请求
--path
- 对于本地存储引擎 "unistore" 来说,path 指定的是实际的数据存放路径
- 当
--store = tikv
时,必须指定 path;当--store = unistore
时,如果不指定 path,会使用默认值。 - 对于 "TiKV" 存储引擎来说,path 指定的是实际的 PD 地址。假如在 192.168.100.113:2379、192.168.100.114:2379 和 192.168.100.115:2379 上面部署了 PD,那么 path 为 "192.168.100.113:2379, 192.168.100.114:2379, 192.168.100.115:2379"
- 默认:"/tmp/tidb"
- 可以通过
tidb-server --store=unistore --path=""
来启动一个纯内存引擎的 TiDB
--proxy-protocol-networks
- 允许使用 PROXY 协议连接 TiDB 的代理服务器地址列表。
- 默认:""
- 通常情况下,通过反向代理使用 TiDB 时,TiDB 会将反向代理服务器的 IP 地址视为客户端 IP 地址。对于支持 PROXY 协议的反向代理(如 HAProxy),开启 PROXY 协议后能让反向代理透传客户端真实的 IP 地址给 TiDB。
- 配置该参数后,TiDB 将允许配置的源 IP 地址使用 PROXY 协议连接到 TiDB,且拒绝这些源 IP 地址使用非 PROXY 协议连接。若该参数为空,则任何源 IP 地址都不能使用 PROXY 协议连接到 TiDB。地址可以使用 IP 地址格式 (192.168.1.50) 或者 CIDR 格式 (192.168.1.0/24),并可用
,
分隔多个地址,或用*
代表所有 IP 地址。
警告
需谨慎使用 *
符号,因为它可能引入安全风险,允许来自任何 IP 的客户端自行汇报其 IP 地址。另外,它可能会导致部分直接连接 TiDB 的内部组件无法使用,例如 TiDB Dashboard。
--proxy-protocol-header-timeout
- PROXY Protocol 请求头读取超时时间
- 默认:5
- 单位:秒
注意
不要将该参数配置为 0
。除非特殊情况,一般使用默认值即可。
--report-status
- 用于打开或者关闭服务状态监听端口
- 默认:true
- 将参数值设置为
true
表明开启状态监听端口;设置为false
表明关闭状态监听端口
--run-ddl
- tidb-server 是否运行 DDL 语句,集群内至少需要有一台 tidb-server 设置该参数
- 默认:true
- 值可以为
true
或者false
。设置为true
表明自身会运行 DDL;设置为false
表明自身不会运行 DDL
--socket string
- TiDB 服务使用 unix socket file 方式接受外部连接
- 默认:""
- 例如可以使用 "/tmp/tidb.sock" 来打开 unix socket file
--status
- TiDB 服务状态监听端口
- 默认:"10080"
- 该端口用于展示 TiDB 内部数据,包括 prometheus 统计和 pprof
- Prometheus 统计可以通过
http://host:status_port/metrics
访问 - pprof 数据可以通过
http://host:status_port/debug/pprof
访问
--status-host
- TiDB 服务状态监听 host
- 默认:"0.0.0.0"
--store
- 用来指定 TiDB 底层使用的存储引擎
- 默认:"unistore"
- 可以选择 "unistore"(本地存储引擎)或者 "tikv"(分布式存储引擎)
--token-limit
- TiDB 中同时允许运行的 Session 数量,用于流量控制
- 默认:1000
- 如果当前运行的连接多于该 token-limit,那么请求会阻塞,等待已经完成的操作释放 Token
-V
- 输出 TiDB 的版本
- 默认:""
--plugin-dir
- plugin 存放目录
- 默认:"/data/deploy/plugin"
--plugin-load
- 需要加载的 plugin 名称,多个 plugin 以 "," 逗号分隔
- 默认:""
--affinity-cpus
- 设置 TiDB server CPU 亲和性,以 "," 逗号分隔,例如 "1,2,3"
- 默认:""
--repair-mode
- 是否开启修复模式,仅用于数据修复场景
- 默认:false
--repair-list
- 修复模式下需要修复的表名
- 默认:""
--require-secure-transport
- 是否要求客户端使用安全传输模式
- 默认:false
本页导航
- --advertise-address
- --config
- --config-check
- --config-strict
- --cors
- --host
- --enable-binlog
- -L
- --lease
- --log-file
- --log-slow-query
- --metrics-addr
- --metrics-interval
- -P
- --path
- --proxy-protocol-networks
- --proxy-protocol-header-timeout
- --report-status
- --run-ddl
- --socket string
- --status
- --status-host
- --store
- --token-limit
- -V
- --plugin-dir
- --plugin-load
- --affinity-cpus
- --repair-mode
- --repair-list
- --require-secure-transport
文档内容是否有帮助?