- 关于 TiDB
- 主要概念
- 操作指南
- 快速上手
- 部署
- 配置
- 安全
- 安全传输层协议 (TLS)
- 生成自签名证书
- 监控
- 迁移
- 运维
- Ansible 常见运维操作
- 备份与恢复
- 定位异常查询
- 扩容缩容
- 升级
- 故障诊断
- 参考手册
- SQL
- 与 MySQL 兼容性对比
- 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 INSTANCE
ALTER TABLE
ALTER USER
ANALYZE TABLE
BEGIN
CHANGE COLUMN
COMMIT
CREATE DATABASE
CREATE INDEX
CREATE ROLE
CREATE TABLE LIKE
CREATE TABLE
CREATE USER
CREATE VIEW
DEALLOCATE
DELETE
DESC
DESCRIBE
DO
DROP COLUMN
DROP DATABASE
DROP INDEX
DROP ROLE
DROP TABLE
DROP USER
DROP VIEW
EXECUTE
EXPLAIN ANALYZE
EXPLAIN
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
REVOKE <privileges>
REVOKE <role>
ROLLBACK
SELECT
SET DEFAULT ROLE
SET [NAMES|CHARACTER SET]
SET PASSWORD
SET ROLE
SET TRANSACTION
SET [GLOBAL|SESSION] <variable>
SHOW ANALYZE STATUS
SHOW CHARACTER SET
SHOW COLLATION
SHOW [FULL] COLUMNS FROM
SHOW CREATE TABLE
SHOW CREATE USER
SHOW DATABASES
SHOW ENGINES
SHOW ERRORS
SHOW [FULL] FIELDS FROM
SHOW GRANTS
SHOW INDEXES [FROM|IN]
SHOW INDEX [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW PRIVILEGES
SHOW [FULL] PROCESSSLIST
SHOW SCHEMAS
SHOW STATUS
SHOW [FULL] TABLES
SHOW TABLE REGIONS
SHOW TABLE STATUS
SHOW [GLOBAL|SESSION] VARIABLES
SHOW WARNINGS
SPLIT REGION
START TRANSACTION
TRACE
TRUNCATE
UPDATE
USE
- 约束
- 生成列
- 分区表
- 字符集
- SQL 模式
- 视图
- 配置
- tidb-server
- pd-server
- tikv-server
- 安全
- 事务
- 系统数据库
- 错误码
- 支持的连接器和 API
- 垃圾回收 (GC)
- 性能调优
- 监控指标
- 报警规则
- 最佳实践
- TiSpark 使用指南
- TiKV
- TiFlash
- TiDB Binlog
- 工具
- TiDB in Kubernetes
- 常见问题 (FAQ)
- 技术支持
- 贡献
- 版本发布历史
- 发布版本汇总
- v3.1
- v3.0
- v2.1
- v2.0
- v1.0
- 术语表
重要
你正在查看 TiDB 数据库的较旧版本 (TiDB v3.1) 的文档。
如无特殊需求,建议使用 TiDB 数据库的最新 LTS 版本。
TiDB 命令行参数
在启动 TiDB 时,你可以使用命令行参数或环境变量来配置 TiDB。本文将详细介绍 TiDB 的命令行启动参数。TiDB 的默认端口为 4000(客户端请求)与 10080(状态报告)。
--advertise-address
- 登录 TiDB 的 IP 地址
- 默认:""
- 必须确保用户和集群中的其他机器都能够访问到该 IP 地址
--binlog-socket
- TiDB 服务使用 unix socket file 方式接受内部连接,如 Pump 服务
- 默认:""
- 例如,可以使用 "/tmp/pump.sock" 来接受 Pump unix socket file 通信
--config
- 配置文件
- 默认:""
- 如果你指定了配置文件,TiDB 会首先读取配置文件的配置。如果对应的配置在命令行参数里面也存在,TiDB 就会使用命令行参数的配置来覆盖配置文件中的配置。详细的配置项请参阅 TiDB 配置文件描述。
--cors
- 用于设置 TiDB HTTP 状态服务的 Access-Control-Allow-Origin
- 默认:""
--host
- TiDB 服务监听的 host
- 默认:"0.0.0.0"
- 0.0.0.0 默认会监听所有的网卡地址。如果有多块网卡,可以指定对外提供服务的网卡,如 192.168.100.113
-L
- Log 级别
- 默认:"info"
- 可选项为:debug、info、warn、error、fatal
--log-file
- Log 文件
- 默认:""
- 如果未设置该参数,log 会默认输出到 "stderr";如果设置了该参数,log 会输出到对应的文件中。每天凌晨,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
- 对于本地存储引擎 "mocktikv" 来说,path 指定的是实际的数据存放路径
- 当
--store = tikv
时,必须指定 path;当--store = mocktikv
时,如果不指定 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=mocktikv --path=""
来启动一个纯内存引擎的 TiDB
--proxy-protocol-networks
- PROXY Protocol 允许的代理服务器地址列表。如需配置多个地址,用
,
分隔。 - 默认:""
- 如果该参数为空,TiDB 会禁用 PROXY Protocol 功能。地址可以使用 IP 地址 (192.168.1.50) 或者 CIDR (192.168.1.0/24),
*
代表所有地址。
--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 底层使用的存储引擎
- 默认:"mocktikv"
- 可以选择 "mocktikv"(本地存储引擎)或者 "tikv"(分布式存储引擎)
--token-limit
- TiDB 中同时允许运行的 Session 数量,用于流量控制
- 默认:1000
- 如果当前运行的连接多于该 token-limit,那么请求会阻塞,等待已经完成的操作释放 Token
-V
- 输出 TiDB 的版本
- 默认:""
文档内容是否有帮助?