docs-cn/TOC.md at master · pingcap/docs-cn · GitHub

Repository navigation

关于 TiDB
快速上手
部署标准集群
- 软硬件环境需求
- 环境与系统配置检查
- 规划集群拓扑
- 使用 TiUP 部署
- 在 Kubernetes 上部署
- 验证集群状态
- 测试集群性能
数据迁移
数据同步
- TiCDC 概述
- 安装部署与集群运维
- Changefeed
  - Changefeed 概述
  - 创建 Changefeed
  - 管理 Changefeed
  - 日志过滤器
  - 表路由
  - DDL 同步
  - 双向复制
- 监控告警
- 数据集成场景
- 参考指南
  - TiCDC 架构设计与原理
    - TiCDC 新架构
    - TiCDC 老架构
  - TiCDC 数据同步能力详解
  - TiCDC Server 配置参数
  - TiCDC Changefeed 配置参数
  - TiCDC 客户端鉴权
  - 单行数据正确性校验
  - 主从集群数据校验和快照读
  - 拆分 UPDATE 事件行为说明
  - 输出数据协议
  - TiCDC Open API v2
  - TiCDC Open API v1
  - TiCDC 数据消费
    - 基于 Avro 的 TiCDC 行数据 Checksum 校验
    - Storage sink 消费程序编写指引
  - TiCDC 兼容性
- 故障处理
- 常见问题解答
- 术语表
运维操作
- 安全加固
- 升级 TiDB 版本
- 扩缩容
  - 使用 TiUP（推荐）
  - 使用 TiDB Operator
- 备份与恢复
  - 备份与恢复概述
  - 架构设计
  - 使用 BR 进行备份与恢复
  - br cli 命令手册
  - 参考指南
- 集群容灾
- 资源管控
- 修改时区
- 日常巡检
- TiFlash 常用运维操作
- 使用 TiUP 运维集群
- 在线修改集群配置
- 在线有损恢复
- 搭建双集群主从复制
监控与告警
- 监控框架概述
- 监控 API
- 手动部署监控
- 升级监控组件
- TiDB Dashboard
  - 简介
  - 运维
  - 访问
  - 概况页面
  - 集群信息页面
  - Top SQL 页面
  - 流量可视化页面
  - 监控关系图
  - SQL 语句分析
    - 列表页面
    - 执行详情页面
  - 慢查询页面
  - 集群诊断页面
  - 监控指标页面
  - 日志搜索页面
  - 资源管控页面
  - 实例性能分析
    - 手动分析页面
    - 持续分析页面
  - 会话管理与配置
    - 分享会话
    - 配置 SSO 登录
  - 常见问题
- 将 Grafana 监控数据导出成快照
- TiDB 集群报警规则与处理方法
- TiFlash 报警规则与处理方法
- 自定义监控组件的配置
- BR 监控告警
故障诊断
- 故障诊断问题汇总
- 故障场景
- 故障诊断方法
- 获取支持
性能调优
- 优化手册
- 配置调优
  - 操作系统性能参数调优
  - TiDB 内存调优
  - TiKV 线程调优
  - TiKV 内存调优
  - TiKV Follower Read
  - TiKV MVCC 内存引擎
  - Region 性能调优
  - TiFlash 调优
  - 下推计算结果缓存
  - 垃圾回收 (GC)
    - GC 机制简介
    - GC 配置
- SQL 性能调优
  - SQL 性能调优概览
  - 理解 TiDB 执行计划
  - SQL 优化流程
  - 控制执行计划
  - 索引推荐 (Index Advisor)
教程
- 单区域多 AZ 部署
- 双区域多 AZ 部署
- 单区域双 AZ 部署
- 读取历史数据
  - 使用 Stale Read 功能读取历史数据（推荐）
  - 使用系统变量 tidb_snapshot 读取历史数据
- Placement Rules 使用文档
- Load Base Split 使用文档
- Store Limit 使用文档
- 数据批量处理
- PD 微服务使用文档
TiDB 工具
- 功能概览
- 使用场景
- 工具下载
- TiUP
  - 文档地图
  - 概览
  - 术语及核心概念
  - TiUP 组件管理
  - FAQ
  - 故障排查
  - TiUP 命令参考手册
  - TiDB 集群拓扑文件配置
  - DM 集群拓扑文件配置
  - TiUP 镜像参考指南
  - TiUP 组件文档
- TiDB Operator
- TiDB Data Migration
  - 关于 Data Migration
  - 架构简介
  - 快速上手
  - 最佳实践
  - 部署 DM 集群
  - 入门指南
    - 创建数据源
    - 数据源操作
    - 任务配置向导
    - 分库分表合并
    - 表路由
    - 黑白名单
    - 过滤 binlog 事件
    - 通过 SQL 表达式过滤 DML
    - Online DDL 工具支持
    - 自定义加解密 key
    - 迁移任务操作
  - 进阶教程
    - 分库分表合并迁移
    - 迁移使用 gh-ost/pt-osc 的数据源
    - 上下游列数量不一致的迁移
    - 增量数据校验
  - 运维管理
    - 集群版本升级
    - 集群运维工具
      - 使用 WebUI 管理迁移任务
      - 使用 dmctl 管理迁移任务
    - 性能调优
    - 数据源管理
      - 变更同步的数据源地址
    - 任务管理
      - 处理出错的 DDL 语句
      - 管理迁移表的表结构
    - 导出和导入集群的数据源和任务配置
    - 处理告警
    - 日常巡检
  - 参考手册
    - 架构组件
    - 运行机制
    - 命令行
      - DM-master & DM-worker
    - 配置文件
    - OpenAPI
    - 兼容性目录
    - 安全
      - 为 DM 的连接开启加密传输
      - 生成自签名证书
    - 监控告警
      - 监控指标
      - 告警信息
    - 错误码
    - 术语表
    - 使用示例
    - 异常解决
      - 常见问题
      - 错误处理及恢复
    - 版本发布历史
- TiDB Lightning
  - 概述
  - IMPORT INTO 和 TiDB Lightning 对比
  - IMPORT INTO 和 TiDB Lightning 与日志备份和 TiCDC 的兼容性
  - 快速上手
  - 部署 TiDB Lightning
  - 目标数据库要求
  - 数据源
  - 物理导入模式
  - 逻辑导入模式
  - 前置检查
  - 表库过滤
  - 断点续传
  - 并行导入
  - 可容忍错误
  - 故障处理
  - 参考手册
- Dumpling
- PingCAP Clinic 诊断服务
- sync-diff-inspector
- TiProxy
参考指南
- 架构
  - 概述
  - 存储
  - 计算
  - 调度
  - TSO
- 存储引擎 TiKV
  - TiKV 简介
  - RocksDB 简介
  - Titan 简介
  - Titan 配置说明
  - Partitioned Raft KV
- 存储引擎 TiFlash
  - TiFlash 简介
  - 构建 TiFlash 副本
  - 使用 TiDB 读取 TiFlash
  - 使用 MPP 模式
  - TiFlash 存算分离架构与 S3 支持
  - 使用 FastScan 功能
  - TiFlash 支持的计算下推
  - TiFlash 查询结果物化
  - TiFlash 延迟物化
  - TiFlash 数据落盘
  - TiFlash 数据校验
  - TiFlash MinTSO 调度器
  - TiFlash 兼容性说明
  - TiFlash Pipeline Model 执行模型
- TiDB 分布式执行框架
  - TiDB 分布式执行框架介绍
  - TiDB 全局排序
- 系统变量
- 系统变量索引
- 服务器状态变量
- 配置文件参数
  - tidb-server
  - tikv-server
  - tiflash-server
  - pd-server
- CLI
  - tikv-ctl
  - pd-ctl
  - tidb-ctl
  - pd-recover
- 命令行参数
  - tidb-server
  - tikv-server
  - tiflash-server
  - pd-server
- 监控指标
  - Overview 面板
  - Performance Overview 面板
  - TiDB 面板
  - PD 面板
  - TiKV 面板
  - TiFlash 监控指标
  - TiCDC 监控指标
  - Resource Control 监控指标
- 权限
  - 与 MySQL 安全特性差异
  - 权限管理
  - TiDB 用户账户管理
  - TiDB 密码管理
  - 基于角色的访问控制
  - TiDB 证书鉴权使用指南
- SQL
  - SQL 语言结构和语法
    - 属性
    - 字面值
    - Schema 对象名
    - 关键字
    - 用户自定义变量
    - 表达式语法
    - 注释语法
  - SQL 语句
    - 概览
    - ADMIN
    - ADMIN ALTER DDL JOBS
    - ADMIN CANCEL DDL
    - ADMIN CHECKSUM TABLE
    - ADMIN CHECK [TABLE|INDEX]
    - ADMIN CLEANUP
    - ADMIN PAUSE DDL
    - ADMIN RECOVER INDEX
    - ADMIN RESUME DDL
    - ADMIN [SET|SHOW|UNSET] BDR ROLE
    - ADMIN SHOW DDL [JOBS|JOB QUERIES]
    - ALTER DATABASE
    - ALTER INSTANCE
    - ALTER PLACEMENT POLICY
    - ALTER RANGE
    - ALTER RESOURCE GROUP
    - ALTER SEQUENCE
    - ALTER TABLE
      - 概述
      - ADD COLUMN
      - ADD INDEX
      - ALTER INDEX
      - CHANGE COLUMN
      - COMPACT
      - DROP COLUMN
      - DROP INDEX
      - MODIFY COLUMN
      - RENAME INDEX
    - ALTER USER
    - ANALYZE TABLE
    - BACKUP
    - BATCH
    - BEGIN
    - CALIBRATE RESOURCE
    - CANCEL DISTRIBUTION JOB
    - CANCEL IMPORT JOB
    - CANCEL TRAFFIC JOBS
    - COMMIT
    - CREATE BINDING
    - CREATE DATABASE
    - CREATE INDEX
    - CREATE PLACEMENT POLICY
    - CREATE RESOURCE GROUP
    - CREATE ROLE
    - CREATE SEQUENCE
    - CREATE TABLE LIKE
    - CREATE TABLE
    - CREATE USER
    - CREATE VIEW
    - DEALLOCATE
    - DELETE
    - DESC
    - DESCRIBE
    - DISTRIBUTE TABLE
    - DO
    - DROP BINDING
    - DROP DATABASE
    - DROP PLACEMENT POLICY
    - DROP RESOURCE GROUP
    - DROP ROLE
    - DROP SEQUENCE
    - DROP STATS
    - DROP TABLE
    - DROP USER
    - DROP VIEW
    - EXECUTE
    - EXPLAIN ANALYZE
    - EXPLAIN
    - FLASHBACK CLUSTER
    - FLASHBACK DATABASE
    - FLASHBACK TABLE
    - FLUSH PRIVILEGES
    - FLUSH STATS_DELTA
    - FLUSH STATUS
    - FLUSH TABLES
    - GRANT <privileges>
    - GRANT <role>
    - IMPORT INTO
    - INSERT
    - KILL
    - LOAD DATA
    - LOAD STATS
    - LOCK STATS
    - [LOCK|UNLOCK] TABLES
    - PREPARE
    - QUERY WATCH
    - RECOVER TABLE
    - REFRESH STATS
    - RENAME USER
    - RENAME TABLE
    - REPLACE
    - RESTORE
    - REVOKE <privileges>
    - REVOKE <role>
    - ROLLBACK
    - SAVEPOINT
    - SELECT
    - SET DEFAULT ROLE
    - SET [NAMES|CHARACTER SET]
    - SET PASSWORD
    - SET RESOURCE GROUP
    - SET ROLE
    - SET TRANSACTION
    - SET <variable>
    - SHOW AFFINITY
    - SHOW [BACKUPS|RESTORES]
    - SHOW ANALYZE STATUS
    - SHOW BINDINGS
    - SHOW BUILTINS
    - SHOW CHARACTER SET
    - SHOW COLLATION
    - SHOW COLUMN_STATS_USAGE
    - SHOW COLUMNS FROM
    - SHOW CONFIG
    - SHOW CREATE PLACEMENT POLICY
    - SHOW CREATE RESOURCE GROUP
    - SHOW CREATE SEQUENCE
    - SHOW CREATE TABLE
    - SHOW CREATE DATABASE
    - SHOW CREATE USER
    - SHOW DATABASES
    - SHOW DISTRIBUTION JOBS
    - SHOW ENGINES
    - SHOW ERRORS
    - SHOW FIELDS FROM
    - SHOW GRANTS
    - SHOW IMPORT JOB
    - SHOW INDEXES
    - SHOW MASTER STATUS
    - SHOW PLACEMENT
    - SHOW PLACEMENT FOR
    - SHOW PLACEMENT LABELS
    - SHOW PLUGINS
    - SHOW PRIVILEGES
    - SHOW PROCESSLIST
    - SHOW PROFILES
    - SHOW SCHEMAS
    - SHOW STATS_BUCKETS
    - SHOW STATS_HEALTHY
    - SHOW STATS_HISTOGRAMS
    - SHOW STATS_LOCKED
    - SHOW STATS_META
    - SHOW STATS_TOPN
    - SHOW STATUS
    - SHOW TABLE DISTRIBUTION
    - SHOW TABLE NEXT_ROW_ID
    - SHOW TABLE REGIONS
    - SHOW TABLE STATUS
    - SHOW TABLES
    - SHOW TRAFFIC JOBS
    - SHOW VARIABLES
    - SHOW WARNINGS
    - SHUTDOWN
    - SPLIT REGION
    - START TRANSACTION
    - TABLE
    - TRACE
    - TRAFFIC CAPTURE
    - TRAFFIC REPLAY
    - TRUNCATE
    - UNLOCK STATS
    - UPDATE
    - USE
    - WITH
  - 数据类型
    - 数据类型概述
    - 数据类型默认值
    - 数值类型
    - 日期和时间类型
    - 字符串类型
    - JSON 类型
    - 向量数据类型
  - 函数与操作符
    - 函数与操作符概述
    - 表达式求值的类型转换
    - 操作符
    - 控制流程函数
    - 字符串函数
    - 数值函数与操作符
    - 日期和时间函数
    - 位函数和操作符
    - Cast 函数和操作符
    - 加密和压缩函数
    - 锁函数
    - 信息函数
    - 向量函数和运算符
    - JSON 函数
      - 概览
      - 创建 JSON 的函数
      - 搜索 JSON 的函数
      - 修改 JSON 的函数
      - 返回 JSON 的函数
      - JSON 效用函数
      - 聚合 JSON 的函数
      - 验证 JSON 的函数
    - GROUP BY 聚合函数
    - GROUP BY 修饰符
    - 窗口函数
    - 序列函数
    - 效用函数
    - 其它函数
    - TiDB 特有的函数
    - 精度数学
    - 集合运算
    - 下推到 TiKV 的表达式列表
    - Oracle 与 TiDB 函数和语法差异对照
  - 聚簇索引
  - 全局索引
  - 向量索引
  - 约束
  - 生成列
  - SQL 模式
  - 表属性
  - 事务
    - 事务概览
    - 隔离级别
    - 乐观事务
    - 悲观事务
    - 非事务 DML 语句
    - Pipelined DML
  - 视图
  - 分区表
  - 临时表
  - 缓存表
  - 外键约束
  - 表级数据亲和性
  - 字符集和排序规则
    - 概述
    - GBK
    - GB18030
  - TTL (Time to Live)
  - Placement Rules in SQL
  - 系统表
    - mysql Schema
    - INFORMATION_SCHEMA
    - METRICS_SCHEMA
    - PERFORMANCE_SCHEMA
      - 概述
      - SESSION_CONNECT_ATTRS
    - SYS
      - 概述
      - schema_unused_indexes
  - 元数据锁
  - TiDB 加速建表
  - Schema 缓存
- 遥测
- 错误码
- 表库过滤
- TiDB 离线包
- 通过拓扑 label 进行副本调度
- 外部存储服务的 URI 格式
- TiDB Workload Repository
- 线上负载与 ADD INDEX 相互影响测试
- 内嵌于 DDL 的 Analyze
常见问题解答 (FAQ)
术语表