Skip to content

Commit

Permalink
add summary for release notes (pingcap#17149)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oreoxmt authored May 8, 2024
1 parent cbd2788 commit 4ed9b8b
Show file tree
Hide file tree
Showing 247 changed files with 1,849 additions and 1,610 deletions.
397 changes: 199 additions & 198 deletions best-practices/tidb-best-practices.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions choose-index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 索引的选择
summary: 介绍 TiDB 如何选择索引去读入数据,以及相关的一些控制索引选择的方式。
aliases: ['/docs-cn/dev/choose-index/']
---

Expand Down
1 change: 1 addition & 0 deletions configure-memory-usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: TiDB 内存控制文档
aliases: ['/docs-cn/dev/configure-memory-usage/','/docs-cn/dev/how-to/configure/memory-control/']
summary: TiDB 内存控制文档介绍了如何追踪和控制 SQL 查询过程中的内存使用情况,以及配置内存使用阈值和 tidb-server 实例的内存使用阈值。还介绍了使用 INFORMATION_SCHEMA 系统表查看内存使用情况,以及降低写入事务内存使用的方法。另外还介绍了流量控制和数据落盘的内存控制策略,以及通过设置环境变量 GOMEMLIMIT 缓解 OOM 问题。
---

# TiDB 内存控制文档
Expand Down
90 changes: 45 additions & 45 deletions ecosystem-tool-user-case.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
---
title: TiDB 工具的使用场景
summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。
aliases: ['/docs-cn/dev/ecosystem-tool-user-case/']
---

# TiDB 工具的使用场景

本文档从数据迁移工具的使用场景出发,介绍部分常见场景下的迁移工具的选择。

## 在物理机或虚拟机上部署运维 TiDB

当需要在物理机或虚拟机上部署运维 TiDB 时,你可以先安装 [TiUP](/tiup/tiup-overview.md),再通过 TiUP 管理 TiDB 的众多组件,如 TiDB、PD、TiKV 等。

## 在 Kubernetes 上部署运维 TiDB

当需要在 Kubernetes 上部署运维 TiDB 时,你可以先创建 Kubernetes 集群,部署[TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable),然后使用 TiDB Operator 部署运维 TiDB 集群。

## 从 CSV 导入数据到 TiDB

当需要将其他工具导出的格式兼容的 CSV files 导入到 TiDB 时,可使用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md)

## 从 MySQL/Aurora 导入全量数据

当需要从 MySQL/Aurora 导入全量数据时,可先使用 [Dumpling](/dumpling-overview.md) 将数据导出为 SQL dump files,然后再使用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 将数据导入到 TiDB 集群。

## 从 MySQL/Aurora 迁移数据

当既需要从 MySQL/Aurora 导入全量数据,又需要迁移增量数据时,可使用 [TiDB Data Migration (DM)](/dm/dm-overview.md) 完成[从 Amazon Aurora 迁移数据到 TiDB](/migrate-aurora-to-tidb.md)

如果全量数据量较大(TB 级别),则可先使用 [Dumpling](/dumpling-overview.md)[TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 完成全量数据的迁移,再使用 DM 完成增量数据的迁移。

## TiDB 集群备份与恢复

当需要对 TiDB 集群进行备份或在之后对 TiDB 集群进行恢复时,可使用 [BR](/br/backup-and-restore-overview.md)

## 迁出数据到 TiDB

当需要将 TiDB 集群的数据迁出到其他 TiDB 集群时,可使用 [Dumpling](/dumpling-overview.md) 从 TiDB 将全量数据导出为 SQL dump files,然后再使用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 将数据导入到 TiDB。

如果还需要执行增量数据的迁移,则可使用 [TiCDC](/ticdc/ticdc-overview.md)

## TiDB 增量数据订阅

当需要订阅 TiDB 增量数据的变更时,可使用 [TiCDC](/ticdc/ticdc-overview.md)
---
title: TiDB 工具的使用场景
summary: 本文档介绍 TiDB 工具的常见使用场景与工具选择。
aliases: ['/docs-cn/dev/ecosystem-tool-user-case/']
---

# TiDB 工具的使用场景

本文档从数据迁移工具的使用场景出发,介绍部分常见场景下的迁移工具的选择。

## 在物理机或虚拟机上部署运维 TiDB

当需要在物理机或虚拟机上部署运维 TiDB 时,你可以先安装 [TiUP](/tiup/tiup-overview.md),再通过 TiUP 管理 TiDB 的众多组件,如 TiDB、PD、TiKV 等。

## 在 Kubernetes 上部署运维 TiDB

当需要在 Kubernetes 上部署运维 TiDB 时,你可以先创建 Kubernetes 集群,部署[TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable),然后使用 TiDB Operator 部署运维 TiDB 集群。

## 从 CSV 导入数据到 TiDB

当需要将其他工具导出的格式兼容的 CSV files 导入到 TiDB 时,可使用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md)

## 从 MySQL/Aurora 导入全量数据

当需要从 MySQL/Aurora 导入全量数据时,可先使用 [Dumpling](/dumpling-overview.md) 将数据导出为 SQL dump files,然后再使用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 将数据导入到 TiDB 集群。

## 从 MySQL/Aurora 迁移数据

当既需要从 MySQL/Aurora 导入全量数据,又需要迁移增量数据时,可使用 [TiDB Data Migration (DM)](/dm/dm-overview.md) 完成[从 Amazon Aurora 迁移数据到 TiDB](/migrate-aurora-to-tidb.md)

如果全量数据量较大(TB 级别),则可先使用 [Dumpling](/dumpling-overview.md)[TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 完成全量数据的迁移,再使用 DM 完成增量数据的迁移。

## TiDB 集群备份与恢复

当需要对 TiDB 集群进行备份或在之后对 TiDB 集群进行恢复时,可使用 [BR](/br/backup-and-restore-overview.md)

## 迁出数据到 TiDB

当需要将 TiDB 集群的数据迁出到其他 TiDB 集群时,可使用 [Dumpling](/dumpling-overview.md) 从 TiDB 将全量数据导出为 SQL dump files,然后再使用 [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) 将数据导入到 TiDB。

如果还需要执行增量数据的迁移,则可使用 [TiCDC](/ticdc/ticdc-overview.md)

## TiDB 增量数据订阅

当需要订阅 TiDB 增量数据的变更时,可使用 [TiCDC](/ticdc/ticdc-overview.md)
88 changes: 44 additions & 44 deletions faq/high-reliability-faq.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
---
title: 高可靠常见问题
summary: 介绍高可靠相关的常见问题。
aliases: ['/docs-cn/dev/faq/high-reliability-faq/']
---

# 高可靠常见问题

本文档介绍高可靠相关的常见问题。

## TiDB 是否支持数据加密?

支持。要加密传输中的数据,可以[在 TiDB 客户端和服务器之间启用 TLS](/enable-tls-between-clients-and-servers.md)。要加密存储引擎中的数据,可以启用[透明数据加密 (TDE)](/encryption-at-rest.md)

## 我们的安全漏洞扫描工具对 MySQL version 有要求,TiDB 是否支持修改 server 版本号呢?

TiDB 在 v3.0.8 后支持通过 TiDB 配置文件中的 [`server-version`](/tidb-configuration-file.md#server-version) 配置项来修改 server 版本号。

对于 v4.0 及以上版本的集群,如果使用 TiUP 部署集群,可以通过 `tiup cluster edit-config <cluster-name>` 修改配置文件中以下部分来设置合适的版本号:

```
server_configs:
tidb:
server-version: 'YOUR_VERSION_STRING'
```

修改完成后,使用 `tiup cluster reload <cluster-name> -R tidb` 命令使得以上修改生效,以避免出现安全漏洞扫描不通过的问题。

## TiDB 支持哪些认证协议?过程是怎样的?

TiDB 和 MySQL 一样,在用户登录认证时使用 SASL 认证协议对密码进行处理。

客户端连接 TiDB 的时候,使用 challenge-response(挑战-应答)的认证模式,过程如下:

1. 客户端连接服务器。
2. 服务器发送随机字符串 `challenge` 给客户端。
3. 客户端发送 `username` + `response` 给服务器。
4. 服务器验证 `response`

## 如何修改用户名密码和权限?

因为 TiDB 是分布式数据库,想要在 TiDB 中修改用户密码,建议使用 `ALTER USER` 的方法,例如 `ALTER USER 'test'@'localhost' IDENTIFIED BY 'mypass';`

不推荐使用 `UPDATE mysql.user` 的方法,因为这种方法可能会造成其它节点刷新不及时的情况。修改权限也一样,建议参考 [TiDB 用户账户管理](/user-account-management.md)文档中的方法。
---
title: 高可靠常见问题
summary: 介绍高可靠相关的常见问题。
aliases: ['/docs-cn/dev/faq/high-reliability-faq/']
---

# 高可靠常见问题

本文档介绍高可靠相关的常见问题。

## TiDB 是否支持数据加密?

支持。要加密传输中的数据,可以[在 TiDB 客户端和服务器之间启用 TLS](/enable-tls-between-clients-and-servers.md)。要加密存储引擎中的数据,可以启用[透明数据加密 (TDE)](/encryption-at-rest.md)

## 我们的安全漏洞扫描工具对 MySQL version 有要求,TiDB 是否支持修改 server 版本号呢?

TiDB 在 v3.0.8 后支持通过 TiDB 配置文件中的 [`server-version`](/tidb-configuration-file.md#server-version) 配置项来修改 server 版本号。

对于 v4.0 及以上版本的集群,如果使用 TiUP 部署集群,可以通过 `tiup cluster edit-config <cluster-name>` 修改配置文件中以下部分来设置合适的版本号:

```
server_configs:
tidb:
server-version: 'YOUR_VERSION_STRING'
```

修改完成后,使用 `tiup cluster reload <cluster-name> -R tidb` 命令使得以上修改生效,以避免出现安全漏洞扫描不通过的问题。

## TiDB 支持哪些认证协议?过程是怎样的?

TiDB 和 MySQL 一样,在用户登录认证时使用 SASL 认证协议对密码进行处理。

客户端连接 TiDB 的时候,使用 challenge-response(挑战-应答)的认证模式,过程如下:

1. 客户端连接服务器。
2. 服务器发送随机字符串 `challenge` 给客户端。
3. 客户端发送 `username` + `response` 给服务器。
4. 服务器验证 `response`

## 如何修改用户名密码和权限?

因为 TiDB 是分布式数据库,想要在 TiDB 中修改用户密码,建议使用 `ALTER USER` 的方法,例如 `ALTER USER 'test'@'localhost' IDENTIFIED BY 'mypass';`

不推荐使用 `UPDATE mysql.user` 的方法,因为这种方法可能会造成其它节点刷新不及时的情况。修改权限也一样,建议参考 [TiDB 用户账户管理](/user-account-management.md)文档中的方法。
Loading

0 comments on commit 4ed9b8b

Please sign in to comment.