From 6c342eac569c6585a872966438adbb1c06ef0939 Mon Sep 17 00:00:00 2001 From: zsj01191894 Date: Fri, 19 Apr 2024 16:58:43 +0800 Subject: [PATCH] fix links --- .menu_en.yml | 2 +- .../100.quickly-experience-oceanbase-for-community.md | 4 ++-- .../500.deploy-OceanBase-database-of-multi-node-cluster.md | 2 +- .../700.clear-the-residual-information.md | 2 +- .../700.physical-standby-database-of-system-principle.md | 2 +- .../100.obshell/300.obshell-clients/200.cluster-commands.md | 4 ++-- .../100.obshell/400.obshell-api-reference/800.stop-cluster.md | 2 +- .../100.manage/200.ob-admin/100.overview-of-ob-admin.md | 4 ++-- .../300.clog/500.transaction-information-of-clog.md | 2 +- .../100.manage/600.oceanbase-deployer.md | 2 +- .../100.introduction-ob-partition-calculator.md | 4 ++-- .../200.use-of-the-ob-partition-calculator.md | 2 +- .../200.obcdc-parameters/200.obcdc-configuration-items.md | 2 +- 13 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.menu_en.yml b/.menu_en.yml index 53ceb75174..2c8f64dce6 100644 --- a/.menu_en.yml +++ b/.menu_en.yml @@ -502,7 +502,7 @@ 1300.drivers=Drivers 1400.platform-products=Platforms 400.1.ocp-express=OCP Express - 1500.components-and-tools=Components & tools + 1500.command-line-tools=Components & tools 100.manage=O & M 100.obshell=OBShell 210.use-case=Use OBShell diff --git a/en-US/200.quickstart/100.quickly-experience-oceanbase-for-community.md b/en-US/200.quickstart/100.quickly-experience-oceanbase-for-community.md index dc97927228..4256e80606 100644 --- a/en-US/200.quickstart/100.quickly-experience-oceanbase-for-community.md +++ b/en-US/200.quickstart/100.quickly-experience-oceanbase-for-community.md @@ -37,11 +37,11 @@ OceanBase Database provides an all-in-one installation package since V4.0.0. You * OCP Express - OCP Express is a web-based management tool for OceanBase Database V4.x. Integrated with an OceanBase cluster, OCP Express allows you to view key performance metrics of the cluster and perform basic database management operations on the cluster. For more information, see [OCP Express](../700.reference/1400.oceanbase-tools/400.1.ocp-express/100.ocp-express.md). + OCP Express is a web-based management tool for OceanBase Database V4.x. Integrated with an OceanBase cluster, OCP Express allows you to view key performance metrics of the cluster and perform basic database management operations on the cluster. For more information, see [OCP Express](../700.reference/1400.platform-products/400.1.ocp-express/100.ocp-express.md). * OBAgent - OBAgent is a data monitoring and collection framework for OceanBase Database. The framework supports both pushing and pulling modes for data collection in different scenarios. For more information, see [OBAgent](../700.reference/1500.command-line-tools/900.ob-agent/100.about-obagent/100.what-is-obagent.md). + OBAgent is a data monitoring and collection framework for OceanBase Database. The framework supports both pushing and pulling modes for data collection in different scenarios. * Grafana diff --git a/en-US/400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/500.deploy-OceanBase-database-of-multi-node-cluster.md b/en-US/400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/500.deploy-OceanBase-database-of-multi-node-cluster.md index ab43f02071..c3b81564dc 100644 --- a/en-US/400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/500.deploy-OceanBase-database-of-multi-node-cluster.md +++ b/en-US/400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/500.deploy-OceanBase-database-of-multi-node-cluster.md @@ -31,7 +31,7 @@ This topic describes how to deploy OceanBase Database in a production environmen * OCP Express - OCP Express is a web-based management tool for OceanBase Database V4.x. Integrated with an OceanBase cluster, OCP Express allows you to view key performance metrics of the cluster and perform basic database management operations on the cluster. For more information, see [OCP Express](../../../700.reference/1400.oceanbase-tools/400.1.ocp-express/100.ocp-express.md). + OCP Express is a web-based management tool for OceanBase Database V4.x. Integrated with an OceanBase cluster, OCP Express allows you to view key performance metrics of the cluster and perform basic database management operations on the cluster. For more information, see [OCP Express](../../../700.reference/1400.platform-products/400.1.ocp-express/100.ocp-express.md). ## Prerequisites diff --git a/en-US/600.manage/400.high-availability/400.arbitration-high-availability/700.clear-the-residual-information.md b/en-US/600.manage/400.high-availability/400.arbitration-high-availability/700.clear-the-residual-information.md index 78524e8b9e..285066b140 100644 --- a/en-US/600.manage/400.high-availability/400.arbitration-high-availability/700.clear-the-residual-information.md +++ b/en-US/600.manage/400.high-availability/400.arbitration-high-availability/700.clear-the-residual-information.md @@ -16,7 +16,7 @@ If the original OBServer node where the arbitration service resides is down or d ## Prerequisites -The ob_admin tool is installed on the original OBServer node where the arbitration service resides. When you deploy the arbitration service on an OBServer node, the ob_admin tool is installed in the `/home/admin/oceanbase/bin` directory on the OBServer node by default. If the ob_admin tool is not installed on the original OBServer node where the arbitration service resides, you must install the ob_admin tool before you clear the residual cluster information. For more information about how to install the ob_admin tool, see [ob_admin overview](../../../700.reference/1500.command-line-tools/800.ob-admin/100.overview-of-ob-admin.md). +The ob_admin tool is installed on the original OBServer node where the arbitration service resides. When you deploy the arbitration service on an OBServer node, the ob_admin tool is installed in the `/home/admin/oceanbase/bin` directory on the OBServer node by default. If the ob_admin tool is not installed on the original OBServer node where the arbitration service resides, you must install the ob_admin tool before you clear the residual cluster information. For more information about how to install the ob_admin tool, see [ob_admin overview](../../../700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md). ## Procedure diff --git a/en-US/700.reference/100.oceanbase-database-concepts/1000.high-data-reliability-and-availability/700.physical-standby-database-of-system-principle.md b/en-US/700.reference/100.oceanbase-database-concepts/1000.high-data-reliability-and-availability/700.physical-standby-database-of-system-principle.md index fde39188e8..79fc404eb1 100644 --- a/en-US/700.reference/100.oceanbase-database-concepts/1000.high-data-reliability-and-availability/700.physical-standby-database-of-system-principle.md +++ b/en-US/700.reference/100.oceanbase-database-concepts/1000.high-data-reliability-and-availability/700.physical-standby-database-of-system-principle.md @@ -97,4 +97,4 @@ CDC can convert all database modification operations in an OceanBase cluster int Such a logical standby database consumes a lot of resources, and its execution efficiency is lower than that of a physical standby database built based on synchronization of redo logs. Therefore, we recommend that you use the Physical Standby Database solution in OceanBase Database. -For more information about CDC, see [Overview](../../1500.command-line-tools/1100.cdc/100.overview-of-cdc.md). \ No newline at end of file +For more information about CDC, see [Overview](../../1500.command-line-tools/300.data-integrate/400.cdc/100.overview-of-cdc.md). \ No newline at end of file diff --git a/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/200.cluster-commands.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/200.cluster-commands.md index e67721fa81..f45eba966d 100644 --- a/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/200.cluster-commands.md +++ b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/300.obshell-clients/200.cluster-commands.md @@ -85,7 +85,7 @@ The status of an OBServer node is described as follows: - DELETING: The OBServer node is being deleted. - STOPPED: The OBServer node is stopped. -For more information about `status`, see [oceanbase.DBA_OB_SERVERS](../../../700.system-views/300.system-view-of-sys-tenant/200.dictionary-view-of-sys-tenant/5000.oceanbase-dba_ob_servers-of-sys-tenant.md). +For more information about `status`, see [oceanbase.DBA_OB_SERVERS](../../../../700.system-views/300.system-view-of-sys-tenant/200.dictionary-view-of-sys-tenant/5000.oceanbase-dba_ob_servers-of-sys-tenant.md). ## `obshell cluster start` @@ -116,7 +116,7 @@ The following table describes the options in the command. | Option | Required | Data type | Default value | Description | | --- | --- | --- | --- | --- | -| -f, --force | No | bool | false | The value `true` specifies to kill the observer process. The value `false` specifies to stop the server. For more information, see [Isolate a node](../../../../600.manage/100.cluster-management/300.common-cluster-operations/600.isolation-a-node.md). | +| -f, --force | No | bool | false | The value `true` specifies to kill the observer process. The value `false` specifies to stop the server. For more information, see [Isolate a node](../../../../../600.manage/100.cluster-management/300.common-cluster-operations/600.isolation-a-node.md). | | -a, --all | No | | None | Specifies to stop all OBServer nodes. You do not need to set a value for this option. | | -s, --observer | No | string | None | The information of each OBShell-managed OBServer node to be stopped in the `obshell_ip:obshell_port` format. You must separate the information of multiple OBServer nodes with commas (`,`). Example: `-s x.x.x.x:2886,x.x.x.x:2886`. | | -z, --zonename | No | string | None | Specifies to stop all OBServer nodes contained in the specified one or mroe zones. You must separate the names of multiple zones with commas (`,`). Example: `-z zone1,zone2`. | diff --git a/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/800.stop-cluster.md b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/800.stop-cluster.md index 1eb0c53d27..8257e11c12 100644 --- a/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/800.stop-cluster.md +++ b/en-US/700.reference/1500.command-line-tools/100.manage/100.obshell/400.obshell-api-reference/800.stop-cluster.md @@ -17,7 +17,7 @@ POST /api/v1/ob/stop | Parameter | Type | Required | Example value | Description | | --- | --- | --- | --- | --- | | scope | Object | Yes | For more information, see [SetServerConfig](500.set-server-level.md). | The scope of the OBServer nodes that you want to stop. | -| force | Boolean | No | true | The value `true` specifies to kill the observer process. The value `false` specifies to stop the server. For more information, see [Isolate a node](../../../../600.manage/100.cluster-management/300.common-cluster-operations/600.isolation-a-node.md). | +| force | Boolean | No | true | The value `true` specifies to kill the observer process. The value `false` specifies to stop the server. For more information, see [Isolate a node](../../../../../600.manage/100.cluster-management/300.common-cluster-operations/600.isolation-a-node.md). | | forcePassDag | []String | No | | The ID of the preceding task that starts or stops the specified OBServer nodes. You can use this parameter in special circumstances. When a cluster O&M task is locked by one or more preceding tasks, you can specify this parameter to release the previous tasks. | ### Response parameters diff --git a/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md index 90ec804c9b..9a4aee10cf 100644 --- a/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md +++ b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/100.overview-of-ob-admin.md @@ -155,11 +155,11 @@ For more information, see [clog_tool](300.clog/300.clog-tool.md). ### dumpsst -dumpsst displays the content in `block_file`, such as superblocks, macroblocks, macroblock meta, SSTables, and SSTable meta. Generally, you can use it to trace online issues and locate data issues. For more information, see [dumpsst](../800.ob-admin/500.dumpsst.md). +dumpsst displays the content in `block_file`, such as superblocks, macroblocks, macroblock meta, SSTables, and SSTable meta. Generally, you can use it to trace online issues and locate data issues. For more information, see [dumpsst](../200.ob-admin/500.dumpsst.md). ### dump_backup -dump_backup parses the data content for physical backup. For more information, see [dump_backup](../800.ob-admin/600.dump-backup.md). +dump_backup parses the data content for physical backup. For more information, see [dump_backup](../200.ob-admin/600.dump-backup.md).

Note

diff --git a/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/500.transaction-information-of-clog.md b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/500.transaction-information-of-clog.md index 71d08dd99e..5a5d5029b0 100644 --- a/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/500.transaction-information-of-clog.md +++ b/en-US/700.reference/1500.command-line-tools/100.manage/200.ob-admin/300.clog/500.transaction-information-of-clog.md @@ -9,7 +9,7 @@ Based on the transaction operation type and the distribution of accessed data, t * Local transaction: The information about a local transaction is maintained on the same OBServer node as the one that stores data accessed by the transaction. Such a transaction accesses only data in the same partition. * Distributed transaction: The information about a distributed transaction is maintained on a different node from the one that stores data accessed by the transaction. Such a transaction accesses data in multiple partitions. -For more information about transaction types, see [Local transactions](../../../100.oceanbase-database-concepts/800.transaction-management/100.transaction/700.local-transaction.md) and [Distributed transactions](../../../100.oceanbase-database-concepts/800.transaction-management/100.transaction/800.distributed-transactions-1/100.overview-of-distributed-transactions.md). +For more information about transaction types, see [Local transactions](../../../../100.oceanbase-database-concepts/800.transaction-management/100.transaction/700.local-transaction.md) and [Distributed transactions](../../../../100.oceanbase-database-concepts/800.transaction-management/100.transaction/800.distributed-transactions-1/100.overview-of-distributed-transactions.md). ## Transaction log types diff --git a/en-US/700.reference/1500.command-line-tools/100.manage/600.oceanbase-deployer.md b/en-US/700.reference/1500.command-line-tools/100.manage/600.oceanbase-deployer.md index 49671a3d7a..f0ab0e3329 100644 --- a/en-US/700.reference/1500.command-line-tools/100.manage/600.oceanbase-deployer.md +++ b/en-US/700.reference/1500.command-line-tools/100.manage/600.oceanbase-deployer.md @@ -1,6 +1,6 @@ # OBD -OceanBase Deployer (OBD) is a tool for installing and deploying OceanBase clusters. OBD allows you to deploy an OceanBase cluster on the CLI or GUI and provides a standardized configuration process to simplify cluster deployment. For more information, see [Deploy OceanBase Database on the CLI in a production environment](../../400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/500.deploy-OceanBase-database-of-multi-node-cluster.md) and [Deploy an OceanBase cluster on the GUI of OBD](../../400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/400.deploy-by-ui/100.deploy-by-obd.md). +OceanBase Deployer (OBD) is a tool for installing and deploying OceanBase clusters. OBD allows you to deploy an OceanBase cluster on the CLI or GUI and provides a standardized configuration process to simplify cluster deployment. For more information, see [Deploy OceanBase Database on the CLI in a production environment](../../../400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/500.deploy-OceanBase-database-of-multi-node-cluster.md) and [Deploy an OceanBase cluster on the GUI of OBD](../../../400.deploy/500.deploy-oceanbase-database-community-edition/200.local-deployment/400.deploy-by-ui/100.deploy-by-obd.md). In CLI-based deployment, you can edit the configuration file to flexibly adjust the configurations. This deployment mode is not easy for new hands and is suitable for users who want to deeply understand OceanBase Database. In GUI-based deployment, you can easily deploy a cluster by following the wizard. This deployment mode is suitable for users who want to quickly experience OceanBase Database in a standard environment. diff --git a/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/100.introduction-ob-partition-calculator.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/100.introduction-ob-partition-calculator.md index 31c8bea476..583ee8b607 100644 --- a/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/100.introduction-ob-partition-calculator.md +++ b/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/100.introduction-ob-partition-calculator.md @@ -54,9 +54,9 @@ The ob-partition-calculator component builds a partitioning model based on the p The ob-partition-calculator component supports the calculation for types of fields that can be used as partitioning keys in OceanBase Database. For more information about the field types, see the following topics: -[Partition overview](../../300.database-object-management/100.manage-object-of-mysql-mode/300.manage-partitions-of-mysql-mode/100.partition-overview-of-mysql-mode.md) (MySQL mode) +[Partition overview](../../../300.database-object-management/100.manage-object-of-mysql-mode/300.manage-partitions-of-mysql-mode/100.partition-overview-of-mysql-mode.md) (MySQL mode) -[Partition overview](../../300.database-object-management/200.manage-object-of-oracle-mode/200.manage-partitions-of-oracle-mode/100.partition-overview-of-oracle-mode.md) (Oracle mode) +[Partition overview](../../../300.database-object-management/200.manage-object-of-oracle-mode/200.manage-partitions-of-oracle-mode/100.partition-overview-of-oracle-mode.md) (Oracle mode) ## Call method diff --git a/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md index d9bdc117c2..000b48b6f3 100644 --- a/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md +++ b/en-US/700.reference/1500.command-line-tools/300.data-integrate/300.ob-partition-calculator/200.use-of-the-ob-partition-calculator.md @@ -10,7 +10,7 @@ Before you use the ob-partition-calculator component, read the following topics * [Overview](100.introduction-ob-partition-calculator.md) -* [Get started with OceanBase Database](../../../200.quickstart/100.quickly-experience-oceanbase-for-community.md) +* [Get started with OceanBase Database](../../../../200.quickstart/100.quickly-experience-oceanbase-for-community.md) * [Database URL](https://en.oceanbase.com/docs/common-oceanbase-connector-j-en-10000000001093025) diff --git a/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md index a9399b8d8f..1df156fa1f 100644 --- a/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md +++ b/en-US/700.reference/1500.command-line-tools/300.data-integrate/400.cdc/200.obcdc/200.obcdc-parameters/200.obcdc-configuration-items.md @@ -147,7 +147,7 @@ obcdc V4.1 can obtain metadata such as information about schemas and log streams ### Filter data based on cluster_id -obcdc allows you to filter data based on the `cluster_id` blocklist. Although OceanBase Database specifies a valid `cluster_id` range, you can specify the `cluster_id` values to filter out the following unwanted data in a synchronization task: For more information about how to configure `cluster_id` values, see [ob_org_cluster_id](../../../../800.configuration-items-and-system-variables/200.system-variable/400.session-system-variable/8200.ob_org_cluster_id-session.md). +obcdc allows you to filter data based on the `cluster_id` blocklist. Although OceanBase Database specifies a valid `cluster_id` range, you can specify the `cluster_id` values to filter out the following unwanted data in a synchronization task: For more information about how to configure `cluster_id` values, see [ob_org_cluster_id](../../../../../800.configuration-items-and-system-variables/200.system-variable/400.session-system-variable/8200.ob_org_cluster_id-session.md). * The data that is not included in the valid `cluster_id` range specified by OceanBase Database and OceanBase Migration Service (OMS). The value range is \[1, 4294901759\] U \[4294901760, 4294967295\]. * The data that is specified in the `cluster_id_black_list` field.