Skip to content

Commit

Permalink
whitespace (#1252)
Browse files Browse the repository at this point in the history
  • Loading branch information
@abby-cyber
abby-cyber authored Nov 24, 2021
1 parent b0c72f6 commit 53ba41a
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 52 deletions.
18 changes: 9 additions & 9 deletions docs-2.0/3.ngql-guide/14.native-index-statements/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# 索引介绍

Nebula Graph支持两种类型索引：原生索引和全文索引。
Nebula Graph 支持两种类型索引：原生索引和全文索引。

## 原生索引

原生索引可以基于指定的属性查询数据，有如下特点：

- 包括Tag索引和Edge type索引。
- 包括 Tag 索引和 Edge type 索引。

- 必须手动重建索引（`REBUILD INDEX`）。

- 支持创建同一个Tag或Edge type的多个属性的索引（复合索引），但是不能跨Tag或Edge type。
- 支持创建同一个 Tag 或 Edge type 的多个属性的索引（复合索引），但是不能跨 Tag 或 Edge type。

### 原生索引操作

Expand Down Expand Up @@ -38,7 +38,7 @@ Nebula Graph支持两种类型索引：原生索引和全文索引。

- 只允许创建一个属性的索引。

- 只能创建指定长度（不超过256字节）字符串的索引。
- 只能创建指定长度（不超过 256 字节）字符串的索引。

- 不支持逻辑操作，例如`AND`、`OR`、`NOT`。

Expand All @@ -48,15 +48,15 @@ Nebula Graph支持两种类型索引：原生索引和全文索引。

### 全文索引操作

在对全文索引执行任何操作之前，请确保已经部署全文索引。详情请参见[部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)和[部署listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。
在对全文索引执行任何操作之前，请确保已经部署全文索引。详情请参见 [部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md) 和 [部署 listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。

部署完成后，Elasticsearch集群上会自动创建全文索引。不支持重建或修改全文索引。如果需要删除全文索引，请在Elasticsearch集群上手动删除。
部署完成后，Elasticsearch 集群上会自动创建全文索引。不支持重建或修改全文索引。如果需要删除全文索引，请在 Elasticsearch 集群上手动删除。

使用全文索引请参见[使用全文索引查询](../15.full-text-index-statements/1.search-with-text-based-index.md)。
使用全文索引请参见 [使用全文索引查询](../15.full-text-index-statements/1.search-with-text-based-index.md)。

## NULL值说明
## NULL 值说明

不支持对值为NULL的属性创建索引。
不支持对值为 NULL 的属性创建索引。

## 范围查询

Expand Down
14 changes: 7 additions & 7 deletions ....0/3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

## 前提条件

请确保已经部署全文索引。详情请参见[部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)和[部署listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。
请确保已经部署全文索引。详情请参见 [部署全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md) 和 [部署 listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。

## 注意事项

使用全文索引前，请确认已经了解全文索引的[使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。
使用全文索引前，请确认已经了解全文索引的 [使用限制](../../4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md)。

## 自然语言全文搜索

Expand Down Expand Up @@ -62,9 +62,9 @@ LOOKUP ON {<tag> | <edge_type>} WHERE <expression> [YIELD <return_list>];

- FUZZY(schema_name.prop_name, fuzzy_string, fuzziness, operator, row_limit, timeout)

- `fuzziness`：可选项。允许匹配的最大编辑距离。默认值为`AUTO`。查看其他可选值和更多信息，请参见[Elasticsearch官方文档](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/common-options.html#fuzziness)。
- `fuzziness`：可选项。允许匹配的最大编辑距离。默认值为`AUTO`。查看其他可选值和更多信息，请参见 [Elasticsearch 官方文档](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/common-options.html#fuzziness)。

- `operator`：可选项。解释文本的布尔逻辑。可选值为`OR`(默认)和`and`。
- `operator`：可选项。解释文本的布尔逻辑。可选值为`OR`（默认）和`and`。

- `row_limit`：可选项。指定要返回的行数。默认值为`100`。

Expand All @@ -82,10 +82,10 @@ nebula> SIGN IN TEXT SERVICE (127.0.0.1:9200);
//切换图空间。
nebula> USE basketballplayer;
//添加listener到Nebula Graph集群。
//添加 listener 到 Nebula Graph 集群。
nebula> ADD LISTENER ELASTICSEARCH 192.168.8.5:9789;
//创建Tag。
//创建 Tag。
nebula> CREATE TAG IF NOT EXISTS player(name string, age int);
//创建原生索引。
Expand All @@ -94,7 +94,7 @@ nebula> CREATE TAG INDEX IF NOT EXISTS name ON player(name(20));
//重建原生索引。
nebula> REBUILD TAG INDEX;
//创建全文索引，索引名称需要以nebula开头。
//创建全文索引，索引名称需要以 nebula 开头。
nebula> CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name);
//重建全文索引。
Expand Down
8 changes: 4 additions & 4 deletions docs-2.0/3.ngql-guide/16.subgraph-and-path/2.find-path.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ OVER <edge_type_list> [REVERSELY | BIDIRECT] [<WHERE clause>] [UPTO <N> STEPS] [

- `WITH PROP`：展示点和边的属性。不添加本参数则隐藏属性。

- `<vertex_id_list>`：点ID列表。多个点用英文逗号（,）分隔。支持`$-`和`$var`。
- `<vertex_id_list>`：点 ID 列表。多个点用英文逗号（,）分隔。支持`$-`和`$var`。

- `<edge_type_list>`：Edge type列表。多个Edge type用英文逗号（,）分隔。`*`表示所有Edge type。
- `<edge_type_list>`：Edge type 列表。多个 Edge type 用英文逗号（,）分隔。`*`表示所有 Edge type。

- `REVERSELY | BIDIRECT`：`REVERSELY`表示反向，`BIDIRECT`表示双向。

Expand All @@ -34,7 +34,7 @@ OVER <edge_type_list> [REVERSELY | BIDIRECT] [<WHERE clause>] [UPTO <N> STEPS] [

!!! note

`FIND PATH`语句检索的路径类型为`trail`，即检索的路径只有点可以重复，边不可以重复。详情请参见[路径](../../1.introduction/2.1.path.md)。
`FIND PATH`语句检索的路径类型为`trail`，即检索的路径只有点可以重复，边不可以重复。详情请参见 [路径](../../1.introduction/2.1.path.md)。

## 限制

Expand Down Expand Up @@ -96,7 +96,7 @@ nebula> FIND NOLOOP PATH FROM "player100" TO "team204" OVER *;

## FAQ

### 是否支持WHERE子句，以实现图遍历过程中的条件过滤?
### 是否支持 WHERE 子句，以实现图遍历过程中的条件过滤？

支持使用`WHERE`子句过滤，但目前只能过滤边属性，如示例中的`FIND ALL PATH FROM "player100" TO "team204" OVER * WHERE follow.degree is EMPTY or follow.degree >=0;`。

Expand Down
22 changes: 11 additions & 11 deletions docs-2.0/3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# EXPLAIN和PROFILE
# EXPLAIN 和 PROFILE

`EXPLAIN`语句输出nGQL语句的执行计划，但不会执行nGQL语句。
`EXPLAIN`语句输出 nGQL 语句的执行计划，但不会执行 nGQL 语句。

`PROFILE`语句执行nGQL语句，然后输出执行计划和执行概要。用户可以根据执行计划和执行概要优化查询性能。
`PROFILE`语句执行 nGQL 语句，然后输出执行计划和执行概要。用户可以根据执行计划和执行概要优化查询性能。

## 执行计划

执行计划由Nebula Graph查询引擎中的执行计划器决定。
执行计划由 Nebula Graph 查询引擎中的执行计划器决定。

执行计划器将解析后的nGQL语句处理为`action`。`action`是最小的执行单元。典型的`action`包括获取指定点的所有邻居、获取边的属性、根据条件过滤点或边等。每个`action`都被分配给一个`operator`。
执行计划器将解析后的 nGQL 语句处理为`action`。`action`是最小的执行单元。典型的`action`包括获取指定点的所有邻居、获取边的属性、根据条件过滤点或边等。每个`action`都被分配给一个`operator`。

例如`SHOW TAGS`语句分为两个`action`，`operator`为`Start`和`ShowTags`。更复杂的`GO`语句可能会被处理成10个以上的`action`。
例如`SHOW TAGS`语句分为两个`action`，`operator`为`Start`和`ShowTags`。更复杂的`GO`语句可能会被处理成 10 个以上的`action`。

## 语法

Expand Down Expand Up @@ -78,19 +78,19 @@
|参数|说明|
|:---|:---|
|`id`|`operator`的ID。|
|`id`|`operator`的 ID。|
|`name`|`operator`的名称。|
|`dependencies`|当前`operator`所依赖的`operator`的ID。|
|`dependencies`|当前`operator`所依赖的`operator`的 ID。|
|`profiling data`|执行概要文件内容。 `ver`表示`operator`的版本；`rows`表示`operator`输出结果的行数；`execTime`表示执行`action`的时间；`totalTime`表示执行`action`的时间、系统调度时间、排队时间的总和。|
|`operator info`|`operator`的详细信息。|
## `dot`格式
`dot`格式将返回DOT语言的信息，然后用户可以使用Graphviz生成计划图。
`dot`格式将返回 DOT 语言的信息，然后用户可以使用 Graphviz 生成计划图。
!!! Note
Graphviz是一款开源可视化图工具，可以绘制DOT语言脚本描述的图。Graphviz提供一个在线工具，可以预览DOT语言文件，并将它们导出为SVG或JSON等其他格式。详情请参见[Graphviz Online](https://dreampuf.github.io/GraphvizOnline/)。
Graphviz 是一款开源可视化图工具，可以绘制 DOT 语言脚本描述的图。Graphviz 提供一个在线工具，可以预览 DOT 语言文件，并将它们导出为 SVG 或 JSON 等其他格式。详情请参见 [Graphviz Online](https://dreampuf.github.io/GraphvizOnline/)。
```ngql
nebula> EXPLAIN format="dot" SHOW TAGS;
Expand All @@ -108,6 +108,6 @@ Execution Plan
--------------------------------------------------------------------------------------------------------------------------------------------- -------------
```

将上述示例的DOT语言转换为Graphviz图，如下所示。
将上述示例的 DOT 语言转换为 Graphviz 图，如下所示。

![Graphviz graph of EXPLAIN SHOW TAGS](https://docs-cdn.nebula-graph.com.cn/docs-2.0/3.ngql-guide/16.query-tuning-statements/explain-show-tags.png)
6 changes: 3 additions & 3 deletions docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/.1.configs-syntax.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# CONFIG

第一次启动Nebula Graph集群时，系统会从本地配置文件中读取配置，然后保存在Meta服务中，后续重启集群，也会从Meta服务中读取配置。`CONFIG`语句可以修改Meta服务中保存的Nebula Graph配置，不会修改本地配置文件。
第一次启动 Nebula Graph 集群时，系统会从本地配置文件中读取配置，然后保存在 Meta 服务中，后续重启集群，也会从 Meta 服务中读取配置。`CONFIG`语句可以修改 Meta 服务中保存的 Nebula Graph 配置，不会修改本地配置文件。

!!! Note

根据过往实践，建议让Nebula Graph从本地文件获取配置。详情请参见[配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。
根据过往实践，建议让 Nebula Graph 从本地文件获取配置。详情请参见 [配置简介](../../5.configurations-and-logs/1.configurations/1.configurations.md#修改配置)。

## SHOW CONFIGS

`SHOW CONFIGS`语句可以显示服务的配置信息。没有指定服务时，会返回所有服务的配置信息。

执行`SHOW CONFIGS`语句不需要任何权限，但是返回结果由登录的用户[权限](../../7.data-security/1.authentication/3.role-list.md)决定。
执行`SHOW CONFIGS`语句不需要任何权限，但是返回结果由登录的用户 [权限](../../7.data-security/1.authentication/3.role-list.md) 决定。

### 语法

Expand Down
8 changes: 4 additions & 4 deletions docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# BALANCE

`BALANCE`语句可以让Nebula Graph的Storage服务实现负载均衡。更多`BALANCE`语句示例和Storage负载均衡，请参见[Storage负载均衡](../../8.service-tuning/load-balance.md)。
`BALANCE`语句可以让 Nebula Graph 的 Storage 服务实现负载均衡。更多`BALANCE`语句示例和 Storage 负载均衡，请参见 [Storage 负载均衡](../../8.service-tuning/load-balance.md)。

`BALANCE`语法说明如下。

|语法|说明|
|:---|:---|
|`BALANCE DATA`|启动任务均衡分布Nebula Graph集群中（或Group中）的所有分片。该命令会返回任务ID（`balance_id`）。|
|`BALANCE DATA`|启动任务均衡分布 Nebula Graph 集群中（或 Group 中）的所有分片。该命令会返回任务 ID（`balance_id`）。|
|`BALANCE DATA <balance_id>`|显示`BALANCE DATA`任务的状态。|
|`BALANCE DATA STOP`|停止`BALANCE DATA`任务。|
|`BALANCE DATA REMOVE <host_list>`|在Nebula Graph集群中扫描并解绑指定的Storage主机。|
|`BALANCE LEADER`|在Nebula Graph集群中（或Group中）均衡分布leader。|
|`BALANCE DATA REMOVE <host_list>`|在 Nebula Graph 集群中扫描并解绑指定的 Storage 主机。|
|`BALANCE LEADER`|在 Nebula Graph 集群中（或 Group 中）均衡分布 leader。|
22 changes: 11 additions & 11 deletions docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 作业管理

在Storage服务上长期运行的任务称为作业，例如`COMPACT`、`FLUSH`和`STATS`。 如果图空间的数据量很大，这些作业可能耗时很长。作业管理可以帮助执行、查看、停止和恢复作业。
在 Storage 服务上长期运行的任务称为作业，例如`COMPACT`、`FLUSH`和`STATS`。 如果图空间的数据量很大，这些作业可能耗时很长。作业管理可以帮助执行、查看、停止和恢复作业。

!!! note

Expand All @@ -10,7 +10,7 @@

`SUBMIT JOB COMPACT` 语句会触发 RocksDB 的长耗时 `compact` 操作。

`compact`配置详情请参见[Storage服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md)。
`compact`配置详情请参见 [Storage 服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md)。

### 示例

Expand All @@ -25,7 +25,7 @@ nebula> SUBMIT JOB COMPACT;

## SUBMIT JOB FLUSH

`SUBMIT JOB FLUSH`语句将内存中的RocksDB memfile写入硬盘。
`SUBMIT JOB FLUSH`语句将内存中的 RocksDB memfile 写入硬盘。

### 示例

Expand All @@ -40,11 +40,11 @@ nebula> SUBMIT JOB FLUSH;

## SUBMIT JOB STATS

`SUBMIT JOB STATS`语句启动一个作业，该作业对当前图空间进行统计。作业完成后，用户可以使用`SHOW STATS`语句列出统计结果。详情请参见[SHOW STATS](../7.general-query-statements/6.show/14.show-stats.md)。
`SUBMIT JOB STATS`语句启动一个作业，该作业对当前图空间进行统计。作业完成后，用户可以使用`SHOW STATS`语句列出统计结果。详情请参见 [SHOW STATS](../7.general-query-statements/6.show/14.show-stats.md)。

!!! Note

如果存储在Nebula Graph中的数据有变化，为了获取最新的统计结果，请重新执行`SUBMIT JOB STATS`。
如果存储在 Nebula Graph 中的数据有变化，为了获取最新的统计结果，请重新执行`SUBMIT JOB STATS`。

### 示例

Expand All @@ -59,7 +59,7 @@ nebula> SUBMIT JOB STATS;

## SHOW JOB

Meta服务将`SUBMIT JOB`请求解析为多个任务，然后分配给进程nebula-storaged。`SHOW JOB <job_id>`语句显示当前图空间内指定作业和相关任务的信息。
Meta 服务将`SUBMIT JOB`请求解析为多个任务，然后分配给进程 nebula-storaged。`SHOW JOB <job_id>`语句显示当前图空间内指定作业和相关任务的信息。

`job_id`在执行`SUBMIT JOB`语句时会返回。

Expand All @@ -77,9 +77,9 @@ nebula> SHOW JOB 34;

|参数|说明|
|:---|:---|
|Job Id(TaskId)|第一行显示作业ID，其他行显示作业相关的任务ID。|
|Command(Dest)|第一行显示执行的作业命令名称，其他行显示任务对应的nebula-storaged进程。|
|Status|显示作业或任务的状态。详情请参见[作业状态](#_6)。|
|Job Id(TaskId)|第一行显示作业 ID，其他行显示作业相关的任务 ID。|
|Command(Dest)|第一行显示执行的作业命令名称，其他行显示任务对应的 nebula-storaged 进程。|
|Status|显示作业或任务的状态。详情请参见 [作业状态](#_6)。|
|Start Time|显示作业或任务开始执行的时间。|
|Stop Time|显示作业或任务结束执行的时间，结束后的状态包括`FINISHED`、`FAILED`或`STOPPED`。|

Expand Down Expand Up @@ -110,7 +110,7 @@ Queue -- running -- finished -- removed

`SHOW JOBS`语句列出当前图空间内所有未过期的作业。

作业的默认过期时间为一周。如果需要修改过期时间，请修改Meta服务的参数`job_expired_secs`。详情请参见[Meta服务配置](../../5.configurations-and-logs/1.configurations/2.meta-config.md)。
作业的默认过期时间为一周。如果需要修改过期时间，请修改 Meta 服务的参数`job_expired_secs`。详情请参见 [Meta 服务配置](../../5.configurations-and-logs/1.configurations/2.meta-config.md)。

### 示例

Expand Down Expand Up @@ -161,7 +161,7 @@ nebula> RECOVER JOB;

### 如何排查作业问题？

`SUBMIT JOB`操作使用的是HTTP端口，请检查Storage服务机器上的HTTP端口是否正常工作。用户可以执行如下命令调试：
`SUBMIT JOB`操作使用的是 HTTP 端口，请检查 Storage 服务机器上的 HTTP 端口是否正常工作。用户可以执行如下命令调试：

```bash
curl "http://{storaged-ip}:19779/admin?space={space_name}&op=compact"
Expand Down
6 changes: 3 additions & 3 deletions docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/6.kill-query.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
KILL QUERY (session=<session_id>, plan=<plan_id>);
```

- `session_id`：会话ID。
- `plan_id`：执行计划ID。
- `session_id`：会话 ID。
- `plan_id`：执行计划 ID。

会话ID和执行计划ID可以唯一确定一个查询。二者可以通过[SHOW QUERIES](../7.general-query-statements/6.show/18.show-queries.md)语句获取。
会话 ID 和执行计划 ID 可以唯一确定一个查询。二者可以通过 [SHOW QUERIES](../7.general-query-statements/6.show/18.show-queries.md) 语句获取。

## 示例

Expand Down

0 comments on commit 53ba41a

Please sign in to comment.