From 1130b0d5911ab4d695623650ef5ffac9640c31c1 Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 9 Jun 2020 14:44:57 +0800 Subject: [PATCH 01/15] Update TOC.md --- TOC.md | 726 +++++++++++++++++++++++++++++---------------------------- 1 file changed, 373 insertions(+), 353 deletions(-) diff --git a/TOC.md b/TOC.md index 73942ee17e0ed..e83de2d4846e8 100644 --- a/TOC.md +++ b/TOC.md @@ -3,188 +3,242 @@ -## Documentation List +## 目录 -+ Introduction - - [TiDB Introduction](/overview.md) - - [What's New in TiDB 4.0](/whats-new-in-tidb-4.0.md) - + Benchmarks - - [How to Test TiDB Using Sysbench](/benchmark/benchmark-tidb-using-sysbench.md) - - [How to Run TPC-C Test on TiDB](/benchmark/benchmark-tidb-using-tpcc.md) - + [Sysbench Performance Test - v4.0 vs. v3.0](/benchmark/benchmark-sysbench-v4-vs-v3.md) - + [TPC-H Performance Test - v4.0 vs. v3.0](/benchmark/v4.0-performance-benchmarking-with-tpch.md) - + [TPC-C Performance Test - v4.0 vs. v3.0](/benchmark/v4.0-performance-benchmarking-with-tpcc.md) - - [Sysbench Performance Test - v3.0 vs. v2.1](/benchmark/v3.0-performance-benchmarking-with-sysbench.md) - - [TPC-C Performance Test - v3.0 vs. v2.1](/benchmark/v3.0-performance-benchmarking-with-tpcc.md) - - [Interaction Test on Online Workloads and `ADD INDEX` Operations](/benchmark/online-workloads-and-add-index-operations.md) -- [Quick Start with TiDB](/quick-start-with-tidb.md) -+ Concepts - - [Architecture](/architecture.md) - + Key Features - - [Horizontal Scalability](/key-features.md#horizontal-scalability) - - [MySQL Compatible Syntax](/key-features.md#mysql-compatible-syntax) - - [Replicate from and to MySQL](/key-features.md#replicate-from-and-to-mysql) - - [Distributed Transactions with Strong Consistency](/key-features.md#distributed-transactions-with-strong-consistency) - - [Cloud Native Architecture](/key-features.md#cloud-native-architecture) - - [Minimize ETL with HTAP](/key-features.md#minimize-etl-with-htap) - - [Fault Tolerance & Recovery with Raft](/key-features.md#fault-tolerance--recovery-with-raft) - - [Automatic Rebalancing](/key-features.md#automatic-rebalancing) - - [Deployment and Orchestration with Ansible, Kubernetes, Docker](/key-features.md#deployment-and-orchestration-with-ansible-kubernetes-docker) - - [JSON Support](/key-features.md#json-support) - - [Spark Integration](/key-features.md#spark-integration) - - [Read Historical Data Without Restoring from Backup](/key-features.md#read-historical-data-without-restoring-from-backup) - - [Fast Import and Restore of Data](/key-features.md#fast-import-and-restore-of-data) - - [Hybrid of Column and Row Storage](/key-features.md#hybrid-of-column-and-row-storage) - - [SQL Plan Management](/key-features.md#sql-plan-management) - - [Open Source](/key-features.md#open-source) - - [Online Schema Changes](/key-features.md#online-schema-changes) -+ How-to - + Get Started - + Start a Cluster - - [From Binary](/deploy-tidb-from-binary.md) - - [From Homebrew](/deploy-tidb-from-homebrew.md) - - [From DBdeployer](/deploy-tidb-from-dbdeployer.md) - - [From Docker Compose](/deploy-test-cluster-using-docker-compose.md) - - [Explore SQL with TiDB](/basic-sql-operations.md) - - [Import Example Database](/import-example-data.md) - - [Read Historical Data](/read-historical-data.md) - - [TiDB Binlog Tutorial](/get-started-with-tidb-binlog.md) - - [TiDB Data Migration Tutorial](https://pingcap.com/docs/tidb-data-migration/stable/get-started/) - - [TiDB Lightning Tutorial](/get-started-with-tidb-lightning.md) - - [TiSpark Quick Start Guide](/get-started-with-tispark.md) - + Deploy - - [Software and Hardware Requirements](/hardware-and-software-requirements.md) - + From Binary Tarball - - [For Testing Environments](/test-deployment-from-binary-tarball.md) - - [For Production Environments](/production-deployment-from-binary-tarball.md) - + Orchestrated Deployment - - [Use TiUP (Recommended)](/production-deployment-using-tiup.md) - - [Use TiUP Offline (Recommended)](/production-offline-deployment-using-tiup.md) - - [Use TiDB Ansible](/online-deployment-using-ansible.md) - - [Use TiDB Ansible Offline](/offline-deployment-using-ansible.md) - - [Use Docker](/test-deployment-using-docker.md) - + [Check Cluster Status](/post-installation-check.md) - + Geographic Redundancy - - [Overview](/geo-redundancy-deployment.md) - - [Configure Location Awareness](/location-awareness.md) - - [Data Migration with Ansible](https://pingcap.com/docs/tidb-data-migration/stable/deploy-a-dm-cluster-using-ansible/) - + Configure - - [Time Zone](/configure-time-zone.md) - - [Memory Control](/configure-memory-usage.md) - - [Placement Rules](/configure-placement-rules.md) - + Secure - + Transport Layer Security (TLS) - - [Enable TLS For MySQL Clients](/encrypted-connections-with-tls-protocols.md) - - [Enable TLS Between TiDB Components](/enable-tls-between-components.md) - - [Generate Self-signed Certificates](/generate-self-signed-certificates.md) - - [Encryption-At-Rest](/encryption-at-rest.md) - + Monitor - - [Overview](/tidb-monitoring-framework.md) - - [Monitor a TiDB Cluster](/monitor-a-tidb-cluster.md) - + Migrate - - [Migration Tools User Guide](/ecosystem-tool-user-guide.md) - + Migrate from MySQL - - [Migration Case of Amazon Aurora](/migrate-from-aurora-mysql-database.md) - - [Migrate from CSV](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) - + Maintain - - [Common TiUP Operations](/maintain-tidb-using-tiup.md) - - [Common Ansible Operations](/maintain-tidb-using-ansible.md) - + Backup and Restore - - [Use Mydumper and TiDB Lightning](/backup-and-restore-using-mydumper-lightning.md) - + Use BR - - [Use BR](/br/backup-and-restore-tool.md) - - [BR Use Cases](/br/backup-and-restore-use-cases.md) - + Identify Abnormal Queries - - [Identify Slow Queries](/identify-slow-queries.md) - - [Identify Expensive Queries](/identify-expensive-queries.md) - + Scale - - [Scale using Ansible](/scale-tidb-using-ansible.md) - - [Scale using TiUP](/scale-tidb-using-tiup.md) - + Upgrade - - [Upgrade Using TiUP (Recommended)](/upgrade-tidb-using-tiup.md) - - [Upgrade Using TiDB Ansible](/upgrade-tidb-using-ansible.md) - - Troubleshoot - - [TiDB Troubleshooting Map](/tidb-troubleshooting-map.md) - - [Troubleshoot Cluster Setup](/troubleshoot-tidb-cluster.md) - - [Troubleshoot TiDB Lightning](/troubleshoot-tidb-lightning.md) -+ Reference ++ About TiDB + + [TiDB Introduction](/overview.md) + + [What's New in TiDB 4.0](/whats-new-in-tidb-4.0.md) + + [Key Features](/key-features.md) + + Compatibility + + [MySQL Compatibility](/mysql-compatibility.md) ++ Quick Start + + [Try Out TiDB](/quick-start-with-tidb.md) + + [Learn TiDB SQL](/basic-sql-operations.md) ++ Deploy + + [软硬件环境需求](/hardware-and-software-requirements.md) + + [环境与系统配置检查](/check-before-deployment.md) + + 配置拓扑结构 + + [最小部署拓扑结构](/minimal-deployment-topology.md) + + [TiFlash 部署拓扑](/tiflash-deployment-topology.md) + + [TiCDC 部署拓扑](/ticdc-deployment-topology.md) + + [TiDB Binlog 部署拓扑](/tidb-binlog-deployment-topology.md) + + [跨机房部署拓扑结构](/geo-distributed-deployment-topology.md) + + [混合部署拓扑结构](/hybrid-deployment-topology.md) + + 安装与启动 + + Linux 环境 + + [使用 TiUP 部署（推荐）](/production-deployment-using-tiup.md) + + [使用 TiUP 离线部署（推荐）](/production-offline-deployment-using-tiup.md) + + [使用 Ansible 部署](/online-deployment-using-ansible.md) + + [使用 Ansible 离线部署](/offline-deployment-using-ansible.md) + + [验证集群状态](/post-installation-check.md) + + 性能测试报告及重现指南 + + [如何用 Sysbench 测试 TiDB](/benchmark/benchmark-tidb-using-sysbench.md) + + [如何对 TiDB 进行 TPC-C 测试](/benchmark/benchmark-tidb-using-tpcc.md) + + [Sysbench 性能对比 - v4.0 对比 v3.0](/benchmark/benchmark-sysbench-v4-vs-v3.md) + + [TPC-H 性能对比 - v4.0 对比 v3.0](/benchmark/v4.0-performance-benchmarking-with-tpch.md) + + [TPC-C 性能对比 - v4.0 对比 v3.0](/benchmark/v4.0-performance-benchmarking-with-tpcc.md) + + [Sysbench 性能对比 - v3.0 对比 v2.1](/benchmark/v3.0-performance-benchmarking-with-sysbench.md) + + [TPC-C 性能对比 - v3.0 对比 v2.1](/benchmark/v3.0-performance-benchmarking-with-tpcc.md) + + [线上负载与 ADD INDEX 相互影响测试](/benchmark/online-workloads-and-add-index-operations.md) ++ Migrate + + [支持的数据迁移路径](/data-migration-route.md) + + 从 MySQL 迁移至 TiDB + + [从 Mydumper 文件迁移](/migrate-from-mysql-mydumper-files.md) + + [使用 DM 工具从 Amazon Aurora MySQL 迁移](/migrate-from-aurora-mysql-database.md) + + 从 CSV 文件迁移至 TiDB + + [使用 TiDB Lightning 导入 CSV 文件](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) + + [使用 LOAD DATA 语句导入 CSV 文件](/sql-statements/sql-statement-load-data.md) + + [从 SQL 文件迁移到 TiDB](/migrate-from-mysql-mydumper-files.md) ++ Maintain + + 升级 TiDB 版本 + + [使用 TiUP 升级（推荐）](/upgrade-tidb-using-tiup.md) + + [使用 TiUP 离线升级（推荐）](/upgrade-tidb-using-tiup-offline.md) + + [使用 TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/) + + [使用 TiDB Ansible](/upgrade-tidb-using-ansible.md) + + 扩缩容 + + [使用 TiUP（推荐）](/scale-tidb-using-tiup.md) + + [使用 TiDB Ansible](/scale-tidb-using-ansible.md) + + [使用 TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/scale-a-tidb-cluster/) + + 备份与恢复 + + [使用 Mydumper 和 TiDB Lightning 进行备份与恢复](/backup-and-restore-using-mydumper-lightning.md) + + [使用 Dumpling 导出或备份 TiDB 数据](/export-or-backup-using-dumpling.md) + + 使用 BR 工具 + + [使用 BR 进行备份与恢复](/br/backup-and-restore-tool.md) + + [BR 备份与恢复场景示例](/br/backup-and-restore-use-cases.md) + + [日常巡检](/daily-check.md) + + [TiCDC 运维操作及任务管理](/ticdc/manage-ticdc.md) + + [TiFlash 常用运维操作](/tiflash/maintain-tiflash.md) + + [TiUP 常用运维操作](/maintain-tidb-using-tiup.md) + + [Ansible 常用运维操作](/maintain-tidb-using-ansible.md) ++ Monitor and alert + + [监控框架概述](/tidb-monitoring-framework.md) + + [监控 API](/tidb-monitoring-api.md) + + [手动部署监控](/deploy-monitoring-services.md) + + [TiDB 集群报警规则与处理方法](/alert-rules.md) + + [TiFlash 报警规则与处理方法](/tiflash/tiflash-alert-rules.md) ++ Troubleshoot + + [定位慢查询](/identify-slow-queries.md) + + [SQL 诊断](/system-tables/system-table-sql-diagnostics.md) + + [定位消耗系统资源多的查询](/identify-expensive-queries.md) + + [SQL 语句统计](/statement-summary-tables.md) + + [热点问题处理](/troubleshoot-hot-spot-issues.md) + + [CPU 占用过多导致读写延迟增加](/troubleshoot-cpu-issues.md) + + [写冲突与写性能下降](/troubleshoot-write-conflicts.md) + + [磁盘 I/O 过高](/troubleshoot-high-disk-io.md) + + [锁冲突与 TTL 超时](/troubleshoot-lock-conflicts.md) + + [TiCDC 常见问题](/ticdc/troubleshoot-ticdc.md) + + [TiFlash 常见问题](/tiflash/troubleshoot-tiflash.md) ++ Tune Performance + + 系统调优 + + [操作系统性能参数调优](/tune-operating-system.md) + + 软件调优 + + 配置 + + [TiKV 线程调优](/tune-tikv-thread-performance.md) + + [TiKV 内存调优](/tune-tikv-memory-performance.md) + + [TiFlash 调优](/tiflash/tune-tiflash-performance.md) + + [下推计算结果缓存](/coprocessor-cache.md) + + SQL 性能调优 + + [SQL 性能调优概览](/sql-tuning-overview.md) + + [理解 TiDB 执行计划](/query-execution-plan.md) + + SQL 优化 + + [SQL 优化流程简介](/sql-optimization-concepts.md) + + 逻辑优化 + + [逻辑优化概览](/sql-logical-optimization.md) + + [子查询相关的优化](/subquery-optimization.md) + + [列裁剪](/column-pruning.md) + + [关联子查询去关联](/correlated-subquery-optimization.md) + + [Max/Min 消除](/max-min-eliminate.md) + + [谓词下推](/predicate-push-down.md) + + [分区裁剪](/partition-pruning.md) + + [TopN 和 Limit 下推](/topn-limit-push-down.md) + + [Join Reorder](/join-reorder.md) + + 物理优化 + + [物理优化概览](/sql-physical-optimization.md) + + [索引的选择](/choose-index.md) + + [统计信息简介](/statistics.md) + + [错误索引的解决方案](/wrong-index-solution.md) + + [Distinct 优化](/agg-distinct-optimization.md) + + [执行计划缓存](/sql-prepare-plan-cache.md) + + 控制执行计划 + + [控制执行计划概览](/control-execution-plan.md) + + [Optimizer Hints](/optimizer-hints.md) + + [执行计划管理](/sql-plan-management.md) + + [优化规则及表达式下推的黑名单](/blacklist-control-plan.md) ++ 教程 + + [同城多中心部署](/multi-data-centers-in-one-city-deployment.md) + + [两地三中心部署](/three-data-centers-in-two-cities-deployment.md) + + 最佳实践 + + [TiDB 最佳实践](/best-practices/tidb-best-practices.md) + + [Java 应用开发最佳实践](/best-practices/java-app-best-practices.md) + + [HAProxy 最佳实践](/best-practices/haproxy-best-practices.md) + + [高并发写入场景最佳实践](/best-practices/high-concurrency-best-practices.md) + + [Grafana 监控最佳实践](/best-practices/grafana-monitor-best-practices.md) + + [PD 调度策略最佳实践](/best-practices/pd-scheduling-best-practices.md) + + [海量 Region 集群调优](/best-practices/massive-regions-best-practices.md) + + [Placement Rules 使用文档](/configure-placement-rules.md) + + [Load Base Split 使用文档](/configure-load-base-split.md) + + [Store Limit 使用文档](/configure-store-limit.md) ++ TiDB 生态工具 + + [功能概览](/ecosystem-tool-user-guide.md) + + [适用场景](/ecosystem-tool-user-case.md) + + [工具下载](/download-ecosystem-tools.md) + + Backup & Restore (BR) + + [BR 常见问题](/br/backup-and-restore-faq.md) + + [使用 BR 进行备份和恢复](/br/backup-and-restore-tool.md) + + [BR 备份与恢复场景示例](/br/backup-and-restore-use-cases.md) + + TiDB Binlog + + [概述](/tidb-binlog/tidb-binlog-overview.md) + + [部署使用](/tidb-binlog/deploy-tidb-binlog.md) + + [运维管理](/tidb-binlog/maintain-tidb-binlog-cluster.md) + + [配置说明](/tidb-binlog/tidb-binlog-configuration-file.md) + + [Pump](/tidb-binlog/tidb-binlog-configuration-file.md#pump) + + [Drainer](/tidb-binlog/tidb-binlog-configuration-file.md#drainer) + + [版本升级](/tidb-binlog/upgrade-tidb-binlog.md) + + [监控告警](/tidb-binlog/monitor-tidb-binlog-cluster.md) + + [增量恢复](/tidb-binlog/tidb-binlog-reparo.md) + + [binlogctl 工具](/tidb-binlog/binlog-control.md) + + [Kafka 自定义开发](/tidb-binlog/binlog-slave-client.md) + + [TiDB Binlog Relay Log](/tidb-binlog/tidb-binlog-relay-log.md) + + [集群间双向同步](/tidb-binlog/bidirectional-replication-between-tidb-clusters.md) + + [术语表](/tidb-binlog/tidb-binlog-glossary.md) + + 故障诊断 + + [故障诊断](/tidb-binlog/troubleshoot-tidb-binlog.md) + + [常见错误修复](/tidb-binlog/handle-tidb-binlog-errors.md) + + [FAQ](/tidb-binlog/tidb-binlog-faq.md) + + TiDB Lightning + + [概述](/tidb-lightning/tidb-lightning-overview.md) + + [快速上手教程](/get-started-with-tidb-lightning.md) + + [部署执行](/tidb-lightning/deploy-tidb-lightning.md) + + [参数说明](/tidb-lightning/tidb-lightning-configuration.md) + + 主要功能 + + [断点续传](/tidb-lightning/tidb-lightning-checkpoints.md) + + [表库过滤](/tidb-lightning/tidb-lightning-table-filter.md) + + [CSV 支持](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) + + [TiDB-backend](/tidb-lightning/tidb-lightning-tidb-backend.md) + + [Web 界面](/tidb-lightning/tidb-lightning-web-interface.md) + + [监控告警](/tidb-lightning/monitor-tidb-lightning.md) + + [故障诊断](/troubleshoot-tidb-lightning.md) + + [FAQ](/tidb-lightning/tidb-lightning-faq.md) + + [术语表](/tidb-lightning/tidb-lightning-glossary.md) + + [TiCDC](/ticdc/ticdc-overview.md) + + sync-diff-inspector + + [概述](/sync-diff-inspector/sync-diff-inspector-overview.md) + + [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md) + + [分库分表场景下的数据校验](/sync-diff-inspector/shard-diff.md) + + [TiDB 主从集群的数据校验](/sync-diff-inspector/upstream-downstream-diff.md) + + [Loader](/loader-overview.md) + + [Mydumper](/mydumper-overview.md) + + [Syncer](/syncer-overview.md) ++ 参考指南 + + 架构 + + [概述](/tidb-architecture.md) + + [存储](/tidb-storage.md) + + [计算](/tidb-computing.md) + + [调度](/tidb-scheduling.md) + + 监控指标 + + [Overview 面板](/grafana-overview-dashboard.md) + + [TiDB 面板](/grafana-tidb-dashboard.md) + + [PD 面板](/grafana-pd-dashboard.md) + + [TiKV 面板](/grafana-tikv-dashboard.md) + + [TiFlash 监控指标](/tiflash/monitor-tiflash.md) + + 安全加固 + + [为 TiDB 客户端服务端间通信开启加密传输](/enable-tls-between-clients.md) + + [为 TiDB 组件间通信开启加密传输](/enable-tls-between-components.md) + + [为 TiDB 开启数据加密存储](/enable-encrypt-stored-data.md) + + [生成自签名证书](/generate-self-signed-certificates.md) + + 权限 + + [与 MySQL 安全特性差异](/security-compatibility-with-mysql.md) + + [权限管理](/privilege-management.md) + + [TiDB 用户账户管理](/user-account-management.md) + + [基于角色的访问控制](/role-based-access-control.md) + + [TiDB 证书鉴权使用指南](/certificate-authentication.md) + SQL - - [MySQL Compatibility](/mysql-compatibility.md) - + SQL Language Structure - - [Literal Values](/literal-values.md) - - [Schema Object Names](/schema-object-names.md) - - [Keywords and Reserved Words](/keywords-and-reserved-words.md) - - [User-Defined Variables](/user-defined-variables.md) - - [Expression Syntax](/expression-syntax.md) - - [Comment Syntax](/comment-syntax.md) - + Attributes - - [`AUTO_RANDOM`](/auto-random.md) - + Data Types - - [Overview](/data-type-overview.md) - - [Default Values](/data-type-default-values.md) - + Numeric Types - - [`BIT`](/data-type-numeric.md#bit-type) - - [`BOOL|BOOLEAN`](/data-type-numeric.md#boolean-type) - - [`TINYINT`](/data-type-numeric.md#tinyint-type) - - [`SMALLINT`](/data-type-numeric.md#smallint-type) - - [`MEDIUMINT`](/data-type-numeric.md#mediumint-type) - - [`INT|INTEGER`](/data-type-numeric.md#integer-type) - - [`BIGINT`](/data-type-numeric.md#bigint-type) - - [`FLOAT`](/data-type-numeric.md#float-type) - - [`DOUBLE`](/data-type-numeric.md#double-type) - - [`DECIMAL`](/data-type-numeric.md#decimal-type) - + Date and Time Types - - [`DATE`](/data-type-date-and-time.md#date-type) - - [`TIME`](/data-type-date-and-time.md#time-type) - - [`DATETIME`](/data-type-date-and-time.md#datetime-type) - - [`TIMESTAMP`](/data-type-date-and-time.md#timestamp-type) - - [`YEAR`](/data-type-date-and-time.md#year-type) - + String Types - - [`CHAR`](/data-type-string.md#char-type) - - [`VARCHAR`](/data-type-string.md#varchar-type) - - [`TEXT`](/data-type-string.md#text-type) - - [`TINYTEXT`](/data-type-string.md#tinytext-type) - - [`MEDIUMTEXT`](/data-type-string.md#text-type) - - [`LONGTEXT`](/data-type-string.md#longtext-type) - - [`BINARY`](/data-type-string.md#binary-type) - - [`VARBINARY`](/data-type-string.md#varbinary-type) - - [`BLOB`](/data-type-string.md#blob-type) - - [`TINYBLOB`](/data-type-string.md#tinyblob-type) - - [`MEDIUMBLOB`](/data-type-string.md#mediumblob-type) - - [`LONGBLOB`](/data-type-string.md#longblob-type) - - [`ENUM`](/data-type-string.md#enum-type) - - [`SET`](/data-type-string.md#set-type) - - [JSON Type](/data-type-json.md) - + Functions and Operators - - [Function and Operator Reference](/functions-and-operators/functions-and-operators-overview.md) - - [Type Conversion in Expression Evaluation](/functions-and-operators/type-conversion-in-expression-evaluation.md) - - [Operators](/functions-and-operators/operators.md) - - [Control Flow Functions](/functions-and-operators/control-flow-functions.md) - - [String Functions](/functions-and-operators/string-functions.md) - - [Numeric Functions and Operators](/functions-and-operators/numeric-functions-and-operators.md) - - [Date and Time Functions](/functions-and-operators/date-and-time-functions.md) - - [Bit Functions and Operators](/functions-and-operators/bit-functions-and-operators.md) - - [Cast Functions and Operators](/functions-and-operators/cast-functions-and-operators.md) - - [Encryption and Compression Functions](/functions-and-operators/encryption-and-compression-functions.md) - - [Information Functions](/functions-and-operators/information-functions.md) - - [JSON Functions](/functions-and-operators/json-functions.md) - - [Aggregate (GROUP BY) Functions](/functions-and-operators/aggregate-group-by-functions.md) - - [Window Functions](/functions-and-operators/window-functions.md) - - [Miscellaneous Functions](/functions-and-operators/miscellaneous-functions.md) - - [Precision Math](/functions-and-operators/precision-math.md) - - [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md) - + SQL Statements + + SQL 语言结构和语法 + + 属性 + + [AUTO_INCREMENT](/auto-increment.md) + + [AUTO_RANDOM](/auto-random.md) + + [字面值](/literal-values.md) + + [Schema 对象名](/schema-object-names.md) + + [关键字](/keywords.md) + + [用户自定义变量](/user-defined-variables.md) + + [表达式语法](/expression-syntax.md) + + [注释语法](/comment-syntax.md) + + SQL 语句 - [`ADD COLUMN`](/sql-statements/sql-statement-add-column.md) - [`ADD INDEX`](/sql-statements/sql-statement-add-index.md) - [`ADMIN`](/sql-statements/sql-statement-admin.md) - [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md) + - [`ALTER INDEX`](/sql-statements/sql-statement-alter-index.md) - [`ALTER INSTANCE`](/sql-statements/sql-statement-alter-instance.md) - [`ALTER TABLE`](/sql-statements/sql-statement-alter-table.md) - [`ALTER USER`](/sql-statements/sql-statement-alter-user.md) - [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md) - - [`BACKUP`](/sql-statements/sql-statement-backup.md) - [`BEGIN`](/sql-statements/sql-statement-begin.md) + - [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) + - [`CHANGE DRAINER`](/sql-statements/sql-statement-change-drainer.md) + - [`CHANGE PUMP`](/sql-statements/sql-statement-change-pump.md) - [`COMMIT`](/sql-statements/sql-statement-commit.md) + - [`CREATE BINDING`](/sql-statements/sql-statement-create-binding.md) - [`CREATE DATABASE`](/sql-statements/sql-statement-create-database.md) - [`CREATE INDEX`](/sql-statements/sql-statement-create-index.md) - [`CREATE SEQUENCE`](/sql-statements/sql-statement-create-sequence.md) @@ -197,10 +251,12 @@ - [`DESC`](/sql-statements/sql-statement-desc.md) - [`DESCRIBE`](/sql-statements/sql-statement-describe.md) - [`DO`](/sql-statements/sql-statement-do.md) + - [`DROP BINDING`](/sql-statements/sql-statement-drop-binding.md) - [`DROP COLUMN`](/sql-statements/sql-statement-drop-column.md) - [`DROP DATABASE`](/sql-statements/sql-statement-drop-database.md) - [`DROP INDEX`](/sql-statements/sql-statement-drop-index.md) - [`DROP SEQUENCE`](/sql-statements/sql-statement-drop-sequence.md) + - [`DROP STATS`](/sql-statements/sql-statement-drop-stats.md) - [`DROP TABLE`](/sql-statements/sql-statement-drop-table.md) - [`DROP USER`](/sql-statements/sql-statement-drop-user.md) - [`DROP VIEW`](/sql-statements/sql-statement-drop-view.md) @@ -215,219 +271,192 @@ - [`INSERT`](/sql-statements/sql-statement-insert.md) - [`KILL [TIDB]`](/sql-statements/sql-statement-kill.md) - [`LOAD DATA`](/sql-statements/sql-statement-load-data.md) + - [`LOAD STATS`](/sql-statements/sql-statement-load-stats.md) - [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) - [`PREPARE`](/sql-statements/sql-statement-prepare.md) - [`RECOVER TABLE`](/sql-statements/sql-statement-recover-table.md) - [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md) - [`RENAME TABLE`](/sql-statements/sql-statement-rename-table.md) - [`REPLACE`](/sql-statements/sql-statement-replace.md) - - [`RESTORE`](/sql-statements/sql-statement-restore.md) - [`REVOKE `](/sql-statements/sql-statement-revoke-privileges.md) - [`ROLLBACK`](/sql-statements/sql-statement-rollback.md) - [`SELECT`](/sql-statements/sql-statement-select.md) - [`SET [NAMES|CHARACTER SET]`](/sql-statements/sql-statement-set-names.md) - [`SET PASSWORD`](/sql-statements/sql-statement-set-password.md) + - [`SET ROLE`](/sql-statements/sql-statement-set-role.md) - [`SET TRANSACTION`](/sql-statements/sql-statement-set-transaction.md) - [`SET [GLOBAL|SESSION] `](/sql-statements/sql-statement-set-variable.md) - - [`SHOW [BACKUPS|RESTORES]`](/sql-statements/sql-statement-show-backups.md) + - [`SHOW ANALYZE STATUS`](/sql-statements/sql-statement-show-analyze-status.md) + - [`SHOW BINDINGS`](/sql-statements/sql-statement-show-bindings.md) + - [`SHOW BUILTINS`](/sql-statements/sql-statement-show-builtins.md) - [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md) - [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md) - [`SHOW [FULL] COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md) + - [`SHOW CONFIG`](/sql-statements/sql-statement-show-config.md) - [`SHOW CREATE SEQUENCE`](/sql-statements/sql-statement-show-create-sequence.md) - [`SHOW CREATE TABLE`](/sql-statements/sql-statement-show-create-table.md) - [`SHOW CREATE USER`](/sql-statements/sql-statement-show-create-user.md) - [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md) + - [`SHOW DRAINER STATUS`](/sql-statements/sql-statement-show-drainer-status.md) - [`SHOW ENGINES`](/sql-statements/sql-statement-show-engines.md) - [`SHOW ERRORS`](/sql-statements/sql-statement-show-errors.md) - [`SHOW [FULL] FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md) - [`SHOW GRANTS`](/sql-statements/sql-statement-show-grants.md) - - [`SHOW INDEXES [FROM|IN]`](/sql-statements/sql-statement-show-indexes.md) - [`SHOW INDEX [FROM|IN]`](/sql-statements/sql-statement-show-index.md) + - [`SHOW INDEXES [FROM|IN]`](/sql-statements/sql-statement-show-indexes.md) - [`SHOW KEYS [FROM|IN]`](/sql-statements/sql-statement-show-keys.md) + - [`SHOW MASTER STATUS`](/sql-statements/sql-statement-show-master-status.md) + - [`SHOW PLUGINS`](/sql-statements/sql-statement-show-plugins.md) - [`SHOW PRIVILEGES`](/sql-statements/sql-statement-show-privileges.md) - [`SHOW [FULL] PROCESSSLIST`](/sql-statements/sql-statement-show-processlist.md) + - [`SHOW PROFILES`](/sql-statements/sql-statement-show-profiles.md) + - [`SHOW PUMP STATUS`](/sql-statements/sql-statement-show-pump-status.md) - [`SHOW SCHEMAS`](/sql-statements/sql-statement-show-schemas.md) - - [`SHOW [FULL] TABLES`](/sql-statements/sql-statement-show-tables.md) + - [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-histograms.md) + - [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md) + - [`SHOW STATUS`](/sql-statements/sql-statement-show-status.md) + - [`SHOW TABLE NEXT_ROW_ID`](/sql-statements/sql-statement-show-table-next-rowid.md) - [`SHOW TABLE REGIONS`](/sql-statements/sql-statement-show-table-regions.md) - [`SHOW TABLE STATUS`](/sql-statements/sql-statement-show-table-status.md) + - [`SHOW [FULL] TABLES`](/sql-statements/sql-statement-show-tables.md) - [`SHOW [GLOBAL|SESSION] VARIABLES`](/sql-statements/sql-statement-show-variables.md) - [`SHOW WARNINGS`](/sql-statements/sql-statement-show-warnings.md) + - [`SHUTDOWN`](/sql-statements/sql-statement-shutdown.md) - [`SPLIT REGION`](/sql-statements/sql-statement-split-region.md) - [`START TRANSACTION`](/sql-statements/sql-statement-start-transaction.md) - [`TRACE`](/sql-statements/sql-statement-trace.md) - [`TRUNCATE`](/sql-statements/sql-statement-truncate.md) - [`UPDATE`](/sql-statements/sql-statement-update.md) - [`USE`](/sql-statements/sql-statement-use.md) - - [Constraints](/constraints.md) - - [Generated Columns](/generated-columns.md) - - [Partitioning](/partitioned-table.md) - - [Character Set and Collation](/character-set-and-collation.md) - - [SQL Mode](/sql-mode.md) - - [SQL Diagnosis](/system-tables/system-table-sql-diagnosis.md) - - [Views](/views.md) - + Configuration - + tidb-server - - [MySQL System Variables](/system-variables.md) - - [TiDB Specific System Variables](/tidb-specific-system-variables.md) - - [Configuration Flags](/command-line-flags-for-tidb-configuration.md) - - [Configuration File](/tidb-configuration-file.md) - + pd-server - - [Configuration Flags](/command-line-flags-for-pd-configuration.md) - - [Configuration File](/pd-configuration-file.md) - + tikv-server - - [Configuration Flags](/command-line-flags-for-tikv-configuration.md) - - [Configuration File](/tikv-configuration-file.md) - + Security - - [Security Compatibility with MySQL](/security-compatibility-with-mysql.md) - - [The TiDB Access Privilege System](/privilege-management.md) - - [TiDB User Account Management](/user-account-management.md) - - [Role-Based Access Control](/role-based-access-control.md) - - [Certificate-Based Authentication](/certificate-authentication.md) - + Transactions - - [Overview](/transaction-overview.md) - - [Isolation Levels](/transaction-isolation-levels.md) - - [Optimistic Transactions](/optimistic-transaction.md) - - [Pessimistic Transactions](/pessimistic-transaction.md) - + System Databases - - [`mysql`](/system-tables/system-table-overview.md) - - [`information_schema`](/system-tables/system-table-information-schema.md) - + `sql-diagnosis` - - [`cluster_info`](/system-tables/system-table-cluster-info.md) - - [`cluster_hardware`](/system-tables/system-table-cluster-hardware.md) - - [`cluster_config`](/system-tables/system-table-cluster-config.md) - - [`cluster_load`](/system-tables/system-table-cluster-load.md) - - [`cluster_systeminfo`](/system-tables/system-table-cluster-systeminfo.md) - - [`cluster_log`](/system-tables/system-table-cluster-log.md) - - [`metrics_schema`](/system-tables/system-table-metrics-schema.md) - - [`metrics_tables`](/system-tables/system-table-metrics-tables.md) - - [`metrics_summary`](/system-tables/system-table-metrics-summary.md) - - [`inspection_result`](/system-tables/system-table-inspection-result.md) - - [`inspection_summary`](/system-tables/system-table-inspection-summary.md) - - [Errors Codes](/error-codes.md) - - [Supported Client Drivers](/connectors-and-apis.md) - + Garbage Collection (GC) - - [GC Overview](/garbage-collection-overview.md) - - [GC Configuration](/garbage-collection-configuration.md) - + Performance - - [Overview](/sql-optimization-concepts.md) - - [Understanding the Query Execution Plan](/query-execution-plan.md) - - [Introduction to Join Reorder](/join-reorder.md) - - [Introduction to Statistics](/statistics.md) - - [Optimizer Hints](/optimizer-hints.md) - - [Follower Read](/follower-read.md) - - [Check the TiDB Cluster Status Using SQL Statements](/check-cluster-status-using-sql-statements.md) - - [SQL Plan Management](/sql-plan-management.md) - - [Access Tables Using `IndexMerge`](/index-merge.md) - - [Statement Summary Table](/statement-summary-tables.md) - - [Coprocessor Cache](/coprocessor-cache.md) - - [Tune TiKV](/tune-tikv-performance.md) - + Key Monitoring Metrics - - [Overview](/grafana-overview-dashboard.md) - - [TiDB](/grafana-tidb-dashboard.md) - - [PD](/grafana-pd-dashboard.md) - - [TiKV](/grafana-tikv-dashboard.md) - - [Alert Rules](/alert-rules.md) - + Best Practices - - [Highly Concurrent Write Best Practices](/best-practices/high-concurrency-best-practices.md) - - [HAProxy Best Practices](/best-practices/haproxy-best-practices.md) - - [Java Application Development Best Practices](/best-practices/java-app-best-practices.md) - - [PD Scheduling Best Practices](/best-practices/pd-scheduling-best-practices.md) - - [Grafana Best Practices](/best-practices/grafana-monitor-best-practices.md) - - [TiKV Performance Tuning with Massive Regions](/best-practices/massive-regions-best-practices.md) - - [TiSpark](/tispark-overview.md) - + TiFlash - - [Overview](/tiflash/tiflash-overview.md) - - [Deploy a TiFlash Cluster](/tiflash/deploy-tiflash.md) - - [Use TiFlash](/tiflash/use-tiflash.md) - - [Maintain a TiFlash Cluster](/tiflash/maintain-tiflash.md) - - [Monitor TiFlash](/tiflash/monitor-tiflash.md) - - [Scale TiFlash](/scale-tidb-using-tiup.md#scale-out-a-tiflash-node) - - [Configure TiFlash](/tiflash/tiflash-configuration.md) - - [TiFlash Alert Rules](/tiflash/tiflash-alert-rules.md) - - [Tune TiFlash Performance](/tiflash/tune-tiflash-performance.md) - - [Troubleshoot a TiFlash Cluster](/tiflash/troubleshoot-tiflash.md) - - [FAQ](/tiflash/tiflash-faq.md) - + TiDB Binlog - - [Overview](/tidb-binlog/tidb-binlog-overview.md) - - [Deploy](/tidb-binlog/deploy-tidb-binlog.md) - - [Maintain](/tidb-binlog/maintain-tidb-binlog-cluster.md) - - [Monitor](/tidb-binlog/monitor-tidb-binlog-cluster.md) - + [Configure](/tidb-binlog/tidb-binlog-configuration-file.md) - - [Pump](/tidb-binlog/tidb-binlog-configuration-file.md#pump) - - [Drainer](/tidb-binlog/tidb-binlog-configuration-file.md#drainer) - - [Upgrade](/tidb-binlog/upgrade-tidb-binlog.md) - - [Reparo](/tidb-binlog/tidb-binlog-reparo.md) - - [Binlog Slave Client](/tidb-binlog/binlog-slave-client.md) - - [TiDB Binlog Relay Log](/tidb-binlog/tidb-binlog-relay-log.md) - - [Bidirectional Replication Between TiDB Clusters](/tidb-binlog/bidirectional-replication-between-tidb-clusters.md) - - [Glossary](/tidb-binlog/tidb-binlog-glossary.md) - + Troubleshoot - - [Troubleshooting](/tidb-binlog/troubleshoot-tidb-binlog.md) - - [Error Handling](/tidb-binlog/handle-tidb-binlog-errors.md) - - [FAQ](/tidb-binlog/tidb-binlog-faq.md) - + Tools - - [Tools User Guide](/ecosystem-tool-user-guide.md) - - [Download](/download-ecosystem-tools.md) - + Backup & Restore (BR) - - [Use BR](/br/backup-and-restore-tool.md) - - [BR Use Cases](/br/backup-and-restore-use-cases.md) - - [BR storages](/br/backup-and-restore-storages.md) - - [BR FAQ](/br/backup-and-restore-faq.md) - - [Mydumper](/mydumper-overview.md) - - [Syncer](/syncer-overview.md) - - [Loader](/loader-overview.md) - - [Data Migration](https://pingcap.com/docs/tidb-data-migration/stable/) - + TiDB Lightning - - [Overview](/tidb-lightning/tidb-lightning-overview.md) - - [Deployment](/tidb-lightning/deploy-tidb-lightning.md) - - [Configuration](/tidb-lightning/tidb-lightning-configuration.md) - - [Checkpoints](/tidb-lightning/tidb-lightning-checkpoints.md) - - [Table Filter](/tidb-lightning/tidb-lightning-table-filter.md) - - [CSV Support](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) - - [TiDB-backend](/tidb-lightning/tidb-lightning-tidb-backend.md) - - [Web Interface](/tidb-lightning/tidb-lightning-web-interface.md) - - [Monitor](/tidb-lightning/monitor-tidb-lightning.md) - - [Troubleshoot](/troubleshoot-tidb-lightning.md) - - [FAQ](/tidb-lightning/tidb-lightning-faq.md) - - [Glossary](/tidb-lightning/tidb-lightning-glossary.md) - + TiCDC - - [Overview](/ticdc/ticdc-overview.md) - - [Deploy and Use TiCDC](/ticdc/deploy-ticdc.md) - - [Manage TiCDC Cluster and Replication Tasks](/ticdc/manage-ticdc.md) - - [Configure Sink URI](/ticdc/sink-url.md) - - [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md) - - [Column and DDL Type Codes](/ticdc/column-ddl-type-codes.md) - + sync-diff-inspector - - [Overview](/sync-diff-inspector/sync-diff-inspector-overview.md) - - [Data Check for Tables with Different Schema or Table Names](/sync-diff-inspector/route-diff.md) - - [Data Check in the Sharding Scenario](/sync-diff-inspector/shard-diff.md) - - [Data Check for TiDB Upstream and Downstream Clusters](/sync-diff-inspector/upstream-downstream-diff.md) - + TiUP - - [TiUP Overview](/tiup/tiup-overview.md) - - [Manage Components with Commands](/tiup/manage-tiup-component.md) - - [Quickly Deploy a Local TiDB Cluster](/tiup/tiup-playground.md) - - [Deploy and Maintain an Online TiDB Cluster](/tiup/tiup-cluster.md) - - [Create a Private Mirror](/tiup/tiup-mirrors.md) - - [Package a Component](/tiup/package-tiup-component.md) - - [Stress Test TiDB Using TiUP](/tiup/tiup-bench.md) - - [PD Control](/pd-control.md) - - [PD Recover](/pd-recover.md) - - [TiKV Control](/tikv-control.md) - - [TiDB Control](/tidb-control.md) -- [TiDB in Kubernetes](https://pingcap.com/docs/tidb-in-kubernetes/stable/) -+ FAQs - - [TiDB FAQs](/faq/tidb-faq.md) - - [TiDB Lightning FAQs](/tidb-lightning/tidb-lightning-faq.md) - - [Upgrade FAQs](/faq/upgrade-faq.md) -+ Support - - [Support Resources](/support.md) - - [Report an Issue](/report-issue.md) -+ Contribute - - [Contribute to TiDB](/contribute.md#contribute-to-tidb) - - [Improve the Docs](/contribute.md#improve-the-docs) -- [Adopters](/adopters.md) -- [Roadmap](/roadmap.md) -+ [Releases](/releases/release-notes.md) + + 数据类型 + + [数据类型概述](/data-type-overview.md) + + [数据类型默认值](/data-type-default-values.md) + + [数值类型](/data-type-numeric.md) + + [日期和时间类型](/data-type-date-and-time.md) + + [字符串类型](/data-type-string.md) + + [JSON 类型](/data-type-json.md) + + 函数与操作符 + + [函数与操作符概述](/functions-and-operators/functions-and-operators-overview.md) + + [表达式求值的类型转换](/functions-and-operators/type-conversion-in-expression-evaluation.md) + + [操作符](/functions-and-operators/operators.md) + + [控制流程函数](/functions-and-operators/control-flow-functions.md) + + [字符串函数](/functions-and-operators/string-functions.md) + + [数值函数与操作符](/functions-and-operators/numeric-functions-and-operators.md) + + [日期和时间函数](/functions-and-operators/date-and-time-functions.md) + + [位函数和操作符](/functions-and-operators/bit-functions-and-operators.md) + + [Cast 函数和操作符](/functions-and-operators/cast-functions-and-operators.md) + + [加密和压缩函数](/functions-and-operators/encryption-and-compression-functions.md) + + [信息函数](/functions-and-operators/information-functions.md) + + [JSON 函数](/functions-and-operators/json-functions.md) + + [GROUP BY 聚合函数](/functions-and-operators/aggregate-group-by-functions.md) + + [窗口函数](/functions-and-operators/window-functions.md) + + [其它函数](/functions-and-operators/miscellaneous-functions.md) + + [精度数学](/functions-and-operators/precision-math.md) + + [下推到 TiKV 的表达式列表](/functions-and-operators/expressions-pushed-down.md) + + [约束](/constraints.md) + + [生成列](/generated-columns.md) + + [SQL 模式](/sql-mode.md) + + 事务 + + [事务概览](/transaction-overview.md) + + [隔离级别](/transaction-isolation-levels.md) + + [乐观事务](/optimistic-transaction.md) + + [悲观事务](/pessimistic-transaction.md) + + 垃圾回收 (GC) + + [GC 机制简介](/garbage-collection-overview.md) + + [GC 配置](/garbage-collection-configuration.md) + + [视图](/views.md) + + [分区表](/partitioned-table.md) + + [字符集和排序规则](/character-set-and-collation.md) + + 系统表 + + [`mysql`](/system-tables/system-table-overview.md) + + [`information_schema`](/system-tables/system-table-information-schema.md) + + sql-diagnosis + + [`cluster_info`](/system-tables/system-table-cluster-info.md) + + [`cluster_hardware`](/system-tables/system-table-cluster-hardware.md) + + [`cluster_config`](/system-tables/system-table-cluster-config.md) + + [`cluster_load`](/system-tables/system-table-cluster-load.md) + + [`cluster_systeminfo`](/system-tables/system-table-cluster-systeminfo.md) + + [`cluster_log`](/system-tables/system-table-cluster-log.md) + + [`metrics_schema`](/system-tables/system-table-metrics-schema.md) + + [`metrics_tables`](/system-tables/system-table-metrics-tables.md) + + [`metrics_summary`](/system-tables/system-table-metrics-summary.md) + + [`inspection_result`](/system-tables/system-table-inspection-result.md) + + [`inspection_summary`](/system-tables/system-table-inspection-summary.md) + + UI + + TiDB Dashboard + + [简介](/dashboard/dashboard-intro.md) + + 运维 + + [部署](/dashboard/dashboard-ops-deploy.md) + + [反向代理](/dashboard/dashboard-ops-reverse-proxy.md) + + [安全](/dashboard/dashboard-ops-security.md) + + [访问](/dashboard/dashboard-access.md) + + [概况页面](/dashboard/dashboard-overview.md) + + [集群信息页面](/dashboard/dashboard-cluster-info.md) + + [流量可视化页面](/dashboard/dashboard-key-visualizer.md) + + SQL 语句分析 + + [列表页面](/dashboard/dashboard-statement-list.md) + + [执行详情页面](/dashboard/dashboard-statement-details.md) + + [慢查询页面](/dashboard/dashboard-slow-query.md) + + 集群诊断页面 + + [访问](/dashboard/dashboard-diagnostics-access.md) + + [查看报告](/dashboard/dashboard-diagnostics-report.md) + + [使用示例](/dashboard/dashboard-diagnostics-usage.md) + + [日志搜索页面](/dashboard/dashboard-log-search.md) + + [实例性能分析页面](/dashboard/dashboard-profiling.md) + + [常见问题](/dashboard/dashboard-faq.md) + + CLI + + [tikv-ctl](/tikv-control.md) + + [pd-ctl](/pd-control.md) + + [tidb-ctl](/tidb-control.md) + + [pd-recover](/pd-recover.md) + + [binlog-ctl](/tidb-binlog/binlog-control.md) + + 命令行参数 + + [tidb-server](/command-line-flags-for-tidb-configuration.md) + + [tikv-server](/command-line-flags-for-tikv-configuration.md) + + [tiflash-server](/tiflash/tiflash-command-line-flags.md) + + [pd-server](/command-line-flags-for-pd-configuration.md) + + 配置文件参数 + + [tidb-server](/tidb-configuration-file.md) + + [tikv-server](/tikv-configuration-file.md) + + [tiflash-server](/tiflash/tiflash-configuration.md) + + [pd-server](/pd-configuration-file.md) + + 系统变量 + + [MySQL 系统变量](/system-variables.md) + + [TiDB 特定系统变量](/tidb-specific-system-variables.md) + + 存储引擎 + + TiKV + + [TiKV 简介](/tikv-overview.md) + + [RocksDB 简介](/rocksdb/rocksdb-overview.md) + + TiFlash + + [TiFlash 简介](/tiflash/tiflash-overview.md) + + [使用 TiFlash](/tiflash/use-tiflash.md) + + TiUP + + [文档指南](/tiup/tiup-documentation-guide.md) + + [概览](/tiup/tiup-overview.md) + + [术语及核心概念](/tiup/tiup-terminology-and-concepts.md) + + [TiUP 组件管理](/tiup/tiup-component-management.md) + + [FAQ](/tiup/tiup-faq.md) + + [故障排查](/tiup/tiup-troubleshooting-guide.md) + + TiUP 组件文档 + + [tiup-playground 运行本地测试集群](/tiup/tiup-playground.md) + + [tiup-cluster 部署运维生产集群](/tiup/tiup-cluster.md) + + [tiup-mirror 定制离线镜像](/tiup/tiup-mirror.md) + + [tiup-bench 进行 TPCC/TPCH 压力测试](/tiup/tiup-bench.md) + + [错误码](/error-codes.md) + + [TiCDC 简介](/ticdc/ticdc-overview.md) + + [TiCDC 开放数据协议](/ticdc/ticdc-open-protocol.md) + + [通过拓扑 label 进行副本调度](/schedule-replicas-by-topology-labels.md) ++ 常见问题解答 (FAQ) + + [产品 FAQ](/faq/tidb-faq.md) + + [SQL FAQ](/faq/sql-faq.md) + + [部署运维 FAQ](/faq/deploy-and-maintain-faq.md) + + [升级 FAQ](/faq/upgrade-faq.md) + + [高可用 FAQ](/faq/high-availability-faq.md) + + [高可靠 FAQ](/faq/high-reliability-faq.md) + + [迁移 FAQ](/faq/migration-tidb-faq.md) ++ [术语表](/glossary.md) ++ 版本发布历史 + + [发布版本汇总](/releases/release-notes.md) + v4.0 - [4.0 GA](/releases/release-4.0-ga.md) - [4.0.0-rc.2](/releases/release-4.0.0-rc.2.md) @@ -513,18 +542,9 @@ - [1.1 Beta](/releases/release-1.1-beta.md) - [1.1 Alpha](/releases/release-1.1-alpha.md) + v1.0 - - [1.0.8](/releases/release-1.0.8.md) - - [1.0.7](/releases/release-1.0.7.md) - - [1.0.6](/releases/release-1.0.6.md) - - [1.0.5](/releases/release-1.0.5.md) - - [1.0.4](/releases/release-1.0.4.md) - - [1.0.3](/releases/release-1.0.3.md) - - [1.0.2](/releases/release-1.0.2.md) - - [1.0.1](/releases/release-1.0.1.md) - [1.0](/releases/release-1.0-ga.md) - [Pre-GA](/releases/release-pre-ga.md) - [RC4](/releases/release-rc.4.md) - [RC3](/releases/release-rc.3.md) - [RC2](/releases/release-rc.2.md) - [RC1](/releases/release-rc.1.md) -+ [Glossary](/glossary.md) From 359b8c722ee212278f79f25f6adfbd81388048bc Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 9 Jun 2020 19:39:32 +0800 Subject: [PATCH 02/15] Update TOC.md --- TOC.md | 425 +++++++++++++++++++++++++-------------------------------- 1 file changed, 186 insertions(+), 239 deletions(-) diff --git a/TOC.md b/TOC.md index 3433da009e0b6..3d5341be1ce4b 100644 --- a/TOC.md +++ b/TOC.md @@ -48,180 +48,140 @@ + [Use TiDB Lightning](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) + [Use `LOAD DATA` Statement](/sql-statements/sql-statement-load-data.md) + Maintain - + 升级 TiDB 版本 - + [使用 TiUP 升级（推荐）](/upgrade-tidb-using-tiup.md) - + [使用 TiUP 离线升级（推荐）](/upgrade-tidb-using-tiup-offline.md) - + [使用 TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/) - + [使用 TiDB Ansible](/upgrade-tidb-using-ansible.md) - + 扩缩容 - + [使用 TiUP（推荐）](/scale-tidb-using-tiup.md) - + [使用 TiDB Ansible](/scale-tidb-using-ansible.md) - + [使用 TiDB Operator](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/scale-a-tidb-cluster/) - + 备份与恢复 - + [使用 Mydumper 和 TiDB Lightning 进行备份与恢复](/backup-and-restore-using-mydumper-lightning.md) - + [使用 Dumpling 导出或备份 TiDB 数据](/export-or-backup-using-dumpling.md) - + 使用 BR 工具 - + [使用 BR 进行备份与恢复](/br/backup-and-restore-tool.md) - + [BR 备份与恢复场景示例](/br/backup-and-restore-use-cases.md) - + [日常巡检](/daily-check.md) - + [TiCDC 运维操作及任务管理](/ticdc/manage-ticdc.md) - + [TiFlash 常用运维操作](/tiflash/maintain-tiflash.md) - + [TiUP 常用运维操作](/maintain-tidb-using-tiup.md) - + [Ansible 常用运维操作](/maintain-tidb-using-ansible.md) -+ Monitor and alert - + [监控框架概述](/tidb-monitoring-framework.md) - + [监控 API](/tidb-monitoring-api.md) - + [手动部署监控](/deploy-monitoring-services.md) - + [TiDB 集群报警规则与处理方法](/alert-rules.md) - + [TiFlash 报警规则与处理方法](/tiflash/tiflash-alert-rules.md) + + Upgrade + + [Use TiUP (Recommended)](/upgrade-tidb-using-tiup.md) + + [Use TiUP Offline (Recommended)](/upgrade-tidb-using-tiup-offline.md) + + [Use TiDB Operator](https://pingcap.com/docs/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/) + + [Use TiDB Ansible](/upgrade-tidb-using-ansible.md) + + Scale + + [Use TiUP (Recommended)](/scale-tidb-using-tiup.md) + + [Use TiDB Ansible](/scale-tidb-using-ansible.md) + + [Use TiDB Operator](https://pingcap.com/docs/tidb-in-kubernetes/stable/scale-a-tidb-cluster/) + + Backup and Restore + + [Use Mydumper and TiDB Lightning](/backup-and-restore-using-mydumper-lightning.md) + + Use BR Tool + + [Use BR Tool](/br/backup-and-restore-tool.md) + + [BR Use Cases](/br/backup-and-restore-use-cases.md) + + [Daily Checklist](/daily-check.md) + + [Maintain TiCDC](/ticdc/manage-ticdc.md) + + [Maintain TiFlash](/tiflash/maintain-tiflash.md) + + [Maintain TiDB Using TiUP](/maintain-tidb-using-tiup.md) + + [Maintain TiDB Using Ansible](/maintain-tidb-using-ansible.md) ++ Monitor and Alert + + [Monitoring Framework](/tidb-monitoring-framework.md) + + [Monitor a TiDB Cluster](/monitor-a-tidb-cluster.md) + + [TiDB Cluster Alert Rules](/alert-rules.md) + + [TiFlash Alert Rules](/tiflash/tiflash-alert-rules.md) + Troubleshoot - + [定位慢查询](/identify-slow-queries.md) - + [SQL 诊断](/system-tables/system-table-sql-diagnostics.md) - + [定位消耗系统资源多的查询](/identify-expensive-queries.md) - + [SQL 语句统计](/statement-summary-tables.md) - + [热点问题处理](/troubleshoot-hot-spot-issues.md) - + [CPU 占用过多导致读写延迟增加](/troubleshoot-cpu-issues.md) - + [写冲突与写性能下降](/troubleshoot-write-conflicts.md) - + [磁盘 I/O 过高](/troubleshoot-high-disk-io.md) - + [锁冲突与 TTL 超时](/troubleshoot-lock-conflicts.md) - + [TiCDC 常见问题](/ticdc/troubleshoot-ticdc.md) - + [TiFlash 常见问题](/tiflash/troubleshoot-tiflash.md) -+ Tune Performance - + 系统调优 - + [操作系统性能参数调优](/tune-operating-system.md) - + 软件调优 - + 配置 - + [TiKV 线程调优](/tune-tikv-thread-performance.md) - + [TiKV 内存调优](/tune-tikv-memory-performance.md) - + [TiFlash 调优](/tiflash/tune-tiflash-performance.md) - + [下推计算结果缓存](/coprocessor-cache.md) - + SQL 性能调优 - + [SQL 性能调优概览](/sql-tuning-overview.md) - + [理解 TiDB 执行计划](/query-execution-plan.md) - + SQL 优化 - + [SQL 优化流程简介](/sql-optimization-concepts.md) - + 逻辑优化 - + [逻辑优化概览](/sql-logical-optimization.md) - + [子查询相关的优化](/subquery-optimization.md) - + [列裁剪](/column-pruning.md) - + [关联子查询去关联](/correlated-subquery-optimization.md) - + [Max/Min 消除](/max-min-eliminate.md) - + [谓词下推](/predicate-push-down.md) - + [分区裁剪](/partition-pruning.md) - + [TopN 和 Limit 下推](/topn-limit-push-down.md) + + [Identify Slow Queries](/identify-slow-queries.md) + + [Identify Expensive Queries](/identify-expensive-queries.md) + + [Statement Summary Tables](/statement-summary-tables.md) + + [Troubleshoot TiFlash](/tiflash/troubleshoot-tiflash.md) ++ Performance Tuning + + Software Tuning + + Configuration + + [TiFlash Tuning](/tiflash/tune-tiflash-performance.md) + + [Coprocessor Cache](/coprocessor-cache.md) + + SQL Tuning + + [SQL Tuning with `EXPLAIN`](/query-execution-plan.md) + + SQL Optimization + + [SQL Optimization Process](/sql-optimization-concepts.md) + + Logic Optimization + [Join Reorder](/join-reorder.md) - + 物理优化 - + [物理优化概览](/sql-physical-optimization.md) - + [索引的选择](/choose-index.md) - + [统计信息简介](/statistics.md) - + [错误索引的解决方案](/wrong-index-solution.md) - + [Distinct 优化](/agg-distinct-optimization.md) - + [执行计划缓存](/sql-prepare-plan-cache.md) - + 控制执行计划 - + [控制执行计划概览](/control-execution-plan.md) + + Physical Optimization + + [Statistics](/statistics.md) + + Control Execution Plan + [Optimizer Hints](/optimizer-hints.md) - + [执行计划管理](/sql-plan-management.md) - + [优化规则及表达式下推的黑名单](/blacklist-control-plan.md) -+ 教程 - + [同城多中心部署](/multi-data-centers-in-one-city-deployment.md) - + [两地三中心部署](/three-data-centers-in-two-cities-deployment.md) - + 最佳实践 - + [TiDB 最佳实践](/best-practices/tidb-best-practices.md) - + [Java 应用开发最佳实践](/best-practices/java-app-best-practices.md) - + [HAProxy 最佳实践](/best-practices/haproxy-best-practices.md) - + [高并发写入场景最佳实践](/best-practices/high-concurrency-best-practices.md) - + [Grafana 监控最佳实践](/best-practices/grafana-monitor-best-practices.md) - + [PD 调度策略最佳实践](/best-practices/pd-scheduling-best-practices.md) - + [海量 Region 集群调优](/best-practices/massive-regions-best-practices.md) - + [Placement Rules 使用文档](/configure-placement-rules.md) - + [Load Base Split 使用文档](/configure-load-base-split.md) - + [Store Limit 使用文档](/configure-store-limit.md) -+ TiDB 生态工具 - + [功能概览](/ecosystem-tool-user-guide.md) - + [适用场景](/ecosystem-tool-user-case.md) - + [工具下载](/download-ecosystem-tools.md) + + [SQL Plan Management](/sql-plan-management.md) ++ Tutorials + + Best Practices + + [Java Application Development](/best-practices/java-app-best-practices.md) + + [Use HAProxy](/best-practices/haproxy-best-practices.md) + + [Highly Concurrent Write](/best-practices/high-concurrency-best-practices.md) + + [Grafana Monitoring](/best-practices/grafana-monitor-best-practices.md) + + [PD Scheduling](/best-practices/pd-scheduling-best-practices.md) + + [TiKV Performance Tuning with Massive Regions](/best-practices/massive-regions-best-practices.md) + + [Use Placement Rules](/configure-placement-rules.md) ++ TiDB Ecosystem Tools + + [Tools Guide](/ecosystem-tool-user-guide.md) + + [Download](/download-ecosystem-tools.md) + Backup & Restore (BR) - + [BR 常见问题](/br/backup-and-restore-faq.md) - + [使用 BR 进行备份和恢复](/br/backup-and-restore-tool.md) - + [BR 备份与恢复场景示例](/br/backup-and-restore-use-cases.md) + + [BR FAQ](/br/backup-and-restore-faq.md) + + [Use BR Tool](/br/backup-and-restore-tool.md) + + [BR Use Cases](/br/backup-and-restore-use-cases.md) + TiDB Binlog - + [概述](/tidb-binlog/tidb-binlog-overview.md) - + [部署使用](/tidb-binlog/deploy-tidb-binlog.md) - + [运维管理](/tidb-binlog/maintain-tidb-binlog-cluster.md) - + [配置说明](/tidb-binlog/tidb-binlog-configuration-file.md) + + [Overview](/tidb-binlog/tidb-binlog-overview.md) + + [Deploy](/tidb-binlog/deploy-tidb-binlog.md) + + [Maintain](/tidb-binlog/maintain-tidb-binlog-cluster.md) + + [Configure](/tidb-binlog/tidb-binlog-configuration-file.md) + [Pump](/tidb-binlog/tidb-binlog-configuration-file.md#pump) + [Drainer](/tidb-binlog/tidb-binlog-configuration-file.md#drainer) - + [版本升级](/tidb-binlog/upgrade-tidb-binlog.md) - + [监控告警](/tidb-binlog/monitor-tidb-binlog-cluster.md) - + [增量恢复](/tidb-binlog/tidb-binlog-reparo.md) - + [binlogctl 工具](/tidb-binlog/binlog-control.md) - + [Kafka 自定义开发](/tidb-binlog/binlog-slave-client.md) + + [Upgrade](/tidb-binlog/upgrade-tidb-binlog.md) + + [Monitor](/tidb-binlog/monitor-tidb-binlog-cluster.md) + + [Reparo](/tidb-binlog/tidb-binlog-reparo.md) + + [Binlog Slave Client](/tidb-binlog/binlog-slave-client.md) + [TiDB Binlog Relay Log](/tidb-binlog/tidb-binlog-relay-log.md) - + [集群间双向同步](/tidb-binlog/bidirectional-replication-between-tidb-clusters.md) - + [术语表](/tidb-binlog/tidb-binlog-glossary.md) - + 故障诊断 - + [故障诊断](/tidb-binlog/troubleshoot-tidb-binlog.md) - + [常见错误修复](/tidb-binlog/handle-tidb-binlog-errors.md) + + [Bidirectional Replication Between TiDB Clusters](/tidb-binlog/bidirectional-replication-between-tidb-clusters.md) + + [Glossary](/tidb-binlog/tidb-binlog-glossary.md) + + Troubleshoot + + [Troubleshoot](/tidb-binlog/troubleshoot-tidb-binlog.md) + + [Handle Errors](/tidb-binlog/handle-tidb-binlog-errors.md) + [FAQ](/tidb-binlog/tidb-binlog-faq.md) + TiDB Lightning - + [概述](/tidb-lightning/tidb-lightning-overview.md) - + [快速上手教程](/get-started-with-tidb-lightning.md) - + [部署执行](/tidb-lightning/deploy-tidb-lightning.md) - + [参数说明](/tidb-lightning/tidb-lightning-configuration.md) - + 主要功能 - + [断点续传](/tidb-lightning/tidb-lightning-checkpoints.md) - + [表库过滤](/tidb-lightning/tidb-lightning-table-filter.md) - + [CSV 支持](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) + + [Overview](/tidb-lightning/tidb-lightning-overview.md) + + [Tutorial](/get-started-with-tidb-lightning.md) + + [Deploy](/tidb-lightning/deploy-tidb-lightning.md) + + [Configure](/tidb-lightning/tidb-lightning-configuration.md) + + Key Features + + [Checkpoints](/tidb-lightning/tidb-lightning-checkpoints.md) + + [Table Filter](/tidb-lightning/tidb-lightning-table-filter.md) + + [CSV Support](/tidb-lightning/migrate-from-csv-using-tidb-lightning.md) + [TiDB-backend](/tidb-lightning/tidb-lightning-tidb-backend.md) - + [Web 界面](/tidb-lightning/tidb-lightning-web-interface.md) - + [监控告警](/tidb-lightning/monitor-tidb-lightning.md) - + [故障诊断](/troubleshoot-tidb-lightning.md) + + [Web Interface](/tidb-lightning/tidb-lightning-web-interface.md) + + [Monitor](/tidb-lightning/monitor-tidb-lightning.md) + + [Troubleshoot](/troubleshoot-tidb-lightning.md) + [FAQ](/tidb-lightning/tidb-lightning-faq.md) - + [术语表](/tidb-lightning/tidb-lightning-glossary.md) + + [Glossary](/tidb-lightning/tidb-lightning-glossary.md) + [TiCDC](/ticdc/ticdc-overview.md) + sync-diff-inspector - + [概述](/sync-diff-inspector/sync-diff-inspector-overview.md) - + [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md) - + [分库分表场景下的数据校验](/sync-diff-inspector/shard-diff.md) - + [TiDB 主从集群的数据校验](/sync-diff-inspector/upstream-downstream-diff.md) + + [Overview](/sync-diff-inspector/sync-diff-inspector-overview.md) + + [Data Check for Tables with Different Schema/Table Names](/sync-diff-inspector/route-diff.md) + + [Data Check in Sharding Scenarios](/sync-diff-inspector/shard-diff.md) + + [Data Check for TiDB Upstream/Downstream Clusters](/sync-diff-inspector/upstream-downstream-diff.md) + [Loader](/loader-overview.md) + [Mydumper](/mydumper-overview.md) + [Syncer](/syncer-overview.md) -+ 参考指南 - + 架构 - + [概述](/tidb-architecture.md) - + [存储](/tidb-storage.md) - + [计算](/tidb-computing.md) - + [调度](/tidb-scheduling.md) - + 监控指标 - + [Overview 面板](/grafana-overview-dashboard.md) - + [TiDB 面板](/grafana-tidb-dashboard.md) - + [PD 面板](/grafana-pd-dashboard.md) - + [TiKV 面板](/grafana-tikv-dashboard.md) - + [TiFlash 监控指标](/tiflash/monitor-tiflash.md) - + 安全加固 - + [为 TiDB 客户端服务端间通信开启加密传输](/enable-tls-between-clients.md) - + [为 TiDB 组件间通信开启加密传输](/enable-tls-between-components.md) - + [为 TiDB 开启数据加密存储](/enable-encrypt-stored-data.md) - + [生成自签名证书](/generate-self-signed-certificates.md) - + 权限 - + [与 MySQL 安全特性差异](/security-compatibility-with-mysql.md) - + [权限管理](/privilege-management.md) - + [TiDB 用户账户管理](/user-account-management.md) - + [基于角色的访问控制](/role-based-access-control.md) - + [TiDB 证书鉴权使用指南](/certificate-authentication.md) ++ Reference + + [Architecture](/architecture.md) + + Key Monitoring Metrics + + [Overview](/grafana-overview-dashboard.md) + + [TiDB](/grafana-tidb-dashboard.md) + + [PD](/grafana-pd-dashboard.md) + + [TiKV](/grafana-tikv-dashboard.md) + + [TiFlash](/tiflash/monitor-tiflash.md) + + Secure + + [Enable TLS Between TiDB Clients and Servers](/enable-tls-between-clients-and-servers.md) + + [Enable TLS Between TiDB Components](/enable-tls-between-components.md) + + [Encrypt Stored Data](/enable-encrypt-stored-data.md) + + [Generate Self-signed Certificates](/generate-self-signed-certificates.md) + + [Encryption-At-Rest](/encryption-at-rest.md) + + Privileges + + [Security Compatibility with MySQL](/security-compatibility-with-mysql.md) + + [Privilege Management](/privilege-management.md) + + [User Account Management](/user-account-management.md) + + [Role-Based Access Control](/role-based-access-control.md) + + [Certificate-Based Authentication](/certificate-authentication.md) + SQL - + SQL 语言结构和语法 - + 属性 - + [AUTO_INCREMENT](/auto-increment.md) + + SQL Language Structure and Syntax + + Attributes + [AUTO_RANDOM](/auto-random.md) - + [字面值](/literal-values.md) - + [Schema 对象名](/schema-object-names.md) - + [关键字](/keywords.md) - + [用户自定义变量](/user-defined-variables.md) - + [表达式语法](/expression-syntax.md) - + [注释语法](/comment-syntax.md) - + SQL 语句 + + [Literal Values](/literal-values.md) + + [Schema Object Names](/schema-object-names.md) + + [Keywords and Reserved Words](/keywords-and-reserved-words.md) + + [User-Defined Variables](/user-defined-variables.md) + + [Expression Syntax](/expression-syntax.md) + + [Comment Syntax](/comment-syntax.md) + + SQL Statements - [`ADD COLUMN`](/sql-statements/sql-statement-add-column.md) - [`ADD INDEX`](/sql-statements/sql-statement-add-index.md) - [`ADMIN`](/sql-statements/sql-statement-admin.md) @@ -326,46 +286,46 @@ - [`TRUNCATE`](/sql-statements/sql-statement-truncate.md) - [`UPDATE`](/sql-statements/sql-statement-update.md) - [`USE`](/sql-statements/sql-statement-use.md) - + 数据类型 - + [数据类型概述](/data-type-overview.md) - + [数据类型默认值](/data-type-default-values.md) - + [数值类型](/data-type-numeric.md) - + [日期和时间类型](/data-type-date-and-time.md) - + [字符串类型](/data-type-string.md) - + [JSON 类型](/data-type-json.md) - + 函数与操作符 - + [函数与操作符概述](/functions-and-operators/functions-and-operators-overview.md) - + [表达式求值的类型转换](/functions-and-operators/type-conversion-in-expression-evaluation.md) - + [操作符](/functions-and-operators/operators.md) - + [控制流程函数](/functions-and-operators/control-flow-functions.md) - + [字符串函数](/functions-and-operators/string-functions.md) - + [数值函数与操作符](/functions-and-operators/numeric-functions-and-operators.md) - + [日期和时间函数](/functions-and-operators/date-and-time-functions.md) - + [位函数和操作符](/functions-and-operators/bit-functions-and-operators.md) - + [Cast 函数和操作符](/functions-and-operators/cast-functions-and-operators.md) - + [加密和压缩函数](/functions-and-operators/encryption-and-compression-functions.md) - + [信息函数](/functions-and-operators/information-functions.md) - + [JSON 函数](/functions-and-operators/json-functions.md) - + [GROUP BY 聚合函数](/functions-and-operators/aggregate-group-by-functions.md) - + [窗口函数](/functions-and-operators/window-functions.md) - + [其它函数](/functions-and-operators/miscellaneous-functions.md) - + [精度数学](/functions-and-operators/precision-math.md) - + [下推到 TiKV 的表达式列表](/functions-and-operators/expressions-pushed-down.md) - + [约束](/constraints.md) - + [生成列](/generated-columns.md) - + [SQL 模式](/sql-mode.md) - + 事务 - + [事务概览](/transaction-overview.md) - + [隔离级别](/transaction-isolation-levels.md) - + [乐观事务](/optimistic-transaction.md) - + [悲观事务](/pessimistic-transaction.md) - + 垃圾回收 (GC) - + [GC 机制简介](/garbage-collection-overview.md) - + [GC 配置](/garbage-collection-configuration.md) - + [视图](/views.md) - + [分区表](/partitioned-table.md) - + [字符集和排序规则](/character-set-and-collation.md) - + 系统表 + + Data Types + + [Overview](/data-type-overview.md) + + [Default Values](/data-type-default-values.md) + + [Numeric Types](/data-type-numeric.md) + + [Date and Time Types](/data-type-date-and-time.md) + + [String Types](/data-type-string.md) + + [JSON Type](/data-type-json.md) + + Functions and Operators + + [Overview](/functions-and-operators/functions-and-operators-overview.md) + + [Type Conversion in Expression Evaluation](/functions-and-operators/type-conversion-in-expression-evaluation.md) + + [Operators](/functions-and-operators/operators.md) + + [Control Flow Functions](/functions-and-operators/control-flow-functions.md) + + [String Functions](/functions-and-operators/string-functions.md) + + [Numeric Functions and Operators](/functions-and-operators/numeric-functions-and-operators.md) + + [Date and Time Functions](/functions-and-operators/date-and-time-functions.md) + + [Bit Functions and Operators](/functions-and-operators/bit-functions-and-operators.md) + + [Cast Functions and Operators](/functions-and-operators/cast-functions-and-operators.md) + + [Encryption and Compression Functions](/functions-and-operators/encryption-and-compression-functions.md) + + [Information Functions](/functions-and-operators/information-functions.md) + + [JSON Functions](/functions-and-operators/json-functions.md) + + [Aggregate (GROUP BY) Functions](/functions-and-operators/aggregate-group-by-functions.md) + + [Window Functions](/functions-and-operators/window-functions.md) + + [Miscellaneous Functions]](/functions-and-operators/miscellaneous-functions.md) + + [Precision Math](/functions-and-operators/precision-math.md) + + [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md) + + [Constraints](/constraints.md) + + [Generated Columns](/generated-columns.md) + + [SQL Mode](/sql-mode.md) + + Transactions + + [Overview](/transaction-overview.md) + + [Isolation Levels](/transaction-isolation-levels.md) + + [Optimistic Transactions](/optimistic-transaction.md) + + [Pessimistic Transactions](/pessimistic-transaction.md) + + Garbage Collection (GC) + + [Overview](/garbage-collection-overview.md) + + [Configuration](/garbage-collection-configuration.md) + + [Views](/views.md) + + [Partitioning](/partitioned-table.md) + + [Character Set and Collation](/character-set-and-collation.md) + + System Tables + [`mysql`](/system-tables/system-table-overview.md) + [`information_schema`](/system-tables/system-table-information-schema.md) + sql-diagnosis @@ -382,12 +342,12 @@ + [`inspection_summary`](/system-tables/system-table-inspection-summary.md) + UI + TiDB Dashboard - + [简介](/dashboard/dashboard-intro.md) - + 运维 - + [部署](/dashboard/dashboard-ops-deploy.md) - + [反向代理](/dashboard/dashboard-ops-reverse-proxy.md) - + [安全](/dashboard/dashboard-ops-security.md) - + [访问](/dashboard/dashboard-access.md) + + [Overview](/dashboard/dashboard-intro.md) + + Maintain + + [Deploy](/dashboard/dashboard-ops-deploy.md) + + [Reverse Proxy](/dashboard/dashboard-ops-reverse-proxy.md) + + [Secure](/dashboard/dashboard-ops-security.md) + + [Access](/dashboard/dashboard-access.md) + [概况页面](/dashboard/dashboard-overview.md) + [集群信息页面](/dashboard/dashboard-cluster-info.md) + [流量可视化页面](/dashboard/dashboard-key-visualizer.md) @@ -407,54 +367,41 @@ + [pd-ctl](/pd-control.md) + [tidb-ctl](/tidb-control.md) + [pd-recover](/pd-recover.md) - + [binlog-ctl](/tidb-binlog/binlog-control.md) - + 命令行参数 + + Command Line Flags + [tidb-server](/command-line-flags-for-tidb-configuration.md) + [tikv-server](/command-line-flags-for-tikv-configuration.md) - + [tiflash-server](/tiflash/tiflash-command-line-flags.md) + [pd-server](/command-line-flags-for-pd-configuration.md) - + 配置文件参数 + + Configuration File Parameters + [tidb-server](/tidb-configuration-file.md) + [tikv-server](/tikv-configuration-file.md) + [tiflash-server](/tiflash/tiflash-configuration.md) + [pd-server](/pd-configuration-file.md) - + 系统变量 - + [MySQL 系统变量](/system-variables.md) - + [TiDB 特定系统变量](/tidb-specific-system-variables.md) - + 存储引擎 - + TiKV - + [TiKV 简介](/tikv-overview.md) - + [RocksDB 简介](/rocksdb/rocksdb-overview.md) + + System Variables + + [MySQL System Variables](/system-variables.md) + + [TiDB Specific System Variables](/tidb-specific-system-variables.md) + + Storage Engines + TiFlash - + [TiFlash 简介](/tiflash/tiflash-overview.md) - + [使用 TiFlash](/tiflash/use-tiflash.md) + + [Overview](/tiflash/tiflash-overview.md) + + [Use TiFlash](/tiflash/use-tiflash.md) + TiUP - + [文档指南](/tiup/tiup-documentation-guide.md) - + [概览](/tiup/tiup-overview.md) - + [术语及核心概念](/tiup/tiup-terminology-and-concepts.md) - + [TiUP 组件管理](/tiup/tiup-component-management.md) + + [Overview](/tiup/tiup-overview.md) + + [Manage TiUP Components](/tiup/manage-tiup-component.md) + [FAQ](/tiup/tiup-faq.md) - + [故障排查](/tiup/tiup-troubleshooting-guide.md) - + TiUP 组件文档 - + [tiup-playground 运行本地测试集群](/tiup/tiup-playground.md) - + [tiup-cluster 部署运维生产集群](/tiup/tiup-cluster.md) - + [tiup-mirror 定制离线镜像](/tiup/tiup-mirror.md) - + [tiup-bench 进行 TPCC/TPCH 压力测试](/tiup/tiup-bench.md) - + [错误码](/error-codes.md) - + [TiCDC 简介](/ticdc/ticdc-overview.md) - + [TiCDC 开放数据协议](/ticdc/ticdc-open-protocol.md) - + [通过拓扑 label 进行副本调度](/schedule-replicas-by-topology-labels.md) -+ 常见问题解答 (FAQ) - + [产品 FAQ](/faq/tidb-faq.md) - + [SQL FAQ](/faq/sql-faq.md) - + [部署运维 FAQ](/faq/deploy-and-maintain-faq.md) - + [升级 FAQ](/faq/upgrade-faq.md) - + [高可用 FAQ](/faq/high-availability-faq.md) - + [高可靠 FAQ](/faq/high-reliability-faq.md) - + [迁移 FAQ](/faq/migration-tidb-faq.md) -+ [术语表](/glossary.md) -+ 版本发布历史 - + [发布版本汇总](/releases/release-notes.md) + + TiUP Components + + [tiup-playground](/tiup/tiup-playground.md) + + [tiup-cluster](/tiup/tiup-cluster.md) + + [tiup-mirror](/tiup/tiup-mirrors.md) + + [tiup-bench](/tiup/tiup-bench.md) + + [Errors Codes](/error-codes.md) + + [TiCDC Overview](/ticdc/ticdc-overview.md) + + [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md) ++ FAQs + - [TiDB FAQs](/faq/tidb-faq.md) + - [TiDB Lightning FAQs](/tidb-lightning/tidb-lightning-faq.md) + - [Upgrade FAQs](/faq/upgrade-faq.md) ++ [Glossary](/glossary.md) ++ Release Notes + + [All Releases](/releases/release-notes.md) + v4.0 - [4.0 GA](/releases/release-4.0-ga.md) - [4.0.0-rc.2](/releases/release-4.0.0-rc.2.md) From 9fea439566a233c1bc2b9ea655d4e8b66d70077b Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 9 Jun 2020 19:41:24 +0800 Subject: [PATCH 03/15] Update TOC.md --- TOC.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/TOC.md b/TOC.md index 3d5341be1ce4b..abbb5e4ea2bda 100644 --- a/TOC.md +++ b/TOC.md @@ -3,7 +3,7 @@ -## 目录 +## Documentation List + About TiDB + [TiDB Introduction](/overview.md) @@ -487,6 +487,14 @@ - [1.1 Beta](/releases/release-1.1-beta.md) - [1.1 Alpha](/releases/release-1.1-alpha.md) + v1.0 + - [1.0.8](/releases/release-1.0.8.md) + - [1.0.7](/releases/release-1.0.7.md) + - [1.0.6](/releases/release-1.0.6.md) + - [1.0.5](/releases/release-1.0.5.md) + - [1.0.4](/releases/release-1.0.4.md) + - [1.0.3](/releases/release-1.0.3.md) + - [1.0.2](/releases/release-1.0.2.md) + - [1.0.1](/releases/release-1.0.1.md) - [1.0](/releases/release-1.0-ga.md) - [Pre-GA](/releases/release-pre-ga.md) - [RC4](/releases/release-rc.4.md) From af4962cf13840bd5fe1a6f30536ee83670cc1dfe Mon Sep 17 00:00:00 2001 From: yikeke Date: Tue, 9 Jun 2020 19:49:15 +0800 Subject: [PATCH 04/15] delete links that are NA yet --- TOC.md | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/TOC.md b/TOC.md index abbb5e4ea2bda..9b800602b5890 100644 --- a/TOC.md +++ b/TOC.md @@ -50,7 +50,6 @@ + Maintain + Upgrade + [Use TiUP (Recommended)](/upgrade-tidb-using-tiup.md) - + [Use TiUP Offline (Recommended)](/upgrade-tidb-using-tiup-offline.md) + [Use TiDB Operator](https://pingcap.com/docs/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/) + [Use TiDB Ansible](/upgrade-tidb-using-ansible.md) + Scale @@ -186,17 +185,13 @@ - [`ADD INDEX`](/sql-statements/sql-statement-add-index.md) - [`ADMIN`](/sql-statements/sql-statement-admin.md) - [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md) - - [`ALTER INDEX`](/sql-statements/sql-statement-alter-index.md) - [`ALTER INSTANCE`](/sql-statements/sql-statement-alter-instance.md) - [`ALTER TABLE`](/sql-statements/sql-statement-alter-table.md) - [`ALTER USER`](/sql-statements/sql-statement-alter-user.md) - [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md) - [`BEGIN`](/sql-statements/sql-statement-begin.md) - [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) - - [`CHANGE DRAINER`](/sql-statements/sql-statement-change-drainer.md) - - [`CHANGE PUMP`](/sql-statements/sql-statement-change-pump.md) - [`COMMIT`](/sql-statements/sql-statement-commit.md) - - [`CREATE BINDING`](/sql-statements/sql-statement-create-binding.md) - [`CREATE DATABASE`](/sql-statements/sql-statement-create-database.md) - [`CREATE INDEX`](/sql-statements/sql-statement-create-index.md) - [`CREATE SEQUENCE`](/sql-statements/sql-statement-create-sequence.md) @@ -209,12 +204,10 @@ - [`DESC`](/sql-statements/sql-statement-desc.md) - [`DESCRIBE`](/sql-statements/sql-statement-describe.md) - [`DO`](/sql-statements/sql-statement-do.md) - - [`DROP BINDING`](/sql-statements/sql-statement-drop-binding.md) - [`DROP COLUMN`](/sql-statements/sql-statement-drop-column.md) - [`DROP DATABASE`](/sql-statements/sql-statement-drop-database.md) - [`DROP INDEX`](/sql-statements/sql-statement-drop-index.md) - [`DROP SEQUENCE`](/sql-statements/sql-statement-drop-sequence.md) - - [`DROP STATS`](/sql-statements/sql-statement-drop-stats.md) - [`DROP TABLE`](/sql-statements/sql-statement-drop-table.md) - [`DROP USER`](/sql-statements/sql-statement-drop-user.md) - [`DROP VIEW`](/sql-statements/sql-statement-drop-view.md) @@ -229,7 +222,6 @@ - [`INSERT`](/sql-statements/sql-statement-insert.md) - [`KILL [TIDB]`](/sql-statements/sql-statement-kill.md) - [`LOAD DATA`](/sql-statements/sql-statement-load-data.md) - - [`LOAD STATS`](/sql-statements/sql-statement-load-stats.md) - [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) - [`PREPARE`](/sql-statements/sql-statement-prepare.md) - [`RECOVER TABLE`](/sql-statements/sql-statement-recover-table.md) @@ -241,21 +233,15 @@ - [`SELECT`](/sql-statements/sql-statement-select.md) - [`SET [NAMES|CHARACTER SET]`](/sql-statements/sql-statement-set-names.md) - [`SET PASSWORD`](/sql-statements/sql-statement-set-password.md) - - [`SET ROLE`](/sql-statements/sql-statement-set-role.md) - [`SET TRANSACTION`](/sql-statements/sql-statement-set-transaction.md) - [`SET [GLOBAL|SESSION] `](/sql-statements/sql-statement-set-variable.md) - - [`SHOW ANALYZE STATUS`](/sql-statements/sql-statement-show-analyze-status.md) - - [`SHOW BINDINGS`](/sql-statements/sql-statement-show-bindings.md) - - [`SHOW BUILTINS`](/sql-statements/sql-statement-show-builtins.md) - [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md) - [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md) - [`SHOW [FULL] COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md) - - [`SHOW CONFIG`](/sql-statements/sql-statement-show-config.md) - [`SHOW CREATE SEQUENCE`](/sql-statements/sql-statement-show-create-sequence.md) - [`SHOW CREATE TABLE`](/sql-statements/sql-statement-show-create-table.md) - [`SHOW CREATE USER`](/sql-statements/sql-statement-show-create-user.md) - [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md) - - [`SHOW DRAINER STATUS`](/sql-statements/sql-statement-show-drainer-status.md) - [`SHOW ENGINES`](/sql-statements/sql-statement-show-engines.md) - [`SHOW ERRORS`](/sql-statements/sql-statement-show-errors.md) - [`SHOW [FULL] FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md) @@ -263,23 +249,15 @@ - [`SHOW INDEX [FROM|IN]`](/sql-statements/sql-statement-show-index.md) - [`SHOW INDEXES [FROM|IN]`](/sql-statements/sql-statement-show-indexes.md) - [`SHOW KEYS [FROM|IN]`](/sql-statements/sql-statement-show-keys.md) - - [`SHOW MASTER STATUS`](/sql-statements/sql-statement-show-master-status.md) - - [`SHOW PLUGINS`](/sql-statements/sql-statement-show-plugins.md) - [`SHOW PRIVILEGES`](/sql-statements/sql-statement-show-privileges.md) - [`SHOW [FULL] PROCESSSLIST`](/sql-statements/sql-statement-show-processlist.md) - - [`SHOW PROFILES`](/sql-statements/sql-statement-show-profiles.md) - - [`SHOW PUMP STATUS`](/sql-statements/sql-statement-show-pump-status.md) - [`SHOW SCHEMAS`](/sql-statements/sql-statement-show-schemas.md) - - [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-histograms.md) - - [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md) - [`SHOW STATUS`](/sql-statements/sql-statement-show-status.md) - - [`SHOW TABLE NEXT_ROW_ID`](/sql-statements/sql-statement-show-table-next-rowid.md) - [`SHOW TABLE REGIONS`](/sql-statements/sql-statement-show-table-regions.md) - [`SHOW TABLE STATUS`](/sql-statements/sql-statement-show-table-status.md) - [`SHOW [FULL] TABLES`](/sql-statements/sql-statement-show-tables.md) - [`SHOW [GLOBAL|SESSION] VARIABLES`](/sql-statements/sql-statement-show-variables.md) - [`SHOW WARNINGS`](/sql-statements/sql-statement-show-warnings.md) - - [`SHUTDOWN`](/sql-statements/sql-statement-shutdown.md) - [`SPLIT REGION`](/sql-statements/sql-statement-split-region.md) - [`START TRANSACTION`](/sql-statements/sql-statement-start-transaction.md) - [`TRACE`](/sql-statements/sql-statement-trace.md) @@ -386,7 +364,6 @@ + TiUP + [Overview](/tiup/tiup-overview.md) + [Manage TiUP Components](/tiup/manage-tiup-component.md) - + [FAQ](/tiup/tiup-faq.md) + TiUP Components + [tiup-playground](/tiup/tiup-playground.md) + [tiup-cluster](/tiup/tiup-cluster.md) From 0d2b18f2f6a7cf6a113b45b57551290ad1bba04d Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Wed, 10 Jun 2020 12:18:21 +0800 Subject: [PATCH 05/15] add TiDB Dashboard toc --- TOC.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/TOC.md b/TOC.md index b136f700535a5..8f87bef22705c 100644 --- a/TOC.md +++ b/TOC.md @@ -327,20 +327,20 @@ + [Reverse Proxy](/dashboard/dashboard-ops-reverse-proxy.md) + [Secure](/dashboard/dashboard-ops-security.md) + [Access](/dashboard/dashboard-access.md) - + [概况页面](/dashboard/dashboard-overview.md) - + [集群信息页面](/dashboard/dashboard-cluster-info.md) - + [流量可视化页面](/dashboard/dashboard-key-visualizer.md) - + SQL 语句分析 - + [列表页面](/dashboard/dashboard-statement-list.md) - + [执行详情页面](/dashboard/dashboard-statement-details.md) - + [慢查询页面](/dashboard/dashboard-slow-query.md) - + 集群诊断页面 - + [访问](/dashboard/dashboard-diagnostics-access.md) - + [查看报告](/dashboard/dashboard-diagnostics-report.md) - + [使用示例](/dashboard/dashboard-diagnostics-usage.md) - + [日志搜索页面](/dashboard/dashboard-log-search.md) - + [实例性能分析页面](/dashboard/dashboard-profiling.md) - + [常见问题](/dashboard/dashboard-faq.md) + + [Overview Page](/dashboard/dashboard-overview.md) + + [Cluster Info Page](/dashboard/dashboard-cluster-info.md) + + [Key Visualizer Page](/dashboard/dashboard-key-visualizer.md) + + SQL Statements Analysis + + [SQL Statements Page](/dashboard/dashboard-statement-list.md) + + [SQL Details Page](/dashboard/dashboard-statement-details.md) + + [Slow Queries Page](/dashboard/dashboard-slow-query.md) + + Cluster Diagnostics + + [Access Cluster Diagnostics Page](/dashboard/dashboard-diagnostics-access.md) + + [View Diagnostics Report](/dashboard/dashboard-diagnostics-report.md) + + [Use Diagnostics](/dashboard/dashboard-diagnostics-usage.md) + + [Search Logs Page](/dashboard/dashboard-log-search.md) + + [Profile Instances Page](/dashboard/dashboard-profiling.md) + + [FAQ](/dashboard/dashboard-faq.md) + CLI + [tikv-ctl](/tikv-control.md) + [pd-ctl](/pd-control.md) From a948c9a8a850d3e6dec2634eac6da7ee8c57fbb6 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 10 Jun 2020 13:58:58 +0800 Subject: [PATCH 06/15] add two links (from Binary Tarball) --- TOC.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/TOC.md b/TOC.md index 8f87bef22705c..9b9f3ba8554fe 100644 --- a/TOC.md +++ b/TOC.md @@ -30,6 +30,9 @@ + [Use TiUP Offline (Recommended)](/production-offline-deployment-using-tiup.md) + [Use TiDB Ansible](/online-deployment-using-ansible.md) + [Use TiDB Ansible Offline](/offline-deployment-using-ansible.md) + + From Binary Tarball (Deprecated) + + [Production Deployment](/production-deployment-from-binary-tarball.md) + + [Testing Deployment](/test-deployment-from-binary-tarball.md) + [Verify Cluster Status](/post-installation-check.md) + Benchmarks + [Test TiDB Using Sysbench](/benchmark/benchmark-tidb-using-sysbench.md) From c77bfb3064cc778ee01642eee44c5e09984235a0 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 10 Jun 2020 15:16:25 +0800 Subject: [PATCH 07/15] add two tispark links --- TOC.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/TOC.md b/TOC.md index 9b9f3ba8554fe..fe2b4196b57fe 100644 --- a/TOC.md +++ b/TOC.md @@ -154,6 +154,9 @@ + [Loader](/loader-overview.md) + [Mydumper](/mydumper-overview.md) + [Syncer](/syncer-overview.md) + + TiSpark + + [Quick Start](/get-started-with-tispark.md) + + [User Guide](/tispark-overview.md) + Reference + [Architecture](/architecture.md) + Key Monitoring Metrics From b822ca067edba4bd158bfddd331bdb30d6f31fd4 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 10 Jun 2020 15:29:41 +0800 Subject: [PATCH 08/15] add 3 missing links --- TOC.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/TOC.md b/TOC.md index fe2b4196b57fe..9f4635aa1b0b8 100644 --- a/TOC.md +++ b/TOC.md @@ -79,10 +79,13 @@ + [Identify Slow Queries](/identify-slow-queries.md) + [Identify Expensive Queries](/identify-expensive-queries.md) + [Statement Summary Tables](/statement-summary-tables.md) + + [Troubleshoot Cluster Setup](/troubleshoot-tidb-cluster.md) + + [TiDB Troubleshooting Map](/tidb-troubleshooting-map.md) + [Troubleshoot TiFlash](/tiflash/troubleshoot-tiflash.md) + Performance Tuning + Software Tuning + Configuration + + [TiKV Follower Read](/follower-read.md) + [TiFlash Tuning](/tiflash/tune-tiflash-performance.md) + [Coprocessor Cache](/coprocessor-cache.md) + SQL Tuning From 59f99fbf23dc97bfb59a400b421d04a13afa7758 Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Wed, 10 Jun 2020 18:18:20 +0800 Subject: [PATCH 09/15] remove binary --- TOC.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/TOC.md b/TOC.md index 9f4635aa1b0b8..c49a990b6f986 100644 --- a/TOC.md +++ b/TOC.md @@ -30,9 +30,6 @@ + [Use TiUP Offline (Recommended)](/production-offline-deployment-using-tiup.md) + [Use TiDB Ansible](/online-deployment-using-ansible.md) + [Use TiDB Ansible Offline](/offline-deployment-using-ansible.md) - + From Binary Tarball (Deprecated) - + [Production Deployment](/production-deployment-from-binary-tarball.md) - + [Testing Deployment](/test-deployment-from-binary-tarball.md) + [Verify Cluster Status](/post-installation-check.md) + Benchmarks + [Test TiDB Using Sysbench](/benchmark/benchmark-tidb-using-sysbench.md) From bda87a9da20719d12974005a66d95d8ee016a04f Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Wed, 10 Jun 2020 18:20:10 +0800 Subject: [PATCH 10/15] Update TOC.md Co-authored-by: Lilian Lee --- TOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TOC.md b/TOC.md index c49a990b6f986..dba90c8985ec4 100644 --- a/TOC.md +++ b/TOC.md @@ -293,7 +293,7 @@ + [JSON Functions](/functions-and-operators/json-functions.md) + [Aggregate (GROUP BY) Functions](/functions-and-operators/aggregate-group-by-functions.md) + [Window Functions](/functions-and-operators/window-functions.md) - + [Miscellaneous Functions]](/functions-and-operators/miscellaneous-functions.md) + + [Miscellaneous Functions](/functions-and-operators/miscellaneous-functions.md) + [Precision Math](/functions-and-operators/precision-math.md) + [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md) + [Constraints](/constraints.md) From 5f13340a6f149ccfac1cc80ce69b81ac60d101a4 Mon Sep 17 00:00:00 2001 From: yikeke Date: Wed, 10 Jun 2020 18:32:15 +0800 Subject: [PATCH 11/15] rename; add toc --- TOC.md | 1 + tune-tikv-performance.md => tune-tikv-memory-performance.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) rename tune-tikv-performance.md => tune-tikv-memory-performance.md (98%) diff --git a/TOC.md b/TOC.md index dba90c8985ec4..5252ed8c91c68 100644 --- a/TOC.md +++ b/TOC.md @@ -82,6 +82,7 @@ + Performance Tuning + Software Tuning + Configuration + + [TiKV Memory Tuning](/tune-tikv-memory-performance.md) + [TiKV Follower Read](/follower-read.md) + [TiFlash Tuning](/tiflash/tune-tiflash-performance.md) + [Coprocessor Cache](/coprocessor-cache.md) diff --git a/tune-tikv-performance.md b/tune-tikv-memory-performance.md similarity index 98% rename from tune-tikv-performance.md rename to tune-tikv-memory-performance.md index 6da9fb2b48b37..4b0fca7488a93 100644 --- a/tune-tikv-performance.md +++ b/tune-tikv-memory-performance.md @@ -1,11 +1,11 @@ --- -title: Tune TiKV Performance +title: TiKV Memory Parameters Performance Tuning summary: Learn how to tune the TiKV parameters for optimal performance. category: reference -aliases: ['/docs/dev/reference/performance/tune-tikv/'] +aliases: ['/docs/dev/reference/performance/tune-tikv/','/docs/dev/tune-tikv-performance/'] --- -# Tune TiKV Performance +# TiKV Memory Parameters Performance Tuning This document describes how to tune the TiKV parameters for optimal performance. From 322f622068469c94499027a923f70f0223ba063f Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 11 Jun 2020 11:22:13 +0800 Subject: [PATCH 12/15] rename back --- TOC.md | 2 +- tune-tikv-memory-performance.md => tune-tikv-performance.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename tune-tikv-memory-performance.md => tune-tikv-performance.md (100%) diff --git a/TOC.md b/TOC.md index 5252ed8c91c68..6878384d29c0d 100644 --- a/TOC.md +++ b/TOC.md @@ -82,7 +82,7 @@ + Performance Tuning + Software Tuning + Configuration - + [TiKV Memory Tuning](/tune-tikv-memory-performance.md) + + [TiKV Tuning](/tune-tikv-performance.md) + [TiKV Follower Read](/follower-read.md) + [TiFlash Tuning](/tiflash/tune-tiflash-performance.md) + [Coprocessor Cache](/coprocessor-cache.md) diff --git a/tune-tikv-memory-performance.md b/tune-tikv-performance.md similarity index 100% rename from tune-tikv-memory-performance.md rename to tune-tikv-performance.md From 0472072a0b9c5f96daec13390f7d9fbe0a854761 Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 11 Jun 2020 11:23:49 +0800 Subject: [PATCH 13/15] delete an alias --- tune-tikv-performance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tune-tikv-performance.md b/tune-tikv-performance.md index 4b0fca7488a93..c8a67743efc40 100644 --- a/tune-tikv-performance.md +++ b/tune-tikv-performance.md @@ -2,7 +2,7 @@ title: TiKV Memory Parameters Performance Tuning summary: Learn how to tune the TiKV parameters for optimal performance. category: reference -aliases: ['/docs/dev/reference/performance/tune-tikv/','/docs/dev/tune-tikv-performance/'] +aliases: ['/docs/dev/reference/performance/tune-tikv/'] --- # TiKV Memory Parameters Performance Tuning From fb5e8e7586e6372a67553e6087ee4f9d99f2a6b9 Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 11 Jun 2020 12:32:00 +0800 Subject: [PATCH 14/15] add missing links in TOC --- TOC.md | 15 ++- production-deployment-using-tiup.md | 2 +- ticdc/deploy-ticdc.md | 156 ---------------------------- tiflash/deploy-tiflash.md | 145 -------------------------- tiup/package-tiup-component.md | 127 ---------------------- tiup/tiup-overview.md | 2 - 6 files changed, 13 insertions(+), 434 deletions(-) delete mode 100644 ticdc/deploy-ticdc.md delete mode 100644 tiflash/deploy-tiflash.md delete mode 100644 tiup/package-tiup-component.md diff --git a/TOC.md b/TOC.md index 6878384d29c0d..12b10328cffeb 100644 --- a/TOC.md +++ b/TOC.md @@ -62,6 +62,7 @@ + Use BR Tool + [Use BR Tool](/br/backup-and-restore-tool.md) + [BR Use Cases](/br/backup-and-restore-use-cases.md) + + [BR storages](/br/backup-and-restore-storages.md) + [Daily Checklist](/daily-check.md) + [Maintain TiCDC](/ticdc/manage-ticdc.md) + [Maintain TiFlash](/tiflash/maintain-tiflash.md) @@ -97,7 +98,9 @@ + Control Execution Plan + [Optimizer Hints](/optimizer-hints.md) + [SQL Plan Management](/sql-plan-management.md) + + [Access Tables Using `IndexMerge`](/index-merge.md) + Tutorials + + [Geo-Redundant Deployment](/geo-redundancy-deployment.md) + Best Practices + [Java Application Development](/best-practices/java-app-best-practices.md) + [Use HAProxy](/best-practices/haproxy-best-practices.md) @@ -146,7 +149,11 @@ + [Troubleshoot](/troubleshoot-tidb-lightning.md) + [FAQ](/tidb-lightning/tidb-lightning-faq.md) + [Glossary](/tidb-lightning/tidb-lightning-glossary.md) - + [TiCDC](/ticdc/ticdc-overview.md) + + TiCDC + - [Overview](/ticdc/ticdc-overview.md) + - [Configure Sink URI](/ticdc/sink-url.md) + - [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md) + - [Column and DDL Type Codes](/ticdc/column-ddl-type-codes.md) + sync-diff-inspector + [Overview](/sync-diff-inspector/sync-diff-inspector-overview.md) + [Data Check for Tables with Different Schema/Table Names](/sync-diff-inspector/route-diff.md) @@ -197,6 +204,7 @@ - [`ALTER TABLE`](/sql-statements/sql-statement-alter-table.md) - [`ALTER USER`](/sql-statements/sql-statement-alter-user.md) - [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md) + - [`BACKUP`](/sql-statements/sql-statement-backup.md) - [`BEGIN`](/sql-statements/sql-statement-begin.md) - [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) - [`COMMIT`](/sql-statements/sql-statement-commit.md) @@ -236,6 +244,7 @@ - [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md) - [`RENAME TABLE`](/sql-statements/sql-statement-rename-table.md) - [`REPLACE`](/sql-statements/sql-statement-replace.md) + - [`RESTORE`](/sql-statements/sql-statement-restore.md) - [`REVOKE `](/sql-statements/sql-statement-revoke-privileges.md) - [`ROLLBACK`](/sql-statements/sql-statement-rollback.md) - [`SELECT`](/sql-statements/sql-statement-select.md) @@ -243,6 +252,7 @@ - [`SET PASSWORD`](/sql-statements/sql-statement-set-password.md) - [`SET TRANSACTION`](/sql-statements/sql-statement-set-transaction.md) - [`SET [GLOBAL|SESSION] `](/sql-statements/sql-statement-set-variable.md) + - [`SHOW [BACKUPS|RESTORES]`](/sql-statements/sql-statement-show-backups.md) - [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md) - [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md) - [`SHOW [FULL] COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md) @@ -369,6 +379,7 @@ + TiFlash + [Overview](/tiflash/tiflash-overview.md) + [Use TiFlash](/tiflash/use-tiflash.md) + + [FAQ](/tiflash/tiflash-faq.md) + TiUP + [Overview](/tiup/tiup-overview.md) + [Manage TiUP Components](/tiup/manage-tiup-component.md) @@ -378,8 +389,6 @@ + [tiup-mirror](/tiup/tiup-mirrors.md) + [tiup-bench](/tiup/tiup-bench.md) + [Errors Codes](/error-codes.md) - + [TiCDC Overview](/ticdc/ticdc-overview.md) - + [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md) + FAQs - [TiDB FAQs](/faq/tidb-faq.md) - [TiDB Lightning FAQs](/tidb-lightning/tidb-lightning-faq.md) diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index 61810b2559a6c..a22da4f75cfc5 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -2,7 +2,7 @@ title: Deploy a TiDB Cluster Using TiUP summary: Learn how to easily deploy a TiDB cluster using TiUP. category: how-to -aliases: ['/docs/dev/how-to/deploy/orchestrated/tiup/'] +aliases: ['/docs/dev/how-to/deploy/orchestrated/tiup/','/docs/dev/tiflash/deploy-tiflash/'] --- # Deploy a TiDB Cluster Using TiUP diff --git a/ticdc/deploy-ticdc.md b/ticdc/deploy-ticdc.md deleted file mode 100644 index 41775158d7709..0000000000000 --- a/ticdc/deploy-ticdc.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: Deploy and use TiCDC -summary: Learn how to deploy and use TiCDC to replicate incremental data. -category: reference -aliases: ['/docs/dev/reference/tools/ticdc/deploy/'] ---- - -# Deploy and use TiCDC - -This document introduces how to deploy and use TiCDC to replicate incremental data. - -## Step 1: Deploy TiCDC cluster - -This section describes how to deploy TiCDC in the following different scenarios: - -- [Fresh deploy TiCDC using TiUP](#fresh-deploy-ticdc-using-tiup) -- [Add TiCDC component to an existing TiDB cluster using TiUP](#add-ticdc-component-to-an-existing-tidb-cluster-using-tiup) -- [Manually add TiCDC component to an existing TiDB cluster](#manually-add-ticdc-component-to-an-existing-tidb-cluster) - -### Fresh deploy TiCDC using TiUP - -TiUP cluster is a deployment tool for TiDB 4.0 and later versions. You must deploy and run TiCDC on TiDB v4.0.0-rc.1 or a later version. - -To deploy TiCDC, take the following steps: - -1. [Install TiUP](/production-deployment-using-tiup.md). - -2. Install the TiUP cluster component: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster - ``` - -3. Edit the topology configuration file, and save it as `topology.yaml`: - - Refer to the [full configuration file template](https://github.com/pingcap-incubator/tiup-cluster/blob/master/examples/topology.example.yaml). - - In addition to configuring the TiDB cluster deployment, you also need to configure the CDC server IP under the `cdc_servers` section. Currently the configuration only supports IP, not domain name. - - {{< copyable "" >}} - - ```ini - pd_servers: - - host: 172.19.0.101 - - host: 172.19.0.102 - - host: 172.19.0.103 - - tidb_servers: - - host: 172.19.0.101 - - tikv_servers: - - host: 172.19.0.101 - - host: 172.19.0.102 - - host: 172.19.0.103 - - cdc_servers: - - host: 172.19.0.101 - - host: 172.19.0.102 - - host: 172.19.0.103 - ``` - -4. Finish the following steps according to the TiUP deployment process: - - Deploy the TiDB cluster. `test` is the cluster name: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster deploy test v4.0.0-rc.1 topology.yaml -i ~/.ssh/id_rsa - ``` - - Start the TiDB cluster: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster start test - ``` - -5. View the cluster status: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster display test - ``` - -### Add TiCDC component to an existing TiDB cluster using TiUP - -1. Check if your TiDB version supports TiCDC. If not, upgrade the TiDB cluster to 4.0.0 rc.1 or later versions. - -2. Refer to [Scale out a TiDB/TiKV/PD/TiCDC node](/scale-tidb-using-tiup.md#scale-out-a-tidbpdtikv-node) and deploy TiCDC. - - This is an example of the scale-out configuration file: - - ```shell - vi scale-out.yaml - ``` - - ``` - cdc_servers: - - host: 10.0.1.5 - - host: 10.0.1.6 - - host: 10.0.1.7 - ``` - - Run the scale-out command: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster scale-out scale-out.yaml - ``` - -### Manually add TiCDC component to an existing TiDB cluster - -Suppose that there is a PD node (the client URL is `10.0.10.25:2379`) in the PD cluster that can provide services. If you want to deploy three TiCDC nodes, start the TiCDC cluster using the following commands. You only need to specify the same PD address, and the newly started TiCDC nodes will automatically be added to the TiCDC cluster. - -{{< copyable "shell-regular" >}} - -```shell -cdc server --pd=http://10.0.10.25:2379 --log-file=ticdc_1.log --addr 0.0.0.0:8301 --advertise-addr=127.0.0.1:8301 -cdc server --pd=http://10.0.10.25:2379 --log-file=ticdc_2.log --addr 0.0.0.0:8302 --advertise-addr=127.0.0.1:8302 -cdc server --pd=http://10.0.10.25:2379 --log-file=ticdc_3.log --addr 0.0.0.0:8303 --advertise-addr=127.0.0.1:8303 -``` - -## Step 2: Create replication task - -To replicate all upstream database schemas and tables (except system tables) to the downstream MySQL, use the following command to create a replication task: - -{{< copyable "shell-regular" >}} - -```shell -cdc cli changefeed create --pd=http://10.0.10.25:2379 --start-ts=415238226621235200 --sink-uri="mysql://root:123456@127.0.0.1:3306/" -``` - -The parameters in the above command are described as follows: - -- `pd`: The URL of the PD client. -- `start-ts`: Specifies the starting TSO of the replication task. If this parameter is not specified or specified as `0`, the current TSO is used as the starting TSO of the replication task. -- `sink-uri`: The sink address. Currently, the address can be configured to `mysql`, `tidb`, or `kafka`. For how to configure sink URI, refer to [Configure Sink URI](/ticdc/sink-url.md). -- `config`: The configuration of the replication task. Currently, this configuration supports the black & white lists and skipping specific transaction of certain `commit-ts`. - -After executing the above command, TiCDC starts to replicate data to the downstream MySQL (`127.0.0.1:3306`) from the specified `start-ts` (`415238226621235200`). - -If you want to replicate data to a Kafka cluster, first create the topic in the Kafka cluster (for example, `cdc-test` in the following example is a topic), create partitions, and use the following command to create a replication task: - -{{< copyable "shell-regular" >}} - -```shell -cdc cli changefeed create --pd=http://10.0.10.25:2379 --start-ts=415238226621235200 --sink-uri="kafka://10.0.10.30:9092/cdc-test" -``` - -After executing the above command, TiCDC starts to replicate data to the downstream Kafka (`10.0.10.30:9092`) from the specified `start-ts`. diff --git a/tiflash/deploy-tiflash.md b/tiflash/deploy-tiflash.md deleted file mode 100644 index 441266ce24691..0000000000000 --- a/tiflash/deploy-tiflash.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Deploy a TiFlash Cluster -summary: Learn the requirements and methods of deploying a TiFlash cluster. -category: reference -aliases: ['/docs/dev/reference/tiflash/deploy/'] ---- - -# Deploy a TiFlash Cluster - -> **Note:** -> -> If you want to get a first-hand experience on how to use the TiFlash RC version, contact [PingCAP](mailto:info@pingcap.com) for more information and assistance. - -This document introduces the environment requirements for deploying a TiFlash cluster and the deployment methods in different scenarios. - -## Recommended hardware configuration - -This section provides hardware configuration recommendations based on different TiFlash deployment methods. - -### TiFlash standalone deployment - -* Minimum configuration: 32 VCore, 64 GB RAM, 1 SSD + n HDD -* Recommended configuration: 48 VCore, 128 GB RAM, 1 NVMe SSD + n SSD - -There is no limit to the number of target machines (one at least). A single machine can use multiple disks, but deploying multiple instances on a single machine is not recommended. - -It is recommended to use an SSD disk to buffer the real-time data being replicated and written to TiFlash. The performance of this disk need to be not lower than the hard disk used by TiKV. It is recommended that you use a better performance NVMe SSD and the SSD's capacity is not less than 10% of the total capacity. Otherwise, it might become the bottleneck of the amount of data that this node can handle. - -For other hard disks, you can use multiple HDDs or regular SSDs. A better hard disk will surely bring better performance. - -TiFlash supports [multi-disk deployment](/tiflash/tiflash-configuration.md#multi-disk-deployment), so there is no need to use RAID. - -### TiFlash and TiKV are deployed on the same node - -See [Hardware recommendations for TiKV server](/hardware-and-software-requirements.md#server-recommendations), and increase the memory capacity and the number of and CPU cores as needed. - -It is **not** recommended to deploy TiFlash and TiKV on the same disk to prevent mutual interference. - -Hard disk selection criteria are the same as [TiFlash standalone deployment](#tiflash-standalone-deployment). The total capacity of the hard disk is roughly: `the to-be-replicated data capacity of the entire TiKV cluster / the number of TiKV replicas * the number of TiFlash replicas`. - -For example, if the overall planned capacity of TiKV is 1TB, each Region in TiKV has 3 replicas, and each Region in TiFlash has 2 replicas, then the recommended capacity of TiFlash will be `1024GB / 3 * 2`. You can choose to replicate part of the tables instead of all. - -## TiDB version requirements - -Currently, the testing of TiFlash is based on the related components of TiDB 4.0 (including TiDB, PD, TiKV, and TiFlash). For the download method of TiDB 4.0, refer to the following installation and deployment steps. - -## Install and deploy TiFlash - -This section describes how to install and deploy TiFlash in the following scenarios: - -- [Fresh TiFlash deployment](#fresh-tiflash-deployment) -- [Add TiFlash component to an existing TiDB cluster](#add-tiflash-component-to-an-existing-tidb-cluster) - -> **Note:** -> -> 1. Before starting the TiFlash process, you must ensure that PD's Placement Rules feature is enabled (For how to enable it, see the **second step** in the [Add TiFlash component to an existing TiDB cluster](#add-tiflash-component-to-an-existing-tidb-cluster) section). -> 2. When TiFlash is running, you must ensure that PD's Placement Rules feature remains enabled. - -### Fresh TiFlash deployment - -TiUP cluster is the deployment tool for TiDB 4.0 or later versions. It is recommended that you use TiUP cluster to install and deploy TiFlash. The steps are as follows: - -1. [Install TiUP](/production-deployment-using-tiup.md#step-2-install-tiup-on-the-control-machine). - -2. Install the TiUP cluster component. - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster - ``` - -3. Write the topology configuration file and save it as `topology.yaml`. - - You can refer to [the topology configuration file template](https://github.com/pingcap-incubator/tiup-cluster/blob/master/examples/topology.example.yaml). - - In addition to configuring the TiDB cluster, you also need to configure the IP of TiFlash servers in `tiflash_servers`. Currently the configuration only supports IP but not domain name. - - If you need to deploy TiFlash, set `replication.enable-placement-rules` in the `pd` section to `true`. - - {{< copyable "" >}} - - ```ini - server_configs: - pd: - replication.enable-placement-rules: true - pd_servers: - - host: 172.19.0.101 - - host: 172.19.0.102 - - host: 172.19.0.103 - tidb_servers: - - host: 172.19.0.101 - tikv_servers: - - host: 172.19.0.101 - - host: 172.19.0.102 - - host: 172.19.0.103 - tiflash_servers: - - host: 172.19.0.103 - ``` - - If you want to customize the deployment directory, configure the `data_dir` parameter. If you want to [deploy TiFlash on multiple disks](/tiflash/tiflash-configuration.md#multi-disk-deployment), separate each directory with commas. For example: - - {{< copyable "" >}} - - ```ini - tiflash_servers: - - host: 172.19.0.103 - data_dir: /data1/tiflash/data,/data2/tiflash/data - ``` - -4. Refer to the TiUP deployment process, and complete the following steps: - - * Deploy the TiDB cluster (`test` is the cluster name): - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster deploy test v4.0.0-rc topology.yaml -i ~/.ssh/id_rsa - ``` - - * Start the TiDB cluster: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster start test - ``` - -5. View the cluster status: - - {{< copyable "shell-regular" >}} - - ```shell - tiup cluster display test - ``` - -### Add TiFlash component to an existing TiDB cluster - -1. First, confirm that your current TiDB version supports TiFlash; otherwise, you need to upgrade your TiDB cluster to 4.0 rc or higher versions. - -2. Execute the `config set enable-placement-rules true` command in [pd-ctl](/pd-control.md) (`resources/bin` in the tidb-ansible directory includes the pd-ctl binary file) to enable PD's Placement Rules feature. - - Currently, pd-ctl is not connected to TiUP cluster, you need to [manually download pd-ctl](https://download.pingcap.org/tidb-v4.0.0-rc-linux-amd64.tar.gz). - -3. Refer to [Scale out a TiFlash node](/scale-tidb-using-tiup.md#scale-out-a-tiflash-node) and deploy TiFlash. diff --git a/tiup/package-tiup-component.md b/tiup/package-tiup-component.md deleted file mode 100644 index 2997c7f560378..0000000000000 --- a/tiup/package-tiup-component.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: Package a Component -summary: Learn how to package a component. -category: tools -aliases: ['/docs/dev/reference/tools/tiup/package-component/'] ---- - -# Package a Component - -If you want to add a new component or add a version of an existing component, use the `tar` command to package the component files and then upload these packaged files to the mirror repository. Packaging with `tar` is not difficult. However, it is not easy to update the meta information of the repository without destroying the information of existing components. - -To make it easy, TiUP provides the `package` component, which is used to package the newly added TiUP component and generate the directory of this component. - -## TiUP `package` overview - -Execute the following command to get the help information of the `mirrors` component: - -{{< copyable "shell-root" >}} - -```bash -tiup package --help -``` - -``` -Package a tiup component and generate package directory - -Usage: - tiup package target [flags] - -Flags: - -C, -- string Change directory before compress - --arch string Target ARCH of the package (default "GOARCH") - --desc string Description of the package - --entry string Entry point of the package - -h, --help help for tiup - --hide tiup list Don't show the component in tiup list - --name string Name of the package - --os string Target OS of the package (default "GOOS") - --release string Version of the package - --standalone Can the component run standalone -``` - -## Usage example: Add the `Hello World` component - -This section introduces the development and packaging process of the `Hello World` component. The only function of this component is to output the content of its configuration file. The content is "Hello World". - -To make it simple, the bash script is used to develop this component. See the following steps for details: - -1. Create the configuration file of the `Hello World` component. The content of this file is "Hello World". - - {{< copyable "shell-regular" >}} - - ```shell - cat > config.txt << EOF - Hello World - EOF - ``` - -2. Create an executable file: - - {{< copyable "shell-regular" >}} - - ```shell - cat > hello.sh << EOF - #! /bin/sh - cat \${TIUP_COMPONENT_INSTALL_DIR}/config.txt - EOF - - chmod 755 hello.sh - ``` - - The `TIUP_COMPONENT_INSTALL_DIR` environment variable is passed in when TiUP is running. This variable points to the installation directory of the component. - -3. Refer to [Create a Private Mirror](/tiup/tiup-mirrors.md) and create an offline or a private mirror accordingly. Make sure the `TIUP_MIRRORS` variable points to the mirror after this mirror is created. - - > **Note:** - > - > You cannot publish your package, because the `publish` feature of the official mirror is currently unavailable. - -4. Packaging: - - {{< copyable "shell-regular" >}} - - ```shell - tiup package hello.sh config.txt --name=hello --entry=hello.sh --release=v0.0.1 - ``` - - A `package` directory is created in this step. The packaged files and the meta information are stored in this directory. - -5. Upload the packaged files to the repository: - - You can upload the packaged files only to the mirror created by yourself in step 3, because currently you cannot publish the files to the official repository. Execute the following command to copy all files in the `package` directory into ``. For details of ``, refer to the [`mirrors` description](/tiup/tiup-mirrors.md#mirrors-description). - - {{< copyable "shell-regular" >}} - - ```bash - cp package/* path/to/mirror/ - ``` - - If the directory created in step 3 happens to be in the current directory and the directory name happens to be `package`, you do not need to copy the files manually. - -6. Check whether the `Hello World` component is created successfully: - - {{< copyable "shell-root" >}} - - ```bash - tiup list hello - ``` - - ``` - Available versions for hello (Last Modified: 2020-04-23T16:45:53+08:00): - Version Installed Release: Platforms - ------- --------- -------- --------- - v0.0.1 2020-04-23T16:51:41+08:00 darwin/amd64 - ``` - - {{< copyable "shell-root" >}} - - ```bash - tiup hello - ``` - - ``` - The component `hello` is not installed; downloading from repository. - Starting component `hello`: /Users/joshua/.tiup/components/hello/v0.0.1/hello.sh - Hello World - ``` diff --git a/tiup/tiup-overview.md b/tiup/tiup-overview.md index a726ebbecece8..f8bb6af19b55c 100644 --- a/tiup/tiup-overview.md +++ b/tiup/tiup-overview.md @@ -114,7 +114,6 @@ The output is long but you can focus on only two parts: - client: used to connect to a TiDB cluster in a local machine - mirrors: used to clone a private mirror from an official mirror - cluster: used to deploy a TiDB cluster for production environments - - package: used to package a new TiUP component - bench: used to stress test the database - doc: used to open online document @@ -132,5 +131,4 @@ All TiUP commands are described in [Manage TiUP Components with TiUP Commands](/ - [Quickly Deploy a Local TiDB Cluster](/tiup/tiup-playground.md): introduce the playground component - [Deploy and Maintain an Online TiDB Cluster](/tiup/tiup-cluster.md): introduce the cluster component - [Create a Private Mirror](/tiup/tiup-mirrors.md): introduce the mirrors component -- [Package a Component](/tiup/package-tiup-component.md): introduce the package component - [Stress Test TiDB Using TiUP](/tiup/tiup-bench.md): introduce the bench component From 5d3837ccd73930929feb530efc208a79c48d2525 Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 11 Jun 2020 12:50:58 +0800 Subject: [PATCH 15/15] align https://github.com/pingcap/docs-cn/pull/3542 --- tiflash/troubleshoot-tiflash.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tiflash/troubleshoot-tiflash.md b/tiflash/troubleshoot-tiflash.md index c246d5d09c747..7bf21c3f0a4cb 100644 --- a/tiflash/troubleshoot-tiflash.md +++ b/tiflash/troubleshoot-tiflash.md @@ -12,7 +12,7 @@ This section describes some commonly encountered issues when using TiFlash, the This is because TiFlash is in an abnormal state caused by configuration errors or environment issues. Take the following steps to identify the faulty component: -1. Check whether PD enables the `Placement Rules` feature (to enable the feature, see the step 2 of [Add TiFlash component to an existing TiDB cluster](/tiflash/deploy-tiflash.md#add-tiflash-component-to-an-existing-tidb-cluster): +1. Check whether PD enables the `Placement Rules` feature: {{< copyable "shell-regular" >}} @@ -20,7 +20,7 @@ This is because TiFlash is in an abnormal state caused by configuration errors o echo 'config show replication' | /path/to/pd-ctl -u http://: ``` - The expected result is `"enable-placement-rules": "true"`. + The expected result is `"enable-placement-rules": "true"`. If not enabled, [enable the Placement Rules feature](/configure-placement-rules.md#enable-placement-rules). 2. Check whether the TiFlash process is working correctly by viewing `UpTime` on the TiFlash-Summary monitoring panel.