Skip to content

Commit ca0ef21

Browse files
authored
update balance (#1380)
* update balance * update * update * update * Update 2.balance-syntax.md * Update load-balance.md
1 parent 589c651 commit ca0ef21

File tree

7 files changed

+168
-124
lines changed

7 files changed

+168
-124
lines changed

docs-2.0/3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Execution succeeded
2828
## 保留关键字
2929

3030
```ngql
31+
ACROSS
3132
ADD
3233
ALTER
3334
AND

docs-2.0/3.ngql-guide/14.native-index-statements/5.show-native-index-status.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SHOW INDEX STATUS
22

3-
`SHOW INDEX STATUS`语句可以查看索引名称和对应的状态
3+
`SHOW INDEX STATUS`语句可以查看索引名称和对应作业的状态
44

55
索引状态包括:
66

docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22

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

5+
!!! compatibility "历史版本兼容性"
6+
7+
Neubla Graph 3.0.0 新增 Zone 功能导致 Balance 命令发生变化,3.0.0 之前版本的命令不再兼容。
8+
59
`BALANCE`语法说明如下。
610

711
|语法|说明|
812
|:---|:---|
9-
|`BALANCE DATA`|启动任务均衡分布 Nebula Graph 集群中(或 Group 中)的所有分片。该命令会返回任务 ID`balance_id`|
10-
|`BALANCE DATA <balance_id>`|显示`BALANCE DATA`任务的状态|
11-
|`BALANCE DATA STOP`|停止`BALANCE DATA`任务|
12-
|`BALANCE DATA REMOVE <host_list>`|在 Nebula Graph 集群中扫描并解绑指定的 Storage 主机。|
13-
|`BALANCE LEADER`|在 Nebula Graph 集群中(或 Group 中)均衡分布 leader。|
13+
|`BALANCE IN ZONE [REMOVE <ip>:<port> [,<ip>:<port> ...]]`|在当前图空间内每个 Zone 内部启动任务均衡分布分片。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Storage 节点,方便进行维护|
14+
|`BALANCE ACROSS ZONE [REMOVE "zone_name" [,"zone_name" ...]]`|在当前图空间内所有 Zone 之间启动任务均衡分布分片,保证各个 Zone 分片数量平衡。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Zone,方便进行维护|
15+
|`BALANCE LEADER`|在当前图空间内所有 Zone 之间启动任务均衡分布 leader。该命令会返回任务 ID|
16+
17+
查看、停止、重启任务,请参见[作业管理](4.job-statements.md)

docs-2.0/3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md

+42-12
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,43 @@
66

77
所有作业管理命令都需要先选择图空间后才能执行。
88

9+
## SUBMIT JOB BALANCE IN ZONE
10+
11+
`SUBMIT JOB BALANCE IN ZONE`语句会在当前图空间内每个 Zone 内部启动任务均衡分布分片。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Storage 节点,方便进行维护。
12+
13+
示例:
14+
15+
```ngql
16+
nebula> SUBMIT JOB BALANCE IN ZONE REMOVE 192.168.10.102:9779;
17+
+------------+
18+
| New Job Id |
19+
+------------+
20+
| 26 |
21+
+------------+
22+
```
23+
24+
## SUBMIT JOB BALANCE ACROSS ZONE
25+
26+
`SUBMIT JOB BALANCE ACROSS ZONE`语句会在当前图空间内所有 Zone 之间启动任务均衡分布分片,保证各个 Zone 分片数量平衡。该命令会返回任务 ID。可以使用`REMOVE`选项指定需要清空的 Zone,方便进行维护。
27+
28+
示例:
29+
30+
```ngql
31+
nebula> SUBMIT JOB BALANCE ACROSS ZONE REMOVE "zone1";
32+
+------------+
33+
| New Job Id |
34+
+------------+
35+
| 27 |
36+
+------------+
37+
```
38+
939
## SUBMIT JOB COMPACT
1040

11-
`SUBMIT JOB COMPACT` 语句会触发 RocksDB 的长耗时 `compact` 操作。
41+
`SUBMIT JOB COMPACT` 语句会在当前图空间内触发 RocksDB 的长耗时 `compact` 操作。
1242

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

15-
### 示例
45+
示例:
1646

1747
```ngql
1848
nebula> SUBMIT JOB COMPACT;
@@ -25,9 +55,9 @@ nebula> SUBMIT JOB COMPACT;
2555

2656
## SUBMIT JOB FLUSH
2757

28-
`SUBMIT JOB FLUSH`语句将内存中的 RocksDB memfile 写入硬盘。
58+
`SUBMIT JOB FLUSH`语句将当前图空间内存中的 RocksDB memfile 写入硬盘。
2959

30-
### 示例
60+
示例:
3161

3262
```ngql
3363
nebula> SUBMIT JOB FLUSH;
@@ -40,13 +70,13 @@ nebula> SUBMIT JOB FLUSH;
4070

4171
## SUBMIT JOB STATS
4272

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

4575
!!! Note
4676

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

49-
### 示例
79+
示例:
5080

5181
```ngql
5282
nebula> SUBMIT JOB STATS;
@@ -63,7 +93,7 @@ Meta 服务将`SUBMIT JOB`请求解析为多个任务,然后分配给进程 ne
6393

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

66-
### 示例
96+
示例:
6797

6898
```ngql
6999
nebula> SHOW JOB 34;
@@ -112,7 +142,7 @@ Queue -- running -- finished -- removed
112142

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

115-
### 示例
145+
示例:
116146

117147
```ngql
118148
nebula> SHOW JOBS;
@@ -129,9 +159,9 @@ nebula> SHOW JOBS;
129159

130160
## STOP JOB
131161

132-
`STOP JOB`语句可以停止当前图空间内未完成的作业。
162+
`STOP JOB <job_id>`语句可以停止当前图空间内未完成的作业。
133163

134-
### 示例
164+
示例:
135165

136166
```ngql
137167
nebula> STOP JOB 22;
@@ -144,9 +174,9 @@ nebula> STOP JOB 22;
144174

145175
## RECOVER JOB
146176

147-
`RECOVER JOB`语句会重新执行当前图空间内失败的作业,并返回已恢复的作业数量。
177+
`RECOVER JOB [<job_id>]`语句可以重新执行当前图空间内状态为`QUEUE``FAILED``STOPPED`的作业,未指定`<job_id>`时,会从最早的作业开始尝试重新执行,并返回已恢复的作业数量。
148178

149-
### 示例
179+
示例:
150180

151181
```ngql
152182
nebula> RECOVER JOB;

docs-2.0/4.deployment-and-installation/5.zone.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ nebula> SHOW ZONES;
5555

5656
!!! note
5757

58-
加入之后请使用 [BALANCE DATA](../3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md) 命令实现负载均衡。
58+
加入之后请使用 [BALANCE](../3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md) 命令实现负载均衡。
5959

6060
```ngql
6161
ADD HOSTS <ip>:<port> [,<ip>:<port> ...] INTO ZONE "<zone_name>";
@@ -118,6 +118,10 @@ DROP ZONE "<zone_name>";
118118

119119
合并时将检查所有图空间分片的分布情况,防止同一个分片的不同副本因为合并导致分布在同一个 Zone 中。
120120

121+
!!! note
122+
123+
合并之后请使用 [BALANCE](../3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md) 命令实现负载均衡。
124+
121125
```ngql
122126
MERGE ZONE "<zone_name>" [,"<zone_name>" ...] INTO "<new_zone_name>";
123127
```
@@ -134,7 +138,7 @@ MERGE ZONE "default_zone_192.168.10.100_9779","default_zone_192.168.10.101_9779"
134138

135139
!!! note
136140

137-
分离之后请使用 [BALANCE DATA](../3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md) 命令实现负载均衡。
141+
分离之后请使用 [BALANCE](../3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md) 命令实现负载均衡。
138142

139143
```ngql
140144
DIVIDE ZONE "<zone_name>" INTO "<new_zone_name>"(<ip>:<port>) ["<new_zone_name>"(<ip>:<port>) ...];

docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb
9797

9898
| 名称 | 预设值 | 说明 |
9999
| ------------------- | ------------------------ | ------------------------------------------ |
100-
| `system_memory_high_watermark_ratio` | - |内存高水位报警机制的触发阈值,默认为`0.9`。系统内存占用率高于该值会触发报警机制,Nebula Graph 会停止接受查询。|
100+
| `system_memory_high_watermark_ratio` | `0.8` |内存高水位报警机制的触发阈值。系统内存占用率高于该值会触发报警机制,Nebula Graph 会停止接受查询。|
101101

102102
## metrics 配置
103103

0 commit comments

Comments
 (0)