Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add aliases for Binlog docs #19191

Merged
merged 3 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sql-statements/sql-statement-change-drainer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CHANGE DRAINER
summary: TiDB 数据库中 CHANGE DRAINER 的使用概况。
aliases: ['/docs-cn/dev/sql-statements/sql-statement-change-drainer/','/zh/tidb/dev/sql-statement-change-drainer/']
aliases: ['/docs-cn/dev/sql-statements/sql-statement-change-drainer/','/zh/tidb/dev/sql-statement-change-drainer/','/zh/tidb/stable/sql-statement-change-drainer/']
---

# CHANGE DRAINER
Expand Down
2 changes: 1 addition & 1 deletion sql-statements/sql-statement-change-pump.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CHANGE PUMP
summary: TiDB 数据库中 CHANGE PUMP 的使用概况。
aliases: ['/docs-cn/dev/sql-statements/sql-statement-change-pump/','/zh/tidb/dev/sql-statement-change-pump/']
aliases: ['/docs-cn/dev/sql-statements/sql-statement-change-pump/','/zh/tidb/dev/sql-statement-change-pump/','/zh/tidb/stable/sql-statement-change-pump/']
---

# CHANGE PUMP
Expand Down
2 changes: 1 addition & 1 deletion sql-statements/sql-statement-show-drainer-status.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SHOW DRAINER STATUS
summary: TiDB 数据库中 SHOW DRAINER STATUS 的使用概况。
aliases: ['/docs-cn/dev/sql-statements/sql-statement-show-drainer-status/','/zh/tidb/dev/sql-statement-show-drainer-status/']
aliases: ['/docs-cn/dev/sql-statements/sql-statement-show-drainer-status/','/zh/tidb/dev/sql-statement-show-drainer-status/','/zh/tidb/stable/sql-statement-show-drainer-status/']
---

# SHOW DRAINER STATUS
Expand Down
2 changes: 1 addition & 1 deletion sql-statements/sql-statement-show-pump-status.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SHOW PUMP STATUS
summary: TiDB 数据库中 SHOW PUMP STATUS 的使用概况。
aliases: ['/docs-cn/dev/sql-statements/sql-statement-show-pump-status/','/zh/tidb/dev/sql-statement-show-pump-status/']
aliases: ['/docs-cn/dev/sql-statements/sql-statement-show-pump-status/','/zh/tidb/dev/sql-statement-show-pump-status/','/zh/tidb/stable/sql-statement-show-pump-status/']
---

# SHOW PUMP STATUS
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog-deployment-topology.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 部署拓扑
summary: 介绍如何在部署最小拓扑集群的基础上,同时部署 TiDB Binlog。
aliases: ['/zh/tidb/dev/tidb-binlog-deployment-topology/','/docs-cn/dev/tidb-binlog-deployment-topology/']
aliases: ['/zh/tidb/dev/tidb-binlog-deployment-topology/','/docs-cn/dev/tidb-binlog-deployment-topology/','/zh/tidb/stable/tidb-binlog-deployment-topology/']
---

# TiDB Binlog 部署拓扑
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 集群间双向同步
summary: 本文介绍了如何使用 TiDB Binlog 实现集群间双向同步,包括使用场景、实现原理、标识表、同步 DDL 和配置开启双向同步。双向同步需保证数据写入两个集群不会发生冲突,且 DDL 操作采用单向同步。配置上需要设置相同的 channel-id,并在下游配置 sync-ddl 为 false。从 v8.3.0 开始,TiDB Binlog 被完全废弃。
aliases: ['/zh/tidb/dev/bidirectional-replication-between-tidb-clusters/','/docs-cn/dev/tidb-binlog/bidirectional-replication-between-tidb-clusters/','/docs-cn/dev/reference/tidb-binlog/bidirectional-replication/','/docs-cn/dev/reference/tidb-binlog/bi-repl/']
aliases: ['/zh/tidb/dev/bidirectional-replication-between-tidb-clusters/','/zh/tidb/stable/bidirectional-replication-between-tidb-clusters/','/docs-cn/dev/tidb-binlog/bidirectional-replication-between-tidb-clusters/','/docs-cn/dev/reference/tidb-binlog/bidirectional-replication/','/docs-cn/dev/reference/tidb-binlog/bi-repl/']
---

# 集群间双向同步
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/binlog-consumer-client.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Binlog Consumer Client 用户文档
summary: Drainer 现在支持将 binlog 数据输出到 Kafka,用户可以根据自定义需求从 Kafka 中读取数据进行处理。用户需要修改 Drainer 配置文件,设置输出为 Kafka,并了解 Drainer 写入到 Kafka 中的数据格式。TiDB-Tools 项目提供了用于读取 Kafka 中 binlog 数据的 Driver,用户可以配置相关信息并以包的形式引用 Driver 的代码来使用。目前仅提供了 golang 版本的 Driver 以及示例代码,如果需要使用其他语言,用户需要自行开发程序读取 Kafka 中的 binlog 数据、解析数据、输出到下游。
aliases: ['/zh/tidb/dev/binlog-consumer-client/','/zh/tidb/dev/binlog-slave-client','/docs-cn/dev/tidb-binlog/binlog-slave-client/','/docs-cn/dev/reference/tidb-binlog/binlog-slave-client/','/docs-cn/dev/reference/tools/tidb-binlog/binlog-slave-client/']
aliases: ['/zh/tidb/dev/binlog-consumer-client/','/zh/tidb/stable/binlog-consumer-client/','/zh/tidb/dev/binlog-slave-client','/docs-cn/dev/tidb-binlog/binlog-slave-client/','/docs-cn/dev/reference/tidb-binlog/binlog-slave-client/','/docs-cn/dev/reference/tools/tidb-binlog/binlog-slave-client/']
---

# Binlog Consumer Client 用户文档
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/binlog-control.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: binlogctl 工具
summary: 介绍 binlogctl 的使用方法。
aliases: ['/zh/tidb/dev/binlog-control/','/docs-cn/dev/tidb-binlog/binlog-control/']
aliases: ['/zh/tidb/dev/binlog-control/','/zh/tidb/stable/binlog-control/','/docs-cn/dev/tidb-binlog/binlog-control/']
---

# binlogctl 工具
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/deploy-tidb-binlog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 集群部署
summary: TiDB Binlog 集群部署需要满足服务器硬件配置要求。推荐使用 TiUP 部署 TiDB Binlog,也可以使用 Binary 部署。部署过程中需要注意配置参数和启动命令。在运行 TiDB 时,需要保证至少一个 Pump 正常运行。Drainer 不支持对 ignore schemas 的 table 进行 rename DDL 操作。从 v8.3.0 开始,TiDB Binlog 被完全废弃。
aliases: ['/zh/tidb/dev/deploy-tidb-binlog/','/docs-cn/dev/tidb-binlog/deploy-tidb-binlog/','/docs-cn/dev/reference/tidb-binlog/deploy/','/docs-cn/dev/how-to/deploy/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/deploy/']
aliases: ['/zh/tidb/dev/deploy-tidb-binlog/','/zh/tidb/stable/deploy-tidb-binlog/','/docs-cn/dev/tidb-binlog/deploy-tidb-binlog/','/docs-cn/dev/reference/tidb-binlog/deploy/','/docs-cn/dev/how-to/deploy/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/deploy/']
---

# TiDB Binlog 集群部署
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/handle-tidb-binlog-errors.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 常见错误修复
summary: TiDB Binlog 常见错误修复:介绍了 Drainer 同步数据到 Kafka 时报错的解决方法,Pump 报错 "no space left on device" 的原因和解决方法,以及 Drainer 输出 file 格式的增量数据的清理机制。需要确认 TiDB 实例是否开启了 TiDB Binlog 并且状态正常,以及调整 Pump 的 gRPC message 最大大小。
aliases: ['/zh/tidb/dev/handle-tidb-binlog-errors/','/docs-cn/dev/tidb-binlog/handle-tidb-binlog-errors/','/docs-cn/dev/reference/tidb-binlog/troubleshoot/error-handling/']
aliases: ['/zh/tidb/dev/handle-tidb-binlog-errors/','/zh/tidb/stable/handle-tidb-binlog-errors/','/docs-cn/dev/tidb-binlog/handle-tidb-binlog-errors/','/docs-cn/dev/reference/tidb-binlog/troubleshoot/error-handling/']
---

# TiDB Binlog 常见错误修复
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/maintain-tidb-binlog-cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 集群运维
summary: TiDB Binlog 集群运维包括了 Pump 和 Drainer 的状态管理和启动、退出流程。通过 binlogctl 工具或 TiDB SQL 操作可以管理集群状态。具体操作方法请参考 binlogctl 工具的使用方法介绍。
aliases: ['/zh/tidb/dev/maintain-tidb-binlog-cluster/','/docs-cn/dev/tidb-binlog/maintain-tidb-binlog-cluster/','/docs-cn/dev/reference/tidb-binlog/maintain/','/docs-cn/dev/how-to/maintain/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/maintain/']
aliases: ['/zh/tidb/dev/maintain-tidb-binlog-cluster/','/zh/tidb/stable/maintain-tidb-binlog-cluster/','/docs-cn/dev/tidb-binlog/maintain-tidb-binlog-cluster/','/docs-cn/dev/reference/tidb-binlog/maintain/','/docs-cn/dev/how-to/maintain/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/maintain/']
---

# TiDB Binlog 集群运维
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/monitor-tidb-binlog-cluster.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 集群监控
summary: TiDB Binlog 集群监控包括 Pump 和 Drainer 的监控指标,以及紧急、重要和警告级别的监控报警规则。监控指标包括 Pump 的存储大小、写 Binlog QPS、写 Binlog 延迟等,以及 Drainer 的同步延迟、处理 SQL 耗时等。报警规则包括紧急级别的 Pump 存储错误、重要级别的 Drainer 同步延迟超过1小时、警告级别的 Pump 写 Binlog 耗时过大等。
aliases: ['/zh/tidb/dev/monitor-tidb-binlog-cluster/','/docs-cn/dev/tidb-binlog/monitor-tidb-binlog-cluster/','/docs-cn/dev/reference/tidb-binlog/monitor/','/docs-cn/dev/how-to/monitor/tidb-binlog-monitor/','/docs-cn/dev/reference/tools/tidb-binlog/monitor/','/docs-cn/dev/how-to/monitor/tidb-binlog/']
aliases: ['/zh/tidb/dev/monitor-tidb-binlog-cluster/','/zh/tidb/stable/monitor-tidb-binlog-cluster/','/docs-cn/dev/tidb-binlog/monitor-tidb-binlog-cluster/','/docs-cn/dev/reference/tidb-binlog/monitor/','/docs-cn/dev/how-to/monitor/tidb-binlog-monitor/','/docs-cn/dev/reference/tools/tidb-binlog/monitor/','/docs-cn/dev/how-to/monitor/tidb-binlog/']
---

# TiDB Binlog 集群监控
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-configuration-file.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 配置说明
summary: TiDB Binlog 配置说明:介绍 Pump 和 Drainer 的配置项,包括地址、存储、安全和同步相关配置。 Pump 包括 addr、advertise-addr、socket、pd-urls、data-dir、heartbeat-interval、gen-binlog-interval、gc、log-file、log-level、node-id、security 和 storage 配置。 Drainer 包括 addr、advertise-addr、log-file、log-level、node-id、data-dir、detect-interval、pd-urls、initial-commit-ts、synced-check-time、compressor、security 和 syncer 配置。
aliases: ['/zh/tidb/dev/tidb-binlog-configuration-file/','/docs-cn/dev/tidb-binlog/tidb-binlog-configuration-file/','/docs-cn/dev/reference/tidb-binlog/configs/']
aliases: ['/zh/tidb/dev/tidb-binlog-configuration-file/','/zh/tidb/stable/tidb-binlog-configuration-file/','/docs-cn/dev/tidb-binlog/tidb-binlog-configuration-file/','/docs-cn/dev/reference/tidb-binlog/configs/']
---

# TiDB Binlog 配置说明
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 常见问题
summary: TiDB Binlog 常见问题解决方案:性能影响、同步延迟、Drainer 权限、Pump 磁盘处理、同步中断处理、同步慢处理、Pump crash 处理、checkpoint 作用、Drainer 故障处理、全量+binlog 备份恢复、ignore-error 处理、DDL 执行错误处理、Pump/Drainer 暂停和下线处理。
aliases: ['/zh/tidb/dev/tidb-binlog-faq/','/docs-cn/dev/tidb-binlog/tidb-binlog-faq/','/docs-cn/dev/reference/tidb-binlog/faq/','/docs-cn/dev/faq/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/faq/']
aliases: ['/zh/tidb/dev/tidb-binlog-faq/','/zh/tidb/stable/tidb-binlog-faq/','/docs-cn/dev/tidb-binlog/tidb-binlog-faq/','/docs-cn/dev/reference/tidb-binlog/faq/','/docs-cn/dev/faq/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/faq/']
---

# TiDB Binlog 常见问题
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-glossary.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 术语表
summary: 学习 TiDB Binlog 相关术语
aliases: ['/zh/tidb/dev/tidb-binlog-glossary/','/docs-cn/dev/tidb-binlog/tidb-binlog-glossary/','/docs-cn/dev/reference/tidb-binlog/glossary/']
aliases: ['/zh/tidb/dev/tidb-binlog-glossary/','/zh/tidb/stable/tidb-binlog-glossary/','/docs-cn/dev/tidb-binlog/tidb-binlog-glossary/','/docs-cn/dev/reference/tidb-binlog/glossary/']
---

# TiDB Binlog 术语表
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 简介
summary: TiDB Binlog 是用于收集 TiDB 的 binlog 并提供实时备份和同步功能的商业工具。它支持数据同步和实时备份恢复功能。从 v8.3.0 开始,TiDB Binlog 被完全废弃。
aliases: ['/zh/tidb/dev/tidb-binlog-overview/','/docs-cn/dev/tidb-binlog/tidb-binlog-overview/','/docs-cn/dev/reference/tidb-binlog/overview/','/docs-cn/dev/reference/tidb-binlog-overview/','/docs-cn/dev/reference/tools/tidb-binlog/overview/']
aliases: ['/zh/tidb/dev/tidb-binlog-overview/','/zh/tidb/stable/tidb-binlog-overview/','/docs-cn/dev/tidb-binlog/tidb-binlog-overview/','/docs-cn/dev/reference/tidb-binlog/overview/','/docs-cn/dev/reference/tidb-binlog-overview/','/docs-cn/dev/reference/tools/tidb-binlog/overview/']
---

# TiDB Binlog 简介
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-relay-log.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog Relay Log
summary: TiDB Binlog Relay Log 是用于确保下游集群与上游集群数据一致的工具。Drainer 同步时会拆分上游事务并并发同步到下游,使用 relay log 来恢复下游集群到一致状态。Drainer 会将 binlog event 写入磁盘并同步给下游,同时会清理已完成同步的 relay log 文件。配置中需指定保存 relay log 的目录和单个文件大小限制。
aliases: ['/zh/tidb/dev/tidb-binlog-relay-log/','/docs-cn/dev/tidb-binlog/tidb-binlog-relay-log/','/docs-cn/dev/reference/tidb-binlog/relay-log/','/docs-cn/dev/reference/tools/tidb-binlog/relay-log/']
aliases: ['/zh/tidb/dev/tidb-binlog-relay-log/','/zh/tidb/stable/tidb-binlog-relay-log/','/docs-cn/dev/tidb-binlog/tidb-binlog-relay-log/','/docs-cn/dev/reference/tidb-binlog/relay-log/','/docs-cn/dev/reference/tools/tidb-binlog/relay-log/']
---

# TiDB Binlog Relay Log
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-reparo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Reparo 使用文档
summary: Reparo 是 TiDB Binlog 的配套工具,用于增量恢复。通过 Drainer 将 binlog 输出到文件,使用 Reparo 解析并应用到 TiDB/MySQL 中。安装包位于 TiDB 离线工具包中。使用命令行参数设置日志输出信息等级、同步下游的并发数等。配置文件可设置存储路径、日志等级、恢复时间范围、下游服务类型等。启动示例为 ./reparo -config reparo.toml。
aliases: ['/zh/tidb/dev/tidb-binlog-reparo/','/docs-cn/dev/tidb-binlog/tidb-binlog-reparo/','/docs-cn/dev/reference/tidb-binlog/reparo/','/docs-cn/dev/reference/tools/tidb-binlog/reparo/']
aliases: ['/zh/tidb/dev/tidb-binlog-reparo/','/zh/tidb/stable/tidb-binlog-reparo/','/docs-cn/dev/tidb-binlog/tidb-binlog-reparo/','/docs-cn/dev/reference/tidb-binlog/reparo/','/docs-cn/dev/reference/tools/tidb-binlog/reparo/']
---

# Reparo 使用文档
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/troubleshoot-tidb-binlog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 故障诊断
summary: TiDB Binlog 故障诊断总结了使用过程中遇到问题的诊断流程,并指引用户通过监控、状态、日志等信息查找解决方案。排查问题的方式包括查看监控指标、使用 binlogctl 工具查看 Pump、Drainer 状态,以及查看日志中的 ERROR 和 WARN 信息。定位到问题后,在 FAQ 和常见错误及修复中查找解决方案,如无法解决问题可提交 issue 或获取支持。
aliases: ['/zh/tidb/dev/troubleshoot-tidb-binlog/','/docs-cn/dev/tidb-binlog/troubleshoot-tidb-binlog/','/docs-cn/dev/reference/tidb-binlog/troubleshoot/binlog/','/docs-cn/dev/how-to/troubleshoot/tidb-binlog/']
aliases: ['/zh/tidb/dev/troubleshoot-tidb-binlog/','/zh/tidb/stable/troubleshoot-tidb-binlog/','/docs-cn/dev/tidb-binlog/troubleshoot-tidb-binlog/','/docs-cn/dev/reference/tidb-binlog/troubleshoot/binlog/','/docs-cn/dev/how-to/troubleshoot/tidb-binlog/']
---

# TiDB Binlog 故障诊断
Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/upgrade-tidb-binlog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: TiDB Binlog 版本升级方法
summary: TiDB Binlog 版本升级方法介绍了手动部署的步骤,包括升级 Pump 和 Drainer。同时,还介绍了从 Kafka/Local 版本升级到 Cluster 版本的流程,以及如何确认数据同步完成后启动新版本的 Drainer。从 v8.3.0 开始,TiDB Binlog 被完全废弃。
aliases: ['/zh/tidb/dev/upgrade-tidb-binlog/','/docs-cn/dev/tidb-binlog/upgrade-tidb-binlog/','/docs-cn/dev/reference/tidb-binlog/upgrade/','/docs-cn/dev/how-to/upgrade/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/upgrade/']
aliases: ['/zh/tidb/dev/upgrade-tidb-binlog/','/zh/tidb/stable/upgrade-tidb-binlog/','/docs-cn/dev/tidb-binlog/upgrade-tidb-binlog/','/docs-cn/dev/reference/tidb-binlog/upgrade/','/docs-cn/dev/how-to/upgrade/tidb-binlog/','/docs-cn/dev/reference/tools/tidb-binlog/upgrade/']
---

# TiDB Binlog 版本升级方法
Expand Down
Loading