docs-cn/TOC.md at master · JaySon-Huang/docs-cn · GitHub

1209 lines (1208 loc) · 68.1 KB

文档中心
关于 TiDB
快速上手
应用开发
- 概览
- 快速开始
  - 使用 TiDB Serverless 构建 TiDB 集群
  - 使用 TiDB 的增删改查 SQL
- 示例程序
  - Java
    - JDBC
    - MyBatis
    - Hibernate
    - Spring Boot
  - Go
    - Go-MySQL-Driver
    - GORM
  - Python
  - Node.js
    - node-mysql2
    - mysql.js
    - Prisma
    - TypeORM
  - Ruby
    - mysql2
    - Rails
- 连接到 TiDB
- 数据库模式设计
- 数据写入
- 数据读取
  - 单表读取
  - 多表连接查询
  - 子查询
  - 查询结果分页
  - 视图
  - 临时表
  - 公共表表达式
  - 读取副本数据
    - Follower Read
    - Stale Read
  - HTAP 查询
- 事务
- 优化 SQL 性能
  - 概览
  - SQL 性能调优
  - 性能调优最佳实践
  - 索引的最佳实践
  - 其他优化
    - 避免隐式类型转换
    - 唯一序列号生成方案
- 故障诊断
- 引用文档
  - Bookshop 示例应用
  - 规范
    - 命名规范
    - SQL 开发规范
- 云原生开发环境
  - Gitpod
- 第三方工具支持
部署标准集群
- 软硬件环境需求
- 环境与系统配置检查
- 规划集群拓扑
- 安装与启动
  - 使用 TiUP 部署
  - 在 Kubernetes 上部署
- 验证集群状态
- 测试集群性能
数据迁移
数据集成
- 数据集成概述
- 数据集成场景
  - 与 Confluent Cloud 和 Snowflake 进行数据集成
  - 与 Apache Kafka 和 Apache Flink 进行数据集成
运维操作
- 升级 TiDB 版本
- 扩缩容
  - 使用 TiUP（推荐）
  - 使用 TiDB Operator
- 备份与恢复
  - 备份与恢复概述
  - 架构设计
  - 使用 BR 进行备份与恢复
  - br cli 命令手册
  - 参考指南
- 集群容灾
- 使用资源管控 (Resource Control) 实现资源隔离
- 修改时区
- 日常巡检
- TiFlash 常用运维操作
- 使用 TiUP 运维集群
- 在线修改集群配置
- 在线有损恢复
- 搭建双集群主从复制
监控与告警
故障诊断
- 故障诊断问题汇总
- 故障场景
- 故障诊断方法
- 获取支持
性能调优
- 优化手册
- 配置调优
  - 操作系统性能参数调优
  - TiDB 内存调优
  - TiKV 线程调优
  - TiKV 内存调优
  - TiKV Follower Read
  - Region 性能调优
  - TiFlash 调优
  - 下推计算结果缓存
  - 垃圾回收 (GC)
    - GC 机制简介
    - GC 配置
- SQL 性能调优
  - SQL 性能调优概览
  - 理解 TiDB 执行计划
  - SQL 优化流程
  - 控制执行计划
教程
- 单区域多 AZ 部署
- 双区域多 AZ 部署
- 单区域双 AZ 部署
- 读取历史数据
  - 使用 Stale Read 功能读取历史数据（推荐）
  - 使用系统变量 tidb_snapshot 读取历史数据
- 最佳实践
- Placement Rules 使用文档
- Load Base Split 使用文档
- Store Limit 使用文档
- DDL 执行原理及最佳实践
TiDB 工具
- 功能概览
- 使用场景
- 工具下载
- TiUP
  - 文档地图
  - 概览
  - 术语及核心概念
  - TiUP 组件管理
  - FAQ
  - 故障排查
  - TiUP 命令参考手册
  - TiDB 集群拓扑文件配置
  - DM 集群拓扑文件配置
  - TiUP 镜像参考指南
  - TiUP 组件文档
- TiDB Operator
- TiDB Data Migration
  - 关于 Data Migration
  - 架构简介
  - 快速开始
  - 最佳实践
  - 部署 DM 集群
  - 入门指南
    - 创建数据源
    - 数据源操作
    - 任务配置向导
    - 分库分表合并
    - 表路由
    - 黑白名单
    - 过滤 binlog 事件
    - 通过 SQL 表达式过滤 DML
    - Online DDL 工具支持
    - 迁移任务操作
  - 进阶教程
    - 分库分表合并迁移
    - 迁移使用 GH-ost/PT-osc 的数据源
    - 上下游列数量不一致的迁移
    - 增量数据校验
  - 运维管理
    - 集群版本升级
    - 集群运维工具
      - 使用 WebUI 管理迁移任务
      - 使用 dmctl 管理迁移任务
    - 性能调优
    - 数据源管理
      - 变更同步的数据源地址
    - 任务管理
      - 处理出错的 DDL 语句
      - 管理迁移表的表结构
    - 导出和导入集群的数据源和任务配置
    - 处理告警
    - 日常巡检
  - 参考手册
    - 架构组件
    - 运行机制
    - 命令行
      - DM-master & DM-worker
    - 配置文件
    - OpenAPI
    - 兼容性目录
    - 安全
      - 为 DM 的连接开启加密传输
      - 生成自签名证书
    - 监控告警
      - 监控指标
      - 告警信息
    - 错误码
    - 术语表
    - 使用示例
    - 异常解决
      - 常见问题
      - 错误处理及恢复
    - 版本发布历史
- TiDB Lightning
  - 概述
  - 快速上手
  - 部署 TiDB Lightning
  - 目标数据库要求
  - 数据源
  - 物理导入模式
  - 逻辑导入模式
  - 前置检查
  - 表库过滤
  - 断点续传
  - 并行导入
  - 可容忍错误
  - 故障处理
  - 参考手册
- Dumpling
- TiCDC
  - 概述
  - 安装部署与集群运维
  - Changefeed
  - 监控告警
  - 参考指南
    - 架构设计与原理
    - TiCDC Server 配置参数
    - TiCDC Changefeed 配置参数
    - 输出数据协议
    - TiCDC Open API v2
    - TiCDC Open API v1
    - TiCDC 数据消费
      - 基于 Avro 的 TiCDC 行数据 Checksum 校验
      - Storage sink 消费程序编写指引
    - 兼容性
  - 故障处理
  - 常见问题解答
  - 术语表
- TiDB Binlog
  - 概述
  - 快速上手
  - 部署使用
  - 运维管理
  - 配置说明
    - Pump
    - Drainer
  - 版本升级
  - 监控告警
  - 增量恢复
  - binlogctl 工具
  - Kafka 自定义开发
  - TiDB Binlog Relay Log
  - 集群间双向同步
  - 术语表
  - 故障诊断
    - 故障诊断
    - 常见错误修复
  - FAQ
- PingCAP Clinic 诊断服务
- TiSpark
  - TiSpark 用户指南
- sync-diff-inspector
参考指南
- 架构
  - 概述
  - 存储
  - 计算
  - 调度
  - TSO
- 存储引擎 TiKV
- 存储引擎 TiFlash
- TiDB 分布式执行框架
  - TiDB 分布式执行框架介绍
  - TiDB 全局排序
- 系统变量
- 配置文件参数
- CLI
  - tikv-ctl
  - pd-ctl
  - tidb-ctl
  - pd-recover
  - binlog-ctl
- 命令行参数
- 监控指标
- 安全加固
- 权限
- SQL
- UI
  - TiDB Dashboard
    - 简介
    - 运维
    - 访问
    - 概况页面
    - 集群信息页面
    - Top SQL 页面
    - 流量可视化页面
    - 监控关系图
    - SQL 语句分析
      - 列表页面
      - 执行详情页面
    - 慢查询页面
    - 集群诊断页面
    - 监控指标页面
    - 日志搜索页面
    - 资源管控页面
    - 实例性能分析
      - 手动分析页面
      - 持续分析页面
    - 会话管理与配置
      - 分享会话
      - 配置 SSO 登录
    - 常见问题
- 遥测
- 错误码
- 通过拓扑 label 进行副本调度
- 外部存储服务的 URI 格式
常见问题解答 (FAQ)
版本发布历史
- 发布版本汇总
- 版本发布时间线
- TiDB 版本规则
- TiDB 离线包
- v7.5
  - 7.5.0
- v7.4
  - 7.4.0-DMR
- v7.3
  - 7.3.0-DMR
- v7.2
  - 7.2.0-DMR
- v7.1
  - 7.1.3
  - 7.1.2
  - 7.1.1
  - 7.1.0
- v7.0
  - 7.0.0-DMR
- v6.6
  - 6.6.0-DMR
- v6.5
  - 6.5.7
  - 6.5.6
  - 6.5.5
  - 6.5.4
  - 6.5.3
  - 6.5.2
  - 6.5.1
  - 6.5.0
- v6.4
  - 6.4.0-DMR
- v6.3
  - 6.3.0-DMR
- v6.2
  - 6.2.0-DMR
- v6.1
  - 6.1.7
  - 6.1.6
  - 6.1.5
  - 6.1.4
  - 6.1.3
  - 6.1.2
  - 6.1.1
  - 6.1.0
- v6.0
  - 6.0.0-DMR
- v5.4
  - 5.4.3
  - 5.4.2
  - 5.4.1
  - 5.4.0
- v5.3
  - 5.3.4
  - 5.3.3
  - 5.3.2
  - 5.3.1
  - 5.3.0
- v5.2
  - 5.2.4
  - 5.2.3
  - 5.2.2
  - 5.2.1
  - 5.2.0
- v5.1
  - 5.1.5
  - 5.1.4
  - 5.1.3
  - 5.1.2
  - 5.1.1
  - 5.1.0
- v5.0
  - 5.0.6
  - 5.0.5
  - 5.0.4
  - 5.0.3
  - 5.0.2
  - 5.0.1
  - 5.0 GA
  - 5.0.0-rc
- v4.0
  - 4.0.16
  - 4.0.15
  - 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
术语表