From 5483f9f8696990378626c6bb7c02f83d478987ea Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Tue, 30 Jan 2024 17:52:37 +0800 Subject: [PATCH] fix links (#2446) * fix links * Update docs-2.0-en/20.appendix/0.FAQ.md Co-authored-by: Chris Chen --------- Co-authored-by: Chris Chen --- docs-2.0-en/20.appendix/0.FAQ.md | 26 +++++------- .../3.property-reference.md | 2 +- .../6.functions-and-expressions/4.schema.md | 4 +- .../1.general-query-statements-overview.md | 2 +- .../8.clauses-and-options/where.md | 2 +- .../connector/nebula-spark-connector.md | 2 +- .../5.solution/5.1.supporting-application.md | 4 +- docs-2.0-zh/20.appendix/0.FAQ.md | 2 +- .../3.property-reference.md | 2 +- .../5.operators/5.property-reference.md | 41 ------------------- .../6.functions-and-expressions/4.schema.md | 4 +- .../1.general-query-statements-overview.md | 2 +- .../8.clauses-and-options/where.md | 2 +- mkdocs.yml | 2 +- 14 files changed, 26 insertions(+), 71 deletions(-) delete mode 100644 docs-2.0-zh/3.ngql-guide/5.operators/5.property-reference.md diff --git a/docs-2.0-en/20.appendix/0.FAQ.md b/docs-2.0-en/20.appendix/0.FAQ.md index 50dbad6b60e..28ae793249f 100644 --- a/docs-2.0-en/20.appendix/0.FAQ.md +++ b/docs-2.0-en/20.appendix/0.FAQ.md @@ -351,33 +351,29 @@ $ ./nebula-graphd --version #### Increase or decrease the number of Meta, Graph, or Storage nodes -NebulaGraph {{ nebula.release }} does not provide any commands or tools to support automatic scale out/in. You can refer to the following steps: +- NebulaGraph {{ nebula.release }} does not provide any commands or tools to support automatic scale out/in. You can refer to the following steps: -1. Scale out and scale in metad: The metad process can not be scaled out or scale in. The process cannot be moved to a new machine. You cannot add a new metad process to the service. + - Scale out and scale in metad: The metad process can not be scaled out or scale in. The process cannot be moved to a new machine. You cannot add a new metad process to the service. - !!! note + !!! note You can use the [Meta transfer script tool](https://github.com/vesoft-inc/nebula/blob/master/scripts/meta-transfer-tools.sh) to migrate Meta services. Note that the Meta-related settings in the configuration files of Storage and Graph services need to be modified correspondingly. -2. Scale in graphd: Remove the IP of the graphd process from the code in the client. Close this graphd process. + - Scale in graphd: Remove the IP of the graphd process from the code in the client. Close this graphd process. -3. Scale out graphd: Prepare the binary and config files of the graphd process in the new host. Modify the config files and add all existing addresses of the metad processes. Then start the new graphd process. + - Scale out graphd: Prepare the binary and config files of the graphd process in the new host. Modify the config files and add all existing addresses of the metad processes. Then start the new graphd process. -4. Scale in storaged: See [Balance remove command](../8.service-tuning/load-balance.md). After the command is finished, stop this storaged process. + - Scale in storaged: See [Balance remove command](../8.service-tuning/load-balance.md). After the command is finished, stop this storaged process. - !!! caution + !!! caution - - Before executing this command to migrate the data in the specified Storage node, make sure that the number of other Storage nodes is sufficient to meet the set replication factor. For example, if the replication factor is set to 3, then before executing this command, make sure that the number of other Storage nodes is greater than or equal to 3. + - Before executing this command to migrate the data in the specified Storage node, make sure that the number of other Storage nodes is sufficient to meet the set replication factor. For example, if the replication factor is set to 3, then before executing this command, make sure that the number of other Storage nodes is greater than or equal to 3. - - If there are multiple space partitions in the Storage node to be migrated, execute this command in each space to migrate all space partitions in the Storage node. - -5. Scale out storaged: Prepare the binary and config files of the storaged process in the new host, Modify the config files and add all existing addresses of the metad processes. Then register the storaged process to the metad, and then start the new storaged process. For details, see [Register storaged services](../2.quick-start/3.1add-storage-hosts.md). - -You also need to run [Balance Data and Balance leader](../8.service-tuning/load-balance.md) after scaling in/out storaged. + - If there are multiple space partitions in the Storage node to be migrated, execute this command in each space to migrate all space partitions in the Storage node. -You can scale Graph and Storage services with Dashboard Enterprise Edition. For details, see [Scale](../nebula-dashboard-ent/4.cluster-operator/operator/scale.md). + - Scale out storaged: Prepare the binary and config files of the storaged process in the new host, modify the config files and add all existing addresses of the metad processes. Then register the storaged process to the metad, and then start the new storaged process. For details, see [Register storaged services](../2.quick-start/3.1add-storage-hosts.md). -You can also use NebulaGraph Operator to scale Graph and Storage services. For details, see [Deploy NebulaGraph clusters](../k8s-operator/4.cluster-administration/4.1.installation/4.1.1.cluster-install.md). + You also need to run [Balance Data and Balance leader](../8.service-tuning/load-balance.md) after scaling in/out storaged. #### Add or remove disks in the Storage nodes diff --git a/docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md b/docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md index a2b45cd7d22..936b77cafdc 100644 --- a/docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md +++ b/docs-2.0-en/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md @@ -48,7 +48,7 @@ nGQL allows you to reference edge properties, including user-defined edge proper | Parameter | Description | | :---------- | :------------------ | -| `$-` | Used to get the output results of the statement before the pipe in the composite query. For more information, see [Pipe](4.pipe.md). | +| `$-` | Used to get the output results of the statement before the pipe in the composite query. For more information, see [Pipe](../5.operators/4.pipe.md). | ## Examples diff --git a/docs-2.0-en/3.ngql-guide/6.functions-and-expressions/4.schema.md b/docs-2.0-en/3.ngql-guide/6.functions-and-expressions/4.schema.md index 5e5cb8338da..954b5791642 100644 --- a/docs-2.0-en/3.ngql-guide/6.functions-and-expressions/4.schema.md +++ b/docs-2.0-en/3.ngql-guide/6.functions-and-expressions/4.schema.md @@ -57,7 +57,7 @@ You can also use the property reference symbols (`$^` and `$$`) instead of the ` - `$$` represents the data of the end vertex at the end of exploration. -`properties($^)` and `properties($$)` are generally used in `GO` statements. For more information, see [Property reference](../5.operators/5.property-reference.md). +`properties($^)` and `properties($$)` are generally used in `GO` statements. For more information, see [Property reference](../4.variable-and-composite-queries/3.property-reference.md). !!! caution @@ -133,7 +133,7 @@ nebula> GO FROM "player100" OVER follow \ !!! note - The semantics of the query for the starting vertex with src(edge) and [properties(`$^`)](../5.operators/5.property-reference.md) are different. src(edge) indicates the starting vertex ID of the edge in the graph database, while properties(`$^`) indicates the data of the starting vertex where you start to expand the graph, such as the data of the starting vertex `player100` in the above GO statement. + The semantics of the query for the starting vertex with src(edge) and [properties(`$^`)](../4.variable-and-composite-queries/3.property-reference.md) are different. src(edge) indicates the starting vertex ID of the edge in the graph database, while properties(`$^`) indicates the data of the starting vertex where you start to expand the graph, such as the data of the starting vertex `player100` in the above GO statement. ### dst(edge) diff --git a/docs-2.0-en/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md b/docs-2.0-en/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md index cd009f4e3e5..cebd0c03ba5 100644 --- a/docs-2.0-en/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md +++ b/docs-2.0-en/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md @@ -83,7 +83,7 @@ For more information, see [LOOKUP ON](5.lookup.md). **Use case:** Complex graph traversals, such as finding friends of a vertex, friends' friends, etc. **Note:** -- Use [property reference symbols](../5.operators/5.property-reference.md) (`$^` and `$$`) to return properties of the starting or target vertices, e.g., `YIELD $^.player.name`. +- Use [property reference symbols](../4.variable-and-composite-queries/3.property-reference.md) (`$^` and `$$`) to return properties of the starting or target vertices, e.g., `YIELD $^.player.name`. - Use the functions `properties($^)` and `properties($$)` to return all properties of the starting or target vertices. Specify property names in the function to return specific properties, e.g., `YIELD properties($^).name`. - Use the functions `src(edge)` and `dst(edge)` to return the starting or destination vertex ID of an edge, e.g., `YIELD src(edge)`. diff --git a/docs-2.0-en/3.ngql-guide/8.clauses-and-options/where.md b/docs-2.0-en/3.ngql-guide/8.clauses-and-options/where.md index ff301aaad46..22b52efa982 100644 --- a/docs-2.0-en/3.ngql-guide/8.clauses-and-options/where.md +++ b/docs-2.0-en/3.ngql-guide/8.clauses-and-options/where.md @@ -15,7 +15,7 @@ The `WHERE` clause usually works in the following queries: ## Basic usage !!! note - In the following examples, `$$` and `$^` are reference operators. For more information, see [Operators](../5.operators/5.property-reference.md). + In the following examples, `$$` and `$^` are reference operators. For more information, see [Operators](../4.variable-and-composite-queries/3.property-reference.md). ### Define conditions with boolean operators diff --git a/docs-2.0-en/connector/nebula-spark-connector.md b/docs-2.0-en/connector/nebula-spark-connector.md index e44fec90d29..377bc0edb32 100644 --- a/docs-2.0-en/connector/nebula-spark-connector.md +++ b/docs-2.0-en/connector/nebula-spark-connector.md @@ -44,7 +44,7 @@ NebulaGraph Spark Connector applies to the following scenarios: - Read data from {{nebula.name}} for analysis and computation. - Write data back to {{nebula.name}} after analysis and computation. - Migrate the data of {{nebula.name}}. -- Graph computing with [NebulaGraph Algorithm](graph-computing/nebula-algorithm.md). +- Graph computing with [NebulaGraph Algorithm](../graph-computing/nebula-algorithm.md). ## Benefits diff --git a/docs-2.0-en/nebula-cloud/5.solution/5.1.supporting-application.md b/docs-2.0-en/nebula-cloud/5.solution/5.1.supporting-application.md index 95258c27620..ceade4e731c 100644 --- a/docs-2.0-en/nebula-cloud/5.solution/5.1.supporting-application.md +++ b/docs-2.0-en/nebula-cloud/5.solution/5.1.supporting-application.md @@ -12,7 +12,7 @@ On the **Applications** page, ecosystem tools are different based on roles and p ## Dashboard -NebulaGraph Dashboard (Dashboard for short) is a visualization tool that monitors and manages the status of machines and services in NebulaGraph clusters. Currently Dashboard in Cloud only supports [Cluster monitoring](../../nebula-dashboard-ent/4.cluster-operator/2.monitor.md) page. +NebulaGraph Dashboard (Dashboard for short) is a visualization tool that monitors and manages the status of machines and services in NebulaGraph clusters. ## Studio @@ -20,4 +20,4 @@ NebulaGraph Studio (Studio in short) is a browser-based visualization tool to ma ## Explorer -NebulaGraph Explorer (Explorer in short) is a browser-based visualization tool. It is used with the NebulaGraph core to visualize interaction with graph data. Even without any experience in a graph database, you can quickly become a graph exploration expert. For more information, see [What is NebulaGraph Explorer](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md). +NebulaGraph Explorer (Explorer in short) is a browser-based visualization tool. It is used with the NebulaGraph core to visualize interaction with graph data. Even without any experience in a graph database, you can quickly become a graph exploration expert. diff --git a/docs-2.0-zh/20.appendix/0.FAQ.md b/docs-2.0-zh/20.appendix/0.FAQ.md index bf7e66377c0..fc6e073ffa6 100644 --- a/docs-2.0-zh/20.appendix/0.FAQ.md +++ b/docs-2.0-zh/20.appendix/0.FAQ.md @@ -572,7 +572,7 @@ Fail to create a new session from connection pool, fail to authenticate, error: !!! note - 用户可以使用[脚本工具](https://github.com/vesoft-inc/nebula/blob/master/scripts/meta-transfer-tools.sh) 迁移 Meta 服务，但是需要自行修改 Graph 服务和 Storage 服务的配置文件中的 Meta 设置。 + 用户可以使用[脚本工具](https://github.com/vesoft-inc/nebula/blob/master/scripts/meta-transfer-tools.sh) 迁移 Meta 服务，但是需要自行修改 Graph 服务和 Storage 服务的配置文件中的 Meta 设置。 - Graph 的缩容：将该 Graph 的 IP 从 client 的代码中移除，关闭该 Graph 进程。 diff --git a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md index 432fc3bce69..3014ea133e2 100644 --- a/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md +++ b/docs-2.0-zh/3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md @@ -48,7 +48,7 @@ nGQL 允许用户引用边的属性，包括自定义的边属性和四种内置 |引用符|说明| |:---|:---| -|`$-`|引用复合查询中管道符之前的语句输出结果。更多信息请参见[管道符](4.pipe.md)。| +|`$-`|引用复合查询中管道符之前的语句输出结果。更多信息请参见[管道符](../5.operators/4.pipe.md)。| ## 示例 diff --git a/docs-2.0-zh/3.ngql-guide/5.operators/5.property-reference.md b/docs-2.0-zh/3.ngql-guide/5.operators/5.property-reference.md deleted file mode 100644 index dac8474e920..00000000000 --- a/docs-2.0-zh/3.ngql-guide/5.operators/5.property-reference.md +++ /dev/null @@ -1,41 +0,0 @@ -# 引用符 - -nGQL 提供引用符来表示`WHERE`和`YIELD`子句中的属性，或者复合查询中管道符之前的语句输出结果。 - -## openCypher 兼容性 - -引用符仅适用于原生 nGQL。 - -## 引用符列表 - -|引用符|说明| -|:---|:---| -|`$^`|引用起始点。更多信息请参见[引用属性](../4.variable-and-composite-queries/3.property-reference.md)。| -|`$$`|引用目的点。更多信息请参见[引用属性](../4.variable-and-composite-queries/3.property-reference.md)。| -|`$-`|引用复合查询中管道符之前的语句输出结果。更多信息请参见[管道符](4.pipe.md)。| - -## 示例 - -```ngql -# 返回起始点和目的点的年龄。 -nebula> GO FROM "player100" OVER follow YIELD properties($^).age AS SrcAge, properties($$).age AS DestAge; -+--------+---------+ -| SrcAge | DestAge | -+--------+---------+ -| 42 | 36 | -| 42 | 41 | -+--------+---------+ - -# 返回 player100 追随的 player 的名称和团队。 -nebula> GO FROM "player100" OVER follow \ - YIELD dst(edge) AS id | \ - GO FROM $-.id OVER serve \ - YIELD properties($^).name AS Player, properties($$).name AS Team; -+-----------------+-----------+ -| Player | Team | -+-----------------+-----------+ -| "Tony Parker" | "Spurs" | -| "Tony Parker" | "Hornets" | -| "Manu Ginobili" | "Spurs" | -+-----------------+-----------+ -``` diff --git a/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/4.schema.md b/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/4.schema.md index 20ca05dd195..33b21b9c21c 100644 --- a/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/4.schema.md +++ b/docs-2.0-zh/3.ngql-guide/6.functions-and-expressions/4.schema.md @@ -62,7 +62,7 @@ nebula> LOOKUP ON player WHERE player.age > 45 \ - `$$`表示探索结束的终点数据。 -`properties($^)`和`properties($$)`一般用于`GO`语句中。更多信息，请参见[属性引用符](../5.operators/5.property-reference.md)。 +`properties($^)`和`properties($$)`一般用于`GO`语句中。更多信息，请参见[属性引用符](../4.variable-and-composite-queries/3.property-reference.md)。 !!! caution @@ -137,7 +137,7 @@ nebula> GO FROM "player100" OVER follow \ !!! note - src(edge) 和 [properties(`$^`)](../5.operators/5.property-reference.md) 查找起始点的语义不同。src(edge) 始终表示图数据库中边的起始点 ID，而 properties(`$^`) 表示探索开始时的点数据，例如示例中`GO FROM "player100"`中`player100`这个点的数据。 + src(edge) 和 [properties(`$^`)](../4.variable-and-composite-queries/3.property-reference.md) 查找起始点的语义不同。src(edge) 始终表示图数据库中边的起始点 ID，而 properties(`$^`) 表示探索开始时的点数据，例如示例中`GO FROM "player100"`中`player100`这个点的数据。 ### dst(edge) diff --git a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md index a8be785022b..4a19fd701bc 100644 --- a/docs-2.0-zh/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md +++ b/docs-2.0-zh/3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.md @@ -86,7 +86,7 @@ LOOKUP ON player WHERE player.name == "Tony Parker" YIELD id(vertex); **说明**： -- 结合[属性引用符](../5.operators/5.property-reference.md)(`$^`和`$$`)来返回起始点或目标点的属性，例如`YIELD $^.player.name`。 +- 结合[属性引用符](../4.variable-and-composite-queries/3.property-reference.md)(`$^`和`$$`)来返回起始点或目标点的属性，例如`YIELD $^.player.name`。 - 结合[函数](../6.functions-and-expressions/4.schema.md)`properties($^)`和`properties($$)`来返回起始点或目标点的所有属性；或者在函数中指定属性名，来返回指定的属性，例如`YIELD properties($^).name`。 - 结合[函数](../6.functions-and-expressions/4.schema.md)`src(edge)`和`dst(edge)`来返回边的起始点或目标点 ID，例如`YIELD src(edge)`。 diff --git a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/where.md b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/where.md index d6ad500abb6..4ee89a7e1a5 100644 --- a/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/where.md +++ b/docs-2.0-zh/3.ngql-guide/8.clauses-and-options/where.md @@ -15,7 +15,7 @@ ## 基础用法 !!! note - 下文示例中的`$$`、`$^`等是引用符号，详情请参见[引用符](../5.operators/5.property-reference.md)。 + 下文示例中的`$$`、`$^`等是引用符号，详情请参见[引用符](../4.variable-and-composite-queries/3.property-reference.md)。 ### 用布尔运算符定义条件 diff --git a/mkdocs.yml b/mkdocs.yml index 10cd39f769d..233d768084f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -752,7 +752,7 @@ nav: - YIELD: 3.ngql-guide/8.clauses-and-options/yield.md - WITH: 3.ngql-guide/8.clauses-and-options/with.md - UNWIND: 3.ngql-guide/8.clauses-and-options/unwind.md -# - INNER JOIN: 3.ngql-guide/8.clauses-and-options/joins.md + - INNER JOIN: 3.ngql-guide/8.clauses-and-options/joins.md - 变量和复合查询: - 复合查询: 3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md