Skip to content

Commit

Permalink
*: simplify all file directories for master (pingcap#3092)
Browse files Browse the repository at this point in the history
* *: simplify all file directories

* update deadlink

* fix 2 dead links caused by two deleted files

Co-authored-by: Qiang Zhou <[email protected]>
  • Loading branch information
yikeke and zhouqiang-cl authored May 13, 2020
1 parent 17dac05 commit ab8c0b5
Show file tree
Hide file tree
Showing 394 changed files with 1,233 additions and 2,425 deletions.
804 changes: 402 additions & 402 deletions TOC.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ TiDB 具备如下特性:

- 高度兼容 MySQL

[大多数情况下](/reference/mysql-compatibility.md),无需修改代码即可从 MySQL 轻松迁移至 TiDB,分库分表后的 MySQL 集群亦可通过 TiDB 工具进行实时迁移。
[大多数情况下](/mysql-compatibility.md),无需修改代码即可从 MySQL 轻松迁移至 TiDB,分库分表后的 MySQL 集群亦可通过 TiDB 工具进行实时迁移。

- 水平弹性扩展

Expand All @@ -33,7 +33,7 @@ TiDB 具备如下特性:

TiDB 是为云而设计的数据库,支持公有云、私有云和混合云,使部署、配置和维护变得十分简单。

TiDB 的设计目标是 100% 的 OLTP 场景和 80% 的 OLAP 场景,更复杂的 OLAP 分析可以通过 [TiSpark 项目](/reference/tispark.md)来完成。
TiDB 的设计目标是 100% 的 OLTP 场景和 80% 的 OLAP 场景,更复杂的 OLAP 分析可以通过 [TiSpark 项目](/tispark-overview.md)来完成。

TiDB 对业务没有任何侵入性,能优雅的替换传统的数据库中间件、数据库分库分表等 Sharding 方案。同时它也让开发运维人员不用关注数据库 Scale 的细节问题,专注于业务开发,极大的提升研发的生产力。

Expand All @@ -47,9 +47,9 @@ TiDB 对业务没有任何侵入性,能优雅的替换传统的数据库中间

TiDB 可以部署在本地和云平台上,支持公有云、私有云和混合云。你可以根据实际场景或需求,选择相应的方式来部署 TiDB 集群:

- [使用 TiUP 部署](/how-to/deploy/orchestrated/tiup.md):如果用于生产环境,推荐使用 TiUP 部署 TiDB 集群。
- [使用 Docker Compose 部署](/how-to/get-started/deploy-tidb-from-docker-compose.md):如果你只是想测试 TiDB、体验 TiDB 的特性,或者用于开发环境,可以使用 Docker Compose 在本地快速部署 TiDB 集群。该部署方式不适用于生产环境。
- [使用 Docker 部署](/how-to/deploy/orchestrated/docker.md):你可以使用 Docker 部署 TiDB 集群,但该部署方式不适用于生产环境。
- [使用 TiUP 部署](/production-deployment-using-tiup.md):如果用于生产环境,推荐使用 TiUP 部署 TiDB 集群。
- [使用 Docker Compose 部署](/deploy-test-cluster-using-docker-compose.md):如果你只是想测试 TiDB、体验 TiDB 的特性,或者用于开发环境,可以使用 Docker Compose 在本地快速部署 TiDB 集群。该部署方式不适用于生产环境。
- [使用 Docker 部署](/test-deployment-using-docker.md):你可以使用 Docker 部署 TiDB 集群,但该部署方式不适用于生产环境。
- [使用 TiDB Operator 部署](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-operator/):使用 TiDB Operator 在 Kubernetes 集群上部署生产就绪的 TiDB 集群,支持[部署到 AWS EKS](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-aws-eks/)[部署到谷歌云 GKE (beta)](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-gcp-gke/)[部署到阿里云 ACK](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-alibaba-cloud/) 等。
- [使用 TiDB Operator 部署到 Minikube](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-minikube/):你可以使用 TiDB Operator 将 TiDB 集群部署到本地 Minikube 启动的 Kubernetes 集群中。该部署方式不适用于生产环境。
- [使用 TiDB Operator 部署到 kind](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-kind/):你可以使用 TiDB Operator 将 TiDB 集群部署到以 kind 方式启动的 Kubernetes 本地集群中。该部署方式不适用于生产环境。
Expand Down
2 changes: 1 addition & 1 deletion reference/alert-rules.md → alert-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -805,7 +805,7 @@ category: reference

## TiDB Binlog 报警规则

关于 TiDB Binlog 报警规则的详细描述,参见 [TiDB Binlog 集群监控报警文档](/reference/tidb-binlog/monitor.md#监控报警规则)
关于 TiDB Binlog 报警规则的详细描述,参见 [TiDB Binlog 集群监控报警文档](/tidb-binlog/monitor-tidb-binlog-cluster.md#监控报警规则)

## Node_exporter 主机报警规则

Expand Down
4 changes: 2 additions & 2 deletions reference/sql/attributes/auto-random.md → auto-random.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ category: reference
>
> 当前 `AUTO_RANDOM` 属性为实验功能,**不建议在生产环境中使用**。在后续版本中,`AUTO_RANDOM` 的语法或语义可能会变化。
使用 `AUTO_RANDOM` 功能前,须在 TiDB 配置文件 `experimental` 部分设置 `allow-auto-random = true`。该参数详情可参见 [`allow-auto-random`](/reference/configuration/tidb-server/configuration-file.md#allow-auto-random)
使用 `AUTO_RANDOM` 功能前,须在 TiDB 配置文件 `experimental` 部分设置 `allow-auto-random = true`。该参数详情可参见 [`allow-auto-random`](/tidb-configuration-file.md#allow-auto-random)

## 使用场景

`AUTO_RANDOM` 用于解决大批量写数据入 TiDB 时因含有**整型自增主键列**的表而产生的热点问题。详情参阅 [TiDB 高并发写入场景最佳实践](/reference/best-practices/high-concurrency.md)
`AUTO_RANDOM` 用于解决大批量写数据入 TiDB 时因含有**整型自增主键列**的表而产生的热点问题。详情参阅 [TiDB 高并发写入场景最佳实践](/best-practices/high-concurrency-best-practices.md)

以下面语句建立的表为例:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs-cn/dev/how-to/maintain/backup-and-restore/']

# 使用 Mydumper/TiDB Lightning 进行备份与恢复

本文档将详细介绍如何使用 Mydumper/TiDB Lightning 对 TiDB 进行全量备份与恢复。增量备份与恢复可使用 [TiDB Binlog](/reference/tidb-binlog/overview.md)
本文档将详细介绍如何使用 Mydumper/TiDB Lightning 对 TiDB 进行全量备份与恢复。增量备份与恢复可使用 [TiDB Binlog](/tidb-binlog/tidb-binlog-overview.md)

这里假定 TiDB 服务信息如下:

Expand All @@ -16,18 +16,18 @@ aliases: ['/docs-cn/dev/how-to/maintain/backup-and-restore/']

在这个备份恢复过程中,会用到下面的工具:

- [Mydumper](/reference/tools/mydumper.md) 从 TiDB 导出数据
- [TiDB Lightning](/reference/tools/tidb-lightning/overview.md) 导入数据到 TiDB
- [Mydumper](/mydumper-overview.md) 从 TiDB 导出数据
- [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 导入数据到 TiDB

## 使用 Mydumper/TiDB Lightning 全量备份恢复数据

`mydumper` 是一个强大的数据备份工具,具体可以参考 [`maxbube/mydumper`](https://github.com/maxbube/mydumper)

可使用 [Mydumper](/reference/tools/mydumper.md) 从 TiDB 导出数据进行备份,然后用 [TiDB Lightning](/reference/tools/tidb-lightning/overview.md) 将其导入到 TiDB 里面进行恢复。
可使用 [Mydumper](/mydumper-overview.md) 从 TiDB 导出数据进行备份,然后用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 将其导入到 TiDB 里面进行恢复。

> **注意:**
>
> PingCAP 研发团队对 `mydumper` 进行了针对 TiDB 的适配性改造,建议使用 PingCAP 官方提供的 [Mydumper](/reference/tools/mydumper.md)。由于使用 `mysqldump` 进行数据备份和恢复都要耗费许多时间,这里也并不推荐。
> PingCAP 研发团队对 `mydumper` 进行了针对 TiDB 的适配性改造,建议使用 PingCAP 官方提供的 [Mydumper](/mydumper-overview.md)。由于使用 `mysqldump` 进行数据备份和恢复都要耗费许多时间,这里也并不推荐。
### Mydumper/TiDB Lightning 全量备份恢复最佳实践

Expand Down Expand Up @@ -59,7 +59,7 @@ aliases: ['/docs-cn/dev/how-to/maintain/backup-and-restore/']

就再执行两步命令:

1. 执行 `mydumper` 命令前,查询 TiDB 集群的 [GC](/reference/garbage-collection/overview.md) 值并使用 MySQL 客户端将其调整为合适的值:
1. 执行 `mydumper` 命令前,查询 TiDB 集群的 [GC](/garbage-collection-overview.md) 值并使用 MySQL 客户端将其调整为合适的值:

{{< copyable "sql" >}}

Expand Down Expand Up @@ -92,4 +92,4 @@ aliases: ['/docs-cn/dev/how-to/maintain/backup-and-restore/']

## 向 TiDB 恢复数据

使用 TiDB Lightning 将之前导出的数据导入到 TiDB,完成恢复操作。具体的使用方法见 [TiDB Lightning 使用文档](/reference/tools/tidb-lightning/tidb-backend.md)
使用 TiDB Lightning 将之前导出的数据导入到 TiDB,完成恢复操作。具体的使用方法见 [TiDB Lightning 使用文档](/tidb-lightning/tidb-lightning-tidb-backend.md)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ category: how-to

# TiDB 中的基本 SQL 操作

成功部署 TiDB 集群之后,便可以在 TiDB 中执行 SQL 语句了。因为 TiDB 兼容 MySQL,你可以使用 MySQL 客户端连接 TiDB,并且[大多数情况下](/reference/mysql-compatibility.md)可以直接执行 MySQL 语句。
成功部署 TiDB 集群之后,便可以在 TiDB 中执行 SQL 语句了。因为 TiDB 兼容 MySQL,你可以使用 MySQL 客户端连接 TiDB,并且[大多数情况下](/mysql-compatibility.md)可以直接执行 MySQL 语句。

本文介绍 CRUD 操作等基本的 SQL 语句。完整的 SQL 语句列表,参见 [TiDB SQL 语法详解](https://pingcap.github.io/sqlgram/)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ category: benchmark

## 测试环境

- [硬件要求](/how-to/deploy/hardware-recommendations.md)
- [硬件要求](/hardware-and-software-requirements.md)

- 参考 [TiDB 部署文档](https://pingcap.com/docs-cn/v3.0/how-to/deploy/orchestrated/ansible/)部署 TiDB 集群。在 3 台服务器的条件下,建议每台机器部署 1 个 TiDB,1 个 PD,和 1 个 TiKV 实例。关于磁盘,以 32 张表、每张表 10M 行数据为例,建议 TiKV 的数据目录所在的磁盘空间大于 512 GB。
对于单个 TiDB 的并发连接数,建议控制在 500 以内,如需增加整个系统的并发压力,可以增加 TiDB 实例,具体增加的 TiDB 个数视测试压力而定。
Expand Down Expand Up @@ -86,7 +86,7 @@ sync-log = false
capacity = "30GB"
```

更详细的 TiKV 参数调优请参考 [TiKV 性能参数调优](/reference/performance/tune-tikv.md)
更详细的 TiKV 参数调优请参考 [TiKV 性能参数调优](/tune-tikv-performance.md)

## 测试过程

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ enabled = true

### TiKV 配置

开始可以使用基本的配置,压测运行后可以通过观察 Grafana 并参考 [TiKV 调优说明](/reference/performance/tune-tikv.md)进行调整。
开始可以使用基本的配置,压测运行后可以通过观察 Grafana 并参考 [TiKV 调优说明](/tune-tikv-performance.md)进行调整。

### BenchmarkSQL 配置

Expand Down Expand Up @@ -183,11 +183,11 @@ fileLocation=/home/user/csv/tpcc. # 存储 csv 文件的目录绝对路径 +

#### 通过 Lightning 导入

通过 Lightning 导入数据请参考 [Lightning 部署执行](/reference/tools/tidb-lightning/deployment.md)章节。这里我们介绍下通过 TiDB Ansible 部署 Lightning 导入数据的方法。
通过 Lightning 导入数据请参考 [Lightning 部署执行](/tidb-lightning/deploy-tidb-lightning.md)章节。这里我们介绍下通过 TiDB Ansible 部署 Lightning 导入数据的方法。

##### 修改 inventory.ini

这里最好手动指定清楚部署的 IP、端口、目录,避免各种冲突问题带来的异常,其中 import_dir 的磁盘空间参考 [Lightning 部署执行](/reference/tools/tidb-lightning/deployment.md),data_source_dir 就是存储上一节 csv 数据的目录。
这里最好手动指定清楚部署的 IP、端口、目录,避免各种冲突问题带来的异常,其中 import_dir 的磁盘空间参考 [Lightning 部署执行](/tidb-lightning/deploy-tidb-lightning.md),data_source_dir 就是存储上一节 csv 数据的目录。

```ini
[importer_server]
Expand Down
File renamed without changes.
File renamed without changes.
210 changes: 0 additions & 210 deletions benchmark/sysbench.md

This file was deleted.

Loading

0 comments on commit ab8c0b5

Please sign in to comment.