forked from vesoft-inc/nebula-docs-cn
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
742 lines (688 loc) · 36.4 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
site_name: NebulaGraph Database 手册
site_description: Documentation for NebulaGraph Database
site_author: NebulaGraph
site_url: https://docs.nebula-graph.com.cn/
repo_name: 'vesoft-inc/nebula-docs-cn'
repo_url: 'https://github.com/vesoft-inc/nebula-docs-cn'
docs_dir: docs-2.0
copyright: Copyright © 2022 NebulaGraph - 浙ICP备20010487号
# modify when release:
edit_uri: 'edit/master/docs-2.0/'
# Configuration
theme:
name: material
custom_dir: overrides
logo: 'https://cloud-cdn.nebula-graph.com.cn/vesoft-nebula-logo-white.png'
favicon: 'assets/images/favicon.ico'
# Change color in `stylesheets > extra.css`
palette:
- scheme: nebula
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.top
- header.autohide
- content.tabs.link
language: 'zh'
extra_css:
- stylesheets/logo.css
- stylesheets/note.css
- stylesheets/extra.css
- css/version-select.css
# Extensions
markdown_extensions:
- footnotes
- admonition
- codehilite:
guess_lang: false
- toc:
# toc_depth: 3
permalink: true
separator: "_"
- mdx_truly_sane_lists
- pymdownx.superfences
- pymdownx.snippets:
base_path: docs-2.0/reuse/
- pymdownx.arithmatex:
generic: true
- pymdownx.caret
- pymdownx.tilde
- pymdownx.superfences
- pymdownx.tabbed
# Plugins
plugins:
- search # 这个是原有的 mkdocs 搜索插件， 如果想使用algolia搜索，请注释掉这个插件
- macros:
include_dir: docs-2.0/reuse/
- git-revision-date-localized
# modify when release:
- exclude:
# Exclude files with unix-style wildcards (globs)
glob:
# Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`.
- nebula-flink/*
- CHANGELOG.md
- nebula-cloud/*
- spark-connector/*
- 4.deployment-and-installation/5.zone.md
- 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md
- nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
# 仅发布包含企业版功能的文档版本时，注释以下页面
# begin
# - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md
# - 4.deployment-and-installation/deploy-license.md
# - 5.configurations-and-logs/2.log-management/audit-log.md
# - 7.data-security/1.authentication/4.ldap.md
# - graph-computing/0.deploy-controller-analytics.md
# - graph-computing/nebula-analytics.md
# - graph-computing/use-explorer.md
# - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md
# - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md
# - synchronization-and-migration/replication-between-clusters.md
# - 20.appendix/8.about-license/
# - nebula-dashboard-ent/4.cluster-operator/operator/scale.md
# - 6.monitor-and-metrics/3.bbox
# end
# Exclude the file with the following file name.
# - abc.md
# Exclude files with regular expressions (regexes)
# regex:
# - '.*\.(tmp|bin|tar)$'
# modify when release:
- with-pdf:
copyright: 2022 vesoft Inc.
cover_subtitle: master
author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙
cover: true
back_cover: true
cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png'
output_path: pdf/NebulaGraph-CN.pdf
extra_javascript:
- js/version-select.js
- js/config.js
- js/jquery.js
- js/init.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# js about docs search logic
- https://www-cdn.nebula-graph.com.cn/nebula-docs/nebula-docs.7e772ed81c779cacbefc.js
# modify when release:
extra:
# Language selector.
alternate:
- name: English
link: https://docs.nebula-graph.io/
lang: en
# Google Analytics.
analytics:
provider: google
property: UA-60523578-7
# branch represents code names (git clone). release represents version number used in texts.
version:
method: mike
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/vesoft-inc/nebula-docs-cn'
nebula:
release: 3.3.0
nightly: nightly
master: master
base20: 2.0
base200: 2.0.0
branch: release-3.3
tag: v3.3.0
studio:
base111b: 1.1.1-beta
base220: 2.2.1
base300: 3.0.0
release: 3.5.0
tag: v3.5.0
explorer:
release: 3.2.0
branch: release-3.2
tag: v3.2.0
exchange_ent:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
exchange:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
importer:
release: 3.1.0
branch: release-3.1
tag: v3.1.0
algorithm:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
plato:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
sparkconnector:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
flinkconnector:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
dockercompose:
release: 3.2.0
branch: release-3.2
tag: v3.2.0
dashboard:
release: 3.2.0
tag: v3.2.0
base100: 1.0.0
branch: release-3.2
dashboard_ent:
release: 3.2.0
tag: v3.2.0
branch: release-3.2
console:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
br:
release: 0.6.1
branch: master
tag: v0.6.1
br_ent:
release: 0.7.0
tag: v0.7.0
agent:
release: 0.2.0
tag: v0.2.0
cpp:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
java:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
python:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
go:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
bench:
release: 1.2.0
branch: release-1.2
tag: v1.2.0
operator:
release: 1.3.0
tag: v1.3.0
branch: release-1.3
upgrade_from: 3.0.0
upgrade_to: 3.3.x
exporter:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
gateway:
release: 3.1.2
branch: release-3.1
tag: v3.1.2
bbox:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
cloud:
azureRelease: 3.1.1 # Azure云兼容的最新内核版本
aliyunRelease: 3.1.1 # 阿里云兼容的最新内核版本
azureLatestRelease: 3.1.0 # 支持Azure云的最新文档版本
aliyunLatestRelease: 3.1.0 # 支持阿里云的最新文档版本
ent:
ent_begin: <!-- --># 文档包含企业版时需补全该注释（<!-- -->），只包含社区版时只保留注释头（<!--）
ent_end: <!-- --> #文档包含企业版时需补全该注释（<!-- -->），只包含社区版时只保留注释尾（-->）
nav:
- 前言: README.md
- 简介:
- 图: 1.introduction/0-0-graph.md
- 图数据库: 1.introduction/0-1-graph-database.md
- 相关技术: 1.introduction/0-2.relates.md
- 什么是 NebulaGraph: 1.introduction/1.what-is-nebula-graph.md
- 数据模型: 1.introduction/2.data-model.md
- 路径: 1.introduction/2.1.path.md
- VID: 1.introduction/3.vid.md
- 服务架构:
- 架构总览: 1.introduction/3.nebula-graph-architecture/1.architecture-overview.md
- Meta 服务: 1.introduction/3.nebula-graph-architecture/2.meta-service.md
- Graph 服务: 1.introduction/3.nebula-graph-architecture/3.graph-service.md
- Storage 服务: 1.introduction/3.nebula-graph-architecture/4.storage-service.md
- 快速入门:
- 入门概览: 2.quick-start/1.quick-start-overview.md
- 从云开始（免费试用）:
- 步骤 1：创建云服务实例: 2.quick-start/2.quick-start-on-cloud/1.create-instance-on-cloud.md
- 步骤 2：连接 NebulaGraph: 2.quick-start/2.quick-start-on-cloud/2.connect-to-nebulagraph-on-cloud.md
- 步骤 3：管理数据: 2.quick-start/2.quick-start-on-cloud/3.how-to-query-on-cloud.md
- 本地部署:
- 步骤 1：安装 NebulaGraph: 2.quick-start/3.quick-start-on-premise/2.install-nebula-graph.md
- 步骤 2：启动 NebulaGraph: 2.quick-start/3.quick-start-on-premise/5.start-stop-service.md
- 步骤 3：连接 NebulaGraph: 2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md
- 步骤 4：注册 Storage 服务: 2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md
- 步骤 5：使用基本 nGQL 命令: 2.quick-start/3.quick-start-on-premise/4.nebula-graph-crud.md
- nGQL 命令汇总: 2.quick-start/6.cheatsheet-for-ngql-command.md
- nGQL 指南:
- nGQL 概述:
- 什么是 nGQL: 3.ngql-guide/1.nGQL-overview/1.overview.md
- 图模式: 3.ngql-guide/1.nGQL-overview/3.graph-patterns.md
- 注释: 3.ngql-guide/1.nGQL-overview/comments.md
- 大小写区分: 3.ngql-guide/1.nGQL-overview/identifier-case-sensitivity.md
- 关键字: 3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md
- nGQL 风格指南: 3.ngql-guide/1.nGQL-overview/ngql-style-guide.md
- 数据类型:
- 数值: 3.ngql-guide/3.data-types/1.numeric.md
- 布尔: 3.ngql-guide/3.data-types/2.boolean.md
- 字符串: 3.ngql-guide/3.data-types/3.string.md
- 日期时间: 3.ngql-guide/3.data-types/4.date-and-time.md
- NULL: 3.ngql-guide/3.data-types/5.null.md
- 列表: 3.ngql-guide/3.data-types/6.list.md
- 集合: 3.ngql-guide/3.data-types/7.set.md
- 映射: 3.ngql-guide/3.data-types/8.map.md
- 类型转换: 3.ngql-guide/3.data-types/9.type-conversion.md
- 地理位置: 3.ngql-guide/3.data-types/10.geography.md
- 变量和复合查询:
- 复合查询: 3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md
- 自定义变量: 3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md
- 引用属性: 3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md
- 运算符:
- 比较符: 3.ngql-guide/5.operators/1.comparison.md
- 布尔符: 3.ngql-guide/5.operators/2.boolean.md
- 管道符: 3.ngql-guide/5.operators/4.pipe.md
- 属性引用符: 3.ngql-guide/5.operators/5.property-reference.md
- 集合运算符: 3.ngql-guide/5.operators/6.set.md
- 字符串运算符: 3.ngql-guide/5.operators/7.string.md
- 列表运算符: 3.ngql-guide/5.operators/8.list.md
- 运算符优先级: 3.ngql-guide/5.operators/9.precedence.md
- 函数和表达式:
- 数学函数: 3.ngql-guide/6.functions-and-expressions/1.math.md
- 聚合函数: 3.ngql-guide/6.functions-and-expressions/15.aggregating.md
- 字符串函数: 3.ngql-guide/6.functions-and-expressions/2.string.md
- 日期时间函数: 3.ngql-guide/6.functions-and-expressions/3.date-and-time.md
- Schema 函数: 3.ngql-guide/6.functions-and-expressions/4.schema.md
- 列表函数: 3.ngql-guide/6.functions-and-expressions/6.list.md
- 类型转换函数: 3.ngql-guide/6.functions-and-expressions/16.type-conversion.md
- 条件表达式函数: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md
- 谓词函数: 3.ngql-guide/6.functions-and-expressions/8.predicate.md
- geo 函数: 3.ngql-guide/6.functions-and-expressions/14.geo.md
#ent
#ent - Elasticsearch 查询函数: 3.ngql-guide/6.functions-and-expressions/17.ES-function.md
- 自定义函数: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md
- 通用查询语句:
- MATCH: 3.ngql-guide/7.general-query-statements/2.match.md
- OPTIONAL MATCH: 3.ngql-guide/7.general-query-statements/optional-match.md
- LOOKUP: 3.ngql-guide/7.general-query-statements/5.lookup.md
- GO: 3.ngql-guide/7.general-query-statements/3.go.md
- FETCH: 3.ngql-guide/7.general-query-statements/4.fetch.md
- SHOW:
- SHOW CHARSET: 3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md
- SHOW COLLATION: 3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md
- SHOW CREATE SPACE: 3.ngql-guide/7.general-query-statements/6.show/4.show-create-space.md
- SHOW CREATE TAG/EDGE: 3.ngql-guide/7.general-query-statements/6.show/5.show-create-tag-edge.md
- SHOW HOSTS: 3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md
- SHOW INDEX STATUS: 3.ngql-guide/7.general-query-statements/6.show/7.show-index-status.md
- SHOW INDEXES: 3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md
- SHOW PARTS: 3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md
- SHOW ROLES: 3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md
- SHOW SNAPSHOTS: 3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md
- SHOW SPACES: 3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md
- SHOW STATS: 3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md
- SHOW TAGS/EDGES: 3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md
- SHOW USERS: 3.ngql-guide/7.general-query-statements/6.show/16.show-users.md
- SHOW SESSIONS: 3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md
- SHOW QUERIES: 3.ngql-guide/7.general-query-statements/6.show/18.show-queries.md
- SHOW META LEADER: 3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md
- 子句和选项:
- GROUP BY: 3.ngql-guide/8.clauses-and-options/group-by.md
- LIMIT and SKIP: 3.ngql-guide/8.clauses-and-options/limit.md
- SAMPLE: 3.ngql-guide/8.clauses-and-options/sample.md
- ORDER BY: 3.ngql-guide/8.clauses-and-options/order-by.md
- RETURN: 3.ngql-guide/8.clauses-and-options/return.md
- TTL: 3.ngql-guide/8.clauses-and-options/ttl-options.md
- WHERE: 3.ngql-guide/8.clauses-and-options/where.md
- 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
- 图空间语句:
- CREATE SPACE: 3.ngql-guide/9.space-statements/1.create-space.md
- USE SPACE: 3.ngql-guide/9.space-statements/2.use-space.md
- SHOW SPACES: 3.ngql-guide/9.space-statements/3.show-spaces.md
- DESCRIBE SPACE: 3.ngql-guide/9.space-statements/4.describe-space.md
- CLEAR SPACE: 3.ngql-guide/9.space-statements/6.clear-space.md
- DROP SPACE: 3.ngql-guide/9.space-statements/5.drop-space.md
- Tag 语句:
- CREATE TAG: 3.ngql-guide/10.tag-statements/1.create-tag.md
- DROP TAG: 3.ngql-guide/10.tag-statements/2.drop-tag.md
- ALTER TAG: 3.ngql-guide/10.tag-statements/3.alter-tag.md
- SHOW TAGS: 3.ngql-guide/10.tag-statements/4.show-tags.md
- DESCRIBE TAG: 3.ngql-guide/10.tag-statements/5.describe-tag.md
- DELETE TAG: 3.ngql-guide/10.tag-statements/6.delete-tag.md
- 增加和删除标签: 3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md
- Edge type 语句:
- CREATE EDGE: 3.ngql-guide/11.edge-type-statements/1.create-edge.md
- DROP EDGE: 3.ngql-guide/11.edge-type-statements/2.drop-edge.md
- ALTER EDGE: 3.ngql-guide/11.edge-type-statements/3.alter-edge.md
- SHOW EDGES: 3.ngql-guide/11.edge-type-statements/4.show-edges.md
- DESCRIBE EDGE: 3.ngql-guide/11.edge-type-statements/5.describe-edge.md
- 点语句:
- INSERT VERTEX: 3.ngql-guide/12.vertex-statements/1.insert-vertex.md
- DELETE VERTEX: 3.ngql-guide/12.vertex-statements/4.delete-vertex.md
- UPDATE VERTEX: 3.ngql-guide/12.vertex-statements/2.update-vertex.md
- UPSERT VERTEX: 3.ngql-guide/12.vertex-statements/3.upsert-vertex.md
- 边语句:
- INSERT EDGE: 3.ngql-guide/13.edge-statements/1.insert-edge.md
- DELETE EDGE: 3.ngql-guide/13.edge-statements/4.delete-edge.md
- UPDATE EDGE: 3.ngql-guide/13.edge-statements/2.update-edge.md
- UPSERT EDGE: 3.ngql-guide/13.edge-statements/3.upsert-edge.md
- 原生索引:
- 索引介绍: 3.ngql-guide/14.native-index-statements/README.md
- CREATE INDEX: 3.ngql-guide/14.native-index-statements/1.create-native-index.md
- SHOW INDEX: 3.ngql-guide/14.native-index-statements/2.show-native-indexes.md
- SHOW CREATE INDEX: 3.ngql-guide/14.native-index-statements/2.1.show-create-index.md
- DESCRIBE INDEX: 3.ngql-guide/14.native-index-statements/3.describe-native-index.md
- REBUILD INDEX: 3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md
- SHOW INDEX STATUS: 3.ngql-guide/14.native-index-statements/5.show-native-index-status.md
- DROP INDEX: 3.ngql-guide/14.native-index-statements/6.drop-native-index.md
- 全文索引:
# - 索引介绍: 3.ngql-guide/14.native-index-statements/README.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/2.deploy-es.md
- 部署 Raft listener: 4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md
- 全文搜索: 3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md
- 子图和路径:
- GET SUBGRAPH: 3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md
- FIND PATH: 3.ngql-guide/16.subgraph-and-path/2.find-path.md
- 查询调优与终止:
- EXPLAIN和PROFILE: 3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md
- 终止查询: 3.ngql-guide/17.query-tuning-statements/6.kill-query.md
- 作业管理: 3.ngql-guide/4.job-statements.md
- 安装部署:
- 准备资源: 4.deployment-and-installation/1.resource-preparations.md
- 编译与安装:
- 使用源码安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
- 使用 RPM/DEB 包安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
- 使用 tar.gz 文件安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- 使用 Docker Compose 部署: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- 使用 RPM/DEB 包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
- 安装存算合并版 NebulaGraph: 4.deployment-and-installation/standalone-deployment.md
#ent
#ent - 设置 NebulaGraph 企业版 License: 4.deployment-and-installation/deploy-license.md
- 管理服务: 4.deployment-and-installation/manage-service.md
- 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md
- 管理 Storage 主机: 4.deployment-and-installation/manage-storage-host.md
# - 管理逻辑机架（Zone）: 4.deployment-and-installation/5.zone.md
- 升级版本:
- 升级 NebulaGraph 版本: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md
- 升级 v3.0.x 至当前版本: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md
- 卸载 NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md
- 配置与日志:
- 配置:
- 配置管理: 5.configurations-and-logs/1.configurations/1.configurations.md
- Meta 服务配置: 5.configurations-and-logs/1.configurations/2.meta-config.md
- Graph 服务配置: 5.configurations-and-logs/1.configurations/3.graph-config.md
- Storage 服务配置: 5.configurations-and-logs/1.configurations/4.storage-config.md
- Linux 内核配置: 5.configurations-and-logs/1.configurations/6.kernel-config.md
- 日志:
- 运行日志: 5.configurations-and-logs/2.log-management/logs.md
#ent
#ent - 审计日志（企业版）: 5.configurations-and-logs/2.log-management/audit-log.md
- 监控:
- 查询 NebulaGraph 监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md
- RocksDB 统计数据: 6.monitor-and-metrics/2.rocksdb-statistics.md
#ent
#ent - 黑匣子:
#ent - 黑匣子介绍: 6.monitor-and-metrics/3.bbox/3.1.bbox.md
#ent - Nebula-BBox 工具: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md
- 数据安全:
- 验证和授权:
- 身份验证: 7.data-security/1.authentication/1.authentication.md
- 用户管理: 7.data-security/1.authentication/2.management-user.md
- 内置角色权限: 7.data-security/1.authentication/3.role-list.md
#ent
#ent - OpenLDAP 验证: 7.data-security/1.authentication/4.ldap.md
- SSL 加密: 7.data-security/4.ssl.md
- 备份与恢复:
- NebulaGraph BR（社区版）:
- BR（社区版）概述: backup-and-restore/nebula-br/1.what-is-br.md
- 编译 BR: backup-and-restore/nebula-br/2.compile-br.md
- 使用 BR 备份数据: backup-and-restore/nebula-br/3.br-backup-data.md
- 使用 BR 恢复数据: backup-and-restore/nebula-br/4.br-restore-data.md
- NebulaGraph BR（企业版）:
- BR（企业版）概述: backup-and-restore/nebula-br-ent/1.br-ent-overview.md
- 安装 BR: backup-and-restore/nebula-br-ent/2.install-tools.md
- 使用 BR 备份数据: backup-and-restore/nebula-br-ent/3.backup-data.md
- 使用 BR 恢复数据: backup-and-restore/nebula-br-ent/4.restore-data.md
- 快照: backup-and-restore/3.manage-snapshot.md
- 同步与迁移:
- 负载均衡: synchronization-and-migration/2.balance-syntax.md
#ent
#ent - 集群间数据同步: synchronization-and-migration/replication-between-clusters.md
- 最佳实践:
- Compaction: 8.service-tuning/compaction.md
- Storage 负载均衡: 8.service-tuning/load-balance.md
- 图建模: 8.service-tuning/2.graph-modeling.md
- 系统建模: 8.service-tuning/3.system-design.md
- 执行计划: 8.service-tuning/4.plan.md
- 超级节点(稠密点): 8.service-tuning/super-node.md
- 实践案例: 8.service-tuning/practice.md
- 客户端:
- 客户端介绍: 14.client/1.nebula-client.md
- NebulaGraph Console: nebula-console.md
- NebulaGraph CPP: 14.client/3.nebula-cpp-client.md
- NebulaGraph Java: 14.client/4.nebula-java-client.md
- NebulaGraph Python: 14.client/5.nebula-python-client.md
- NebulaGraph Go: 14.client/6.nebula-go-client.md
- NebulaGraph Cloud: nebula-cloud.md
#ent
# - NebulaGraph Cloud:
# - 什么是 NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md
# - NebulaGraph Cloud Azure版:
# - 创建订阅: nebula-cloud/nebula-cloud-on-azure/2.how-to-create-subsciption.md
# - 配置Solution: nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md
# - Cloud Solution 角色身份说明: nebula-cloud/nebula-cloud-on-azure/4.user-role-description.md
# - Solution 操作:
# - Solution: nebula-cloud/nebula-cloud-on-azure/5.solution/5.0.introduce-solution.md
# - 配套的应用（Dashboard/Studio/Explorer）: nebula-cloud/nebula-cloud-on-azure/5.solution/5.1.supporting-application.md
# - Private Link: nebula-cloud/nebula-cloud-on-azure/5.solution/5.2.connection-configuration-and-use.md
# - 管理角色权限: nebula-cloud/nebula-cloud-on-azure/5.solution/5.3.role-and-authority-management.md
# - 价格: nebula-cloud/nebula-cloud-on-azure/6.pricing.md
# - 用户服务条款: nebula-cloud/nebula-cloud-on-azure/7.terms-and-conditions.md
# - 隐私政策条款: nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md
# - NebulaGraph Cloud 阿里云版:
# - 创建服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md
# - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md
# - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md
- NebulaGraph Studio:
- 认识 NebulaGraph Studio:
- 什么是 NebulaGraph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
- 使用限制: nebula-studio/about-studio/st-ug-limitations.md
- 安装与登录:
- 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- 使用 Helm 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
- 连接数据库: nebula-studio/deploy-connect/st-ug-connect.md
- 快速开始:
- 规划 Schema: nebula-studio/quick-start/st-ug-plan-schema.md
- 创建 Schema: nebula-studio/quick-start/st-ug-create-schema.md
- 导入数据: nebula-studio/quick-start/st-ug-import-data.md
- 控制台界面: nebula-studio/quick-start/st-ug-console.md
- 管理Schema:
- 操作图空间: nebula-studio/manage-schema/st-ug-crud-space.md
- 操作 Tag: nebula-studio/manage-schema/st-ug-crud-tag.md
- 操作 Edge type: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- 操作索引: nebula-studio/manage-schema/st-ug-crud-index.md
- Schema 草图: nebula-studio/quick-start/draft.md
- 故障排查:
- 连接数据库错误: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
- Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md
- NebulaGraph Dashboard（社区版）:
- 什么是NebulaGraph Dashboard: nebula-dashboard/1.what-is-dashboard.md
- 部署 Dashboard: nebula-dashboard/2.deploy-dashboard.md
- 连接 Dashboard: nebula-dashboard/3.connect-dashboard.md
- Dashboard 页面介绍: nebula-dashboard/4.use-dashboard.md
- 监控指标说明: nebula-dashboard/6.monitor-parameter.md
- NebulaGraph Dashboard（企业版）:
- 什么是 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/1.what-is-dashboard-ent.md
- 部署 NebulaGraph Dashboard 企业版: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
- NebulaGraph Dashboard 企业版 License: nebula-dashboard-ent/11.dashboard-ent-license.md
- 创建及导入集群:
- 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md
- 导入集群: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md
- 集群管理:
- 集群总览: nebula-dashboard-ent/4.cluster-operator/1.overview.md
- 集群监控: nebula-dashboard-ent/4.cluster-operator/2.monitor.md
- 通知: nebula-dashboard-ent/4.cluster-operator/9.notification.md
- 集群信息:
- 信息总览: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md
- 集群诊断: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md
# - 集群作业管理: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
- 备份恢复: nebula-dashboard-ent/4.cluster-operator/cluster-information/backup-and-restore.md
- 集群操作:
- 节点管理: nebula-dashboard-ent/4.cluster-operator/operator/node.md
- 扩缩容: nebula-dashboard-ent/4.cluster-operator/operator/scale.md
- 服务管理: nebula-dashboard-ent/4.cluster-operator/operator/service.md
- 更新配置: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md
- 成员管理: nebula-dashboard-ent/4.cluster-operator/operator/member-management.md
- 版本升级: nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md
- 操作记录: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md
- 其他设置: nebula-dashboard-ent/4.cluster-operator/6.settings.md
- 权限管理: nebula-dashboard-ent/5.account-management.md
- 任务中心: nebula-dashboard-ent/10.tasks.md
- 平台设置:
- 系统设置: nebula-dashboard-ent/system-settings/system-settings.md
- 通知设置: nebula-dashboard-ent/system-settings/notification-endpoint.md
- 单点登录: nebula-dashboard-ent/system-settings/single-sign-on.md
- 安装包管理: nebula-dashboard-ent/system-settings/manage-package.md
- 其他设置: nebula-dashboard-ent/system-settings/other-settings.md
- 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md
- 常见问题 FAQ: nebula-dashboard-ent/8.faq.md
- NebulaGraph Explorer:
- 什么是 NebulaGraph Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md
- 安装与登录:
- 部署 Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md
- 连接数据库: nebula-explorer/deploy-connect/ex-ug-connect.md
- NebulaGraph Explorer License（企业版）: nebula-explorer/deploy-connect/3.explorer-license.md
- 页面概览: nebula-explorer/ex-ug-page-overview.md
- 数据库管理:
- Schema 草图: nebula-explorer/db-management/draft.md
- Schema 管理: nebula-explorer/db-management/10.create-schema.md
- 数据导入: nebula-explorer/db-management/11.import-data.md
- 控制台: nebula-explorer/db-management/explorer-console.md
- 查询语句模板: nebula-explorer/db-management/ngql-template.md
- 数据库用户管理: nebula-explorer/db-management/dbuser_management.md
- 图探索:
- 选择图空间: nebula-explorer/graph-explorer/13.choose-graphspace.md
- 开始探索: nebula-explorer/graph-explorer/ex-ug-query-exploration.md
- 节点筛选: nebula-explorer/graph-explorer/node-filtering.md
- 探索拓展: nebula-explorer/graph-explorer/ex-ug-graph-exploration.md
- 图计算: nebula-explorer/graph-explorer/graph-algorithm.md
- 属性计算: nebula-explorer/graph-explorer/property-calculation.md
- 可视化查询: nebula-explorer/12.query-visually.md
- 画布功能:
- 画布概览: nebula-explorer/canvas-operations/canvas-overview.md
- 可视化模式: nebula-explorer/canvas-operations/visualization-mode.md
- 画布快照: nebula-explorer/canvas-operations/canvas-snapshot.md
- 工作流:
- 工作流简介: nebula-explorer/workflow/workflows.md
- 资源配置: nebula-explorer/workflow/1.prepare-resources.md
- 工作流示例: nebula-explorer/workflow/2.create-workflow.md
- 工作流管理: nebula-explorer/workflow/3.workflow-management.md
- 作业管理: nebula-explorer/workflow/4.jobs-management.md
- 工作流 API:
- 新增作业: nebula-explorer/workflow/workflow-api/api-post-jobs.md
- 获取所有作业列表: nebula-explorer/workflow/workflow-api/api-get-jobs.md
- 获取指定工作流的作业列表: nebula-explorer/workflow/workflow-api/api-get-workflow-jobs.md
- 查询指定作业详情: nebula-explorer/workflow/workflow-api/api-desc-job.md
- 取消作业运行: nebula-explorer/workflow/workflow-api/api-cancel-job.md
- 获取指定任务的运行结果数据: nebula-explorer/workflow/workflow-api/api-desc-task.md
- 内联框架: nebula-explorer/iframe.md
- 基本操作和快捷键: nebula-explorer/ex-ug-shortcuts.md
- 常见问题 FAQ: nebula-explorer/faq.md
- NebulaGraph Importer:
- 使用 NebulaGraph Importer: nebula-importer/use-importer.md
- 有表头配置说明: nebula-importer/config-with-header.md
- 无表头配置说明: nebula-importer/config-without-header.md
- NebulaGraph Exchange:
- 认识 NebulaGraph Exchange:
- 什么是 NebulaGraph Exchange: nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
- 使用限制: nebula-exchange/about-exchange/ex-ug-limitations.md
- 获取 NebulaGraph Exchange: nebula-exchange/ex-ug-compile.md
- 参数说明:
- 导入命令参数: nebula-exchange/parameter-reference/ex-ug-para-import-command.md
- 配置参数: nebula-exchange/parameter-reference/ex-ug-parameter.md
- 使用 NebulaGraph Exchange:
- 导入 CSV 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-csv.md
- 导入 JSON 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-json.md
- 导入 ORC 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-orc.md
- 导入 Parquet 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-parquet.md
- 导入 HBase 数据: nebula-exchange/use-exchange/ex-ug-import-from-hbase.md
- 导入 MySQL/PostgreSQL 数据: nebula-exchange/use-exchange/ex-ug-import-from-mysql.md
- 导入 Oracle 数据: nebula-exchange/use-exchange/ex-ug-import-from-oracle.md
- 导入 ClickHouse 数据: nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md
- 导入 Neo4j 数据: nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
- 导入 Hive 数据: nebula-exchange/use-exchange/ex-ug-import-from-hive.md
- 导入 MaxCompute 数据: nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md
- 导入 Pulsar 数据: nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md
- 导入 Kafka 数据: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md
- 导入通用 JDBC 数据: nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md
- 导入 SST 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-sst.md
- 导出 NebulaGraph 数据: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md
- Exchange 常见问题: nebula-exchange/ex-ug-FAQ.md
- NebulaGraph Operator:
- 什么是 NebulaGraph Operator: nebula-operator/1.introduction-to-nebula-operator.md
- 使用流程: nebula-operator/6.get-started-with-operator.md
- 部署 NebulaGraph Operator: nebula-operator/2.deploy-nebula-operator.md
- 部署 NebulaGraph集群:
- 使用 Kubectl 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
- 使用 Helm 部署 NebulaGraph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
- 配置 NebulaGraph 集群:
- 自定义 NebulaGraph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md
- 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md
#ent
#ent - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md
- 升级 NebulaGraph 集群: nebula-operator/9.upgrade-nebula-cluster.md
- 连接 NebulaGraph 数据库: nebula-operator/4.connect-to-nebula-graph-service.md
- 故障自愈: nebula-operator/5.operator-failover.md
- 常见问题: nebula-operator/7.operator-faq.md
- 图计算:
- 算法简介: graph-computing/algorithm-description.md
- NebulaGraph Algorithm: graph-computing/nebula-algorithm.md
- NebulaGraph Analytics: graph-computing/nebula-analytics.md
- NebulaGraph Analytics License: graph-computing/analytics-ent-license.md
- NebulaGraph Explorer 工作流: graph-computing/use-explorer.md
- NebulaGraph Spark Connector: nebula-spark-connector.md
- NebulaGraph Flink Connector: nebula-flink-connector.md
- NebulaGraph Bench: nebula-bench.md
- 附录:
- Release Note:
- NebulaGraph 社区版: 20.appendix/release-notes/nebula-comm-release-note.md
- NebulaGraph 企业版: 20.appendix/release-notes/nebula-ent-release-note.md
- NebulaGraph Studio: 20.appendix/release-notes/studio-release-note.md
- NebulaGraph Dashboard 社区版: 20.appendix/release-notes/dashboard-comm-release-note.md
- NebulaGraph Dashboard 企业版: 20.appendix/release-notes/dashboard-ent-release-note.md
- NebulaGraph Explorer: 20.appendix/release-notes/explorer-release-note.md
- 学习路径: 20.appendix/learning-path.md
#ent
#ent - 关于 License: 20.appendix/8.about-license.md
- 常见问题 FAQ: 20.appendix/0.FAQ.md
- 生态工具概览: 20.appendix/6.eco-tool-version.md
- 导入工具选择: 20.appendix/write-tools.md
- 社区参与: 15.contribution/how-to-contribute.md
- 年表: 20.appendix/history.md
- 思维导图: 20.appendix/mind-map.md
- 错误码: 20.appendix/error-code.md
- PDF: ./pdf/NebulaGraph-CN.pdf