TOC.md

TiDB 中文用户文档

目录

• 关于 TiDB
  • TiDB 简介
  • TiDB 5.1 Release Notes
  • 基本功能
  • 实验特性
  • 性能测试报告
    • Sysbench 性能对比 - v5.1 对比 v5.0
    • TPC-C 性能对比 - v5.1 对比 v5.0
    • TPC-H 100 性能对比 - v5.1 MPP 对比 Greenplum / Apache Spark
  • 与 MySQL 的兼容性
  • 使用限制
  • 荣誉列表
• 快速上手
  • 快速上手 TiDB
  • 快速上手 HTAP
  • SQL 基本操作
  • 深入探索 HTAP
• 部署标准集群
  • 软硬件环境需求
  • 环境与系统配置检查
  • 规划集群拓扑
    • 最小部署拓扑结构
    • TiFlash 部署拓扑
    • TiCDC 部署拓扑
    • TiDB Binlog 部署拓扑
    • TiSpark 部署拓扑
    • 跨机房部署拓扑结构
    • 混合部署拓扑结构
  • 安装与启动
    • 使用 TiUP 部署（推荐）
    • 在 Kubernetes 上部署
  • 验证集群状态
  • 测试集群性能
    • 用 Sysbench 测试 TiDB
    • 对 TiDB 进行 TPC-C 测试
• 数据迁移
  • 概述
  • 从 MySQL 迁移至 TiDB
    • 使用 TiDB Lightning 从 Amazon Aurora MySQL 迁移全量数据
    • 使用 TiDB Lightning 从 MySQL SQL 文件迁移全量数据
    • 使用 DM 工具从 Amazon Aurora MySQL 迁移数据
  • 从 CSV 文件迁移至 TiDB
    • 使用 TiDB Lightning 导入 CSV 文件
    • 使用 LOAD DATA 语句导入 CSV 文件
  • 从 SQL 文件迁移到 TiDB
  • 将 TiDB 集群的增量数据同步到另一集群
• 运维操作
  • 升级 TiDB 版本
    • 使用 TiUP 升级（推荐）
    • 使用 TiDB Operator
  • 扩缩容
    • 使用 TiUP（推荐）
    • 使用 TiDB Operator
  • 备份与恢复
    • 使用 BR 工具（推荐）
      • BR 工具简介
      • 使用 BR 命令行备份恢复
      • BR 备份恢复场景示例
      • 外部存储
      • BR 常见问题
  • 修改时区
  • 日常巡检
  • TiFlash 常用运维操作
  • 使用 TiUP 运维集群
  • 在线修改集群配置
• 监控与告警
  • 监控框架概述
  • 监控 API
  • 手动部署监控
  • 将 Grafana 监控数据导出成快照
  • TiDB 集群报警规则与处理方法
  • TiFlash 报警规则与处理方法
• 故障诊断
  • 定位慢查询
  • 分析慢查询
  • SQL 诊断
  • 定位消耗系统资源多的查询
  • SQL 语句统计
  • TiDB 集群常见问题
  • TiDB 集群问题导图
  • 热点问题处理
  • CPU 占用过多导致读写延迟增加
  • 写冲突与写性能下降
  • 磁盘 I/O 过高
  • 锁冲突与 TTL 超时
  • TiFlash 常见问题
• 性能调优
  • 系统调优
    • 操作系统性能参数调优
  • 软件调优
    • 配置
      • TiDB 内存调优
      • TiKV 线程调优
      • TiKV 内存调优
      • TiKV Follower Read
      • TiFlash 调优
    • 下推计算结果缓存
  • SQL 性能调优
    • SQL 性能调优概览
    • 理解 TiDB 执行计划
      • TiDB 执行计划概览
      • MPP 模式查询的执行计划
    • SQL 优化流程
      • SQL 优化流程概览
      • 逻辑优化
        • 逻辑优化概览
        • 子查询相关的优化
        • 列裁剪
        • 关联子查询去关联
        • Max/Min 消除
        • 谓词下推
        • 分区裁剪
        • TopN 和 Limit 下推
        • Join Reorder
      • 物理优化
        • 物理优化概览
        • 索引的选择
        • 统计信息简介
        • 错误索引的解决方案
        • Distinct 优化
      • 执行计划缓存
    • 控制执行计划
      • 控制执行计划概览
      • Optimizer Hints
      • 执行计划管理
      • 优化规则及表达式下推的黑名单
• 教程
  • 同城多中心部署
  • 两地三中心部署
  • 同城两中心部署
  • 读取历史数据
    • 使用 Stale Read 功能读取历史数据（推荐）
      • Stale Read 使用场景介绍
      • 使用 AS OF TIMESTAMP 语法读取历史数据
    • 使用系统变量 tidb_snapshot 读取历史数据
  • 最佳实践
    • TiDB 最佳实践
    • Java 应用开发最佳实践
    • HAProxy 最佳实践
    • 高并发写入场景最佳实践
    • Grafana 监控最佳实践
    • PD 调度策略最佳实践
    • 海量 Region 集群调优
    • 三节点混合部署最佳实践
    • 在三数据中心下就近读取数据
  • Placement Rules 使用文档
  • Load Base Split 使用文档
  • Store Limit 使用文档
• TiDB 生态工具
  • 功能概览
  • 适用场景
  • 工具下载
  • Backup & Restore (BR)
    • BR 工具简介
    • 使用 BR 命令行备份恢复
    • BR 备份与恢复场景示例
    • 外部存储
    • BR 常见问题
  • TiDB Binlog
    • 概述
    • 快速上手
    • 部署使用
    • 运维管理
    • 配置说明
      • Pump
      • Drainer
    • 版本升级
    • 监控告警
    • 增量恢复
    • binlogctl 工具
    • Kafka 自定义开发
    • TiDB Binlog Relay Log
    • 集群间双向同步
    • 术语表
    • 故障诊断
      • 故障诊断
      • 常见错误修复
    • FAQ
  • TiDB Lightning
    • 概述
    • 快速上手教程
    • 部署执行
    • 参数说明
    • 主要功能
      • 断点续传
      • 表库过滤
      • CSV 支持
      • 后端
      • Web 界面
    • 监控告警
    • FAQ
    • 术语表
  • TiCDC
    • 概述
    • 安装部署
    • 运维管理
    • 故障诊断
    • 监控指标
    • TiCDC Open API
    • TiCDC Open Protocol
    • 将 TiDB 集成到 Confluent Platform
    • 术语表
  • Dumpling
  • sync-diff-inspector
    • 概述
    • 不同库名或表名的数据校验
    • 分库分表场景下的数据校验
    • TiDB 主从集群的数据校验
  • TiSpark
    • TiSpark 快速上手
    • TiSpark 用户指南
• 参考指南
  • 架构
    • 概述
    • 存储
    • 计算
    • 调度
  • 监控指标
    • Overview 面板
    • TiDB 面板
    • PD 面板
    • TiKV 面板
    • TiFlash 监控指标
    • TiCDC 监控指标
  • 安全加固
    • 为 TiDB 客户端服务端间通信开启加密传输
    • 为 TiDB 组件间通信开启加密传输
    • 生成自签名证书
    • 静态加密
    • 为 TiDB 落盘文件开启加密
    • 日志脱敏
  • 权限
    • 与 MySQL 安全特性差异
    • 权限管理
    • TiDB 用户账户管理
    • 基于角色的访问控制
    • TiDB 证书鉴权使用指南
  • SQL
    • SQL 语言结构和语法
      • 属性
        • AUTO_INCREMENT
        • AUTO_RANDOM
        • SHARD_ROW_ID_BITS
      • 字面值
      • Schema 对象名
      • 关键字
      • 用户自定义变量
      • 表达式语法
      • 注释语法
    • 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
      • WITH
    • 数据类型
      • 数据类型概述
      • 数据类型默认值
      • 数值类型
      • 日期和时间类型
      • 字符串类型
      • JSON 类型
    • 函数与操作符
      • 函数与操作符概述
      • 表达式求值的类型转换
      • 操作符
      • 控制流程函数
      • 字符串函数
      • 数值函数与操作符
      • 日期和时间函数
      • 位函数和操作符
      • Cast 函数和操作符
      • 加密和压缩函数
      • 信息函数
      • JSON 函数
      • GROUP BY 聚合函数
      • 窗口函数
      • 其它函数
      • 精度数学
      • 集合运算
      • 下推到 TiKV 的表达式列表
      • TiDB 特有的函数
    • 聚簇索引
    • 约束
    • 生成列
    • SQL 模式
    • 事务
      • 事务概览
      • 隔离级别
      • 乐观事务
      • 悲观事务
    • 垃圾回收 (GC)
      • GC 机制简介
      • 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
        • DATA_LOCK_WAITS
        • DDL_JOBS
        • DEADLOCKS
        • 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
        • TIDB_TRX
        • TIFLASH_REPLICA
        • TIKV_REGION_PEERS
        • TIKV_REGION_STATUS
        • TIKV_STORE_STATUS
        • USER_PRIVILEGES
        • VIEWS
      • METRICS_SCHEMA
  • UI
    • TiDB Dashboard
      • 简介
      • 运维
        • 部署
        • 反向代理
        • 安全
      • 访问
      • 概况页面
      • 集群信息页面
      • 流量可视化页面
      • 监控关系图
      • SQL 语句分析
        • 列表页面
        • 执行详情页面
      • 慢查询页面
      • 集群诊断页面
        • 访问
        • 查看报告
        • 使用示例
      • 日志搜索页面
      • 实例性能分析页面
      • 会话管理与配置
        • 分享会话
        • 配置 SSO 登录
      • 常见问题
  • CLI
    • tikv-ctl
    • pd-ctl
    • tidb-ctl
    • pd-recover
    • binlog-ctl
  • 命令行参数
    • tidb-server
    • tikv-server
    • tiflash-server
    • pd-server
  • 配置文件参数
    • tidb-server
    • tikv-server
    • tiflash-server
    • pd-server
  • 系统变量
  • 存储引擎
    • TiKV
      • TiKV 简介
      • RocksDB 简介
      • Titan 简介
      • Titan 配置说明
    • TiFlash
      • TiFlash 简介
      • 使用 TiFlash
  • TiUP
    • 文档地图
    • 概览
    • 术语及核心概念
    • TiUP 组件管理
    • FAQ
    • 故障排查
    • 参考手册
    • TiDB 集群拓扑文件配置
    • TiUP 镜像参考指南
    • TiUP 组件文档
      • tiup-playground 运行本地测试集群
      • tiup-cluster 部署运维生产集群
      • tiup-mirror 定制离线镜像
      • tiup-bench 进行 TPCC/TPCH 压力测试
  • 遥测
  • 错误码
  • 通过拓扑 label 进行副本调度
• 常见问题解答 (FAQ)
  • 产品 FAQ
  • SQL FAQ
  • 部署运维 FAQ
  • 升级 FAQ
  • 高可用 FAQ
  • 高可靠 FAQ
  • 迁移 FAQ
• 术语表
• 版本发布历史
  • 发布版本汇总
  • v5.1
    • 5.1.1
    • 5.1.0
  • v5.0
    • 5.0.3
    • 5.0.2
    • 5.0.1
    • 5.0 GA
    • 5.0.0-rc
  • v4.0
    • 4.0.14
    • 4.0.13
    • 4.0.12
    • 4.0.11
    • 4.0.10
    • 4.0.9
    • 4.0.8
    • 4.0.7
    • 4.0.6
    • 4.0.5
    • 4.0.4
    • 4.0.3
    • 4.0.2
    • 4.0.1
    • 4.0 GA
    • 4.0.0-rc.2
    • 4.0.0-rc.1
    • 4.0.0-rc
    • 4.0.0-beta.2
    • 4.0.0-beta.1
    • 4.0.0-beta
  • v3.1
    • 3.1.2
    • 3.1.1
    • 3.1.0 GA
    • 3.1.0-rc
    • 3.1.0-beta.2
    • 3.1.0-beta.1
    • 3.1.0-beta
  • v3.0
    • 3.0.20
    • 3.0.19
    • 3.0.18
    • 3.0.17
    • 3.0.16
    • 3.0.15
    • 3.0.14
    • 3.0.13
    • 3.0.12
    • 3.0.11
    • 3.0.10
    • 3.0.9
    • 3.0.8
    • 3.0.7
    • 3.0.6
    • 3.0.5
    • 3.0.4
    • 3.0.3
    • 3.0.2
    • 3.0.1
    • 3.0 GA
    • 3.0.0-rc.3
    • 3.0.0-rc.2
    • 3.0.0-rc.1
    • 3.0.0-beta.1
    • 3.0.0-beta
  • v2.1
    • 2.1.19
    • 2.1.18
    • 2.1.17
    • 2.1.16
    • 2.1.15
    • 2.1.14
    • 2.1.13
    • 2.1.12
    • 2.1.11
    • 2.1.10
    • 2.1.9
    • 2.1.8
    • 2.1.7
    • 2.1.6
    • 2.1.5
    • 2.1.4
    • 2.1.3
    • 2.1.2
    • 2.1.1
    • 2.1 GA
    • 2.1 RC5
    • 2.1 RC4
    • 2.1 RC3
    • 2.1 RC2
    • 2.1 RC1
    • 2.1 Beta
  • v2.0
    • 2.0.11
    • 2.0.10
    • 2.0.9
    • 2.0.8
    • 2.0.7
    • 2.0.6
    • 2.0.5
    • 2.0.4
    • 2.0.3
    • 2.0.2
    • 2.0.1
    • 2.0
    • 2.0 RC5
    • 2.0 RC4
    • 2.0 RC3
    • 2.0 RC1
    • 1.1 Beta
    • 1.1 Alpha
  • v1.0
    • 1.0
    • Pre-GA
    • RC4
    • RC3
    • RC2
    • RC1