forked from vesoft-inc/nebula-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
1009 lines (922 loc) · 51.6 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
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Project information
site_description: Documentation for NebulaGraph Database
site_author: NebulaGraph
# en.begin
site_name: NebulaGraph Database Manual
site_url: https://docs.nebula-graph.io/
docs_dir: docs-2.0-en
copyright: Copyright © 2023 NebulaGraph
# Modify this line in each version upgrade release
edit_uri: 'https://github.com/vesoft-inc/nebula-docs/edit/master/docs-2.0-en/'
# en.end
# zh.begin
site_name: NebulaGraph Database 手册
site_url: https://docs.nebula-graph.com.cn/
docs_dir: docs-2.0-zh
# Modify this line in each version upgrade release
edit_uri: 'https://github.com/vesoft-inc/nebula-docs/edit/master/docs-2.0-zh/'
copyright: Copyright © 2023 NebulaGraph - 浙ICP备20010487号
# zh.end
repo_name: 'vesoft-inc/nebula'
repo_url: 'https://github.com/vesoft-inc/nebula'
theme:
name: material
# zh.begin
custom_dir: docs-2.0-zh/overrides
# zh.end
# en.begin
custom_dir: docs-2.0-en/overrides
# en.end
font:
code: Source Code Pro
# zh.begin
text: Noto Sans Simplified Chinese
# zh.end
# en.begin
text: Noto Sans
# en.end
# git repo icon
icon:
repo: fontawesome/brands/github
# icon of the edit button
edit: material/pencil
logo: 'https://docs-cdn.nebula-graph.com.cn/figures/vesoft-nebula-logo-white22-12-21.png'
favicon: 'https://docs-cdn.nebula-graph.com.cn/figures/favicon.ico'
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
# enable code actions
- content.action.edit
- content.code.copy
- announce.dismiss
# zh.begin
language: 'zh'
# zh.end
# en.begin
language: 'en'
# en.end
extra_css:
- stylesheets/logo.css
- stylesheets/note.css
- stylesheets/extra.css
# - css/version-select.css
- stylesheets/pdf.css
# Extensions
markdown_extensions:
- footnotes
- admonition
- codehilite:
guess_lang: false
- toc:
permalink: true
separator: "_"
# toc_depth: 1
- mdx_truly_sane_lists
- pymdownx.superfences
- pymdownx.snippets:
# en.begin
base_path: docs-2.0-en/reuse/
# en.end
# zh.begin
base_path: docs-2.0-zh/reuse/
# zh.end
- pymdownx.arithmatex:
generic: true
- pymdownx.caret
- pymdownx.tilde
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# collapse content
- pymdownx.details
# Plugins
plugins:
# image lightbox plugin（https://github.com/blueswen/mkdocs-glightbox#usage）
- glightbox:
zoomable: true
- search # This is the original mkdocs search plugin. To use algolia search, comment out this plugin.
- macros:
# zh.begin
include_dir: docs-2.0-zh/reuse/
# zh.end
# en.begin
include_dir: docs-2.0-en/reuse/
# en.end
- git-revision-date-localized
- 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/*`.
- CHANGELOG.md
# - nebula-cloud/*
- nebula-cloud.md
- nebula-cloud/nebula-cloud-on-azure/*
- 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md
- nebula-cloud/1.what-is-cloud.md
- 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
- nebula-cloud/nebula-cloud-on-alibabacloud/4.scaling-services.md
- 20.appendix/learning-path.md
- with-pdf:
copyright: 2023 Vesoft Inc.
cover_subtitle: master
cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png'
cover: true
back_cover: true
# en.begin
output_path: pdf/NebulaGraph-EN.pdf
# en.end
# zh.begin
output_path: pdf/NebulaGraph-CN.pdf
# zh.end
extra_javascript:
- js/jquery.js
- js/search.js
- js/config.js
# - js/version-select.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- js/hotjar.js
- https://www-cdn.nebula-graph.io/nebula-docs/nebula-docs.7e772ed81c779cacbefc.js
extra:
# Language selector.
alternate:
# en.begin
- name: 中文
link: https://docs.nebula-graph.com.cn/
lang: zh
# en.end
# zh.begin
- name: English
link: https://docs.nebula-graph.io/
lang: en
# zh.end
analytics:
provider: google
# en.begin
property: G-377962831
# en.end
# zh.begin
property: G-385096931
# zh.end
# branch represents code names (git clone). release represents version number used in texts.
version:
provider: mike
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/vesoft-inc/nebula-docs'
nebula:
release: master
nightly: nightly
master: master
base20: 2.0
base200: 2.0.0
branch: release-3.6
tag: master
name: NebulaGraph
studio:
base111b: 1.1.1-beta
base220: 2.2.1
base300: 3.0.0
release: 3.9.0
tag: v3.9.0
exchange:
release: 3.7.0
branch: release-3.7
tag: v3.7.0
importer:
release: 4.1.0
branch: release-4.1
tag: v4.1.0
algorithm:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
sparkconnector:
release: 3.6.0
branch: release-3.6
tag: v3.6.0
flinkconnector:
release: 3.5.0
branch: release-3.5
tag: v3.5.0
dockercompose:
release: 3.6.0
branch: release-3.6
tag: v3.6.0
dashboard:
release: 3.4.0
tag: v3.4.0
base100: 1.0.0
branch: release-3.4
console:
release: 3.6.0
branch: release-3.6
tag: v3.6.0
br:
release: 3.6.0
branch: release-3.6
tag: v3.6.0
agent:
release: 3.7.0
tag: v3.7.0
cpp:
release: 3.4.0
branch: release-3.4
tag: v3.4.0
java:
release: 3.6.1
branch: release-3.6
tag: v3.6.1
python:
release: 3.4.0
branch: release-3.4
tag: v3.4.0
go:
release: 3.7.0
branch: release-3.7
tag: v3.7.0
bench:
release: 1.2.0
branch: release-1.2
tag: v1.2.0
operator:
release: 1.7.5
tag: v1.7.5
branch: release-1.7
upgrade_from: 3.5.0
upgrade_to: 3.6.0
exporter:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
gateway:
release: 3.4.0
branch: release-3.4
tag: v3.4.0
cloud:
azureRelease: 3.1.1 # The latest core version that Azure Cloud is compatible with
aliyunRelease: 3.1.1 # The latest core version that Alibaba Cloud is compatible with
azureLatestRelease: 3.1.0 # The latest doc version that supports Azure Cloud
aliyunLatestRelease: 3.1.0 # The latest doc version that supports Alibaba Cloud
nav:
# en.begin
- About: README.md
- Introduction:
- What is NebulaGraph: 1.introduction/1.what-is-nebula-graph.md
- Data model: 1.introduction/2.data-model.md
- Path: 1.introduction/2.1.path.md
- VID: 1.introduction/3.vid.md
- NebulaGraph architecture:
- Architecture overview: 1.introduction/3.nebula-graph-architecture/1.architecture-overview.md
- Meta Service: 1.introduction/3.nebula-graph-architecture/2.meta-service.md
- Graph Service: 1.introduction/3.nebula-graph-architecture/3.graph-service.md
- Storage Service: 1.introduction/3.nebula-graph-architecture/4.storage-service.md
- Quick start:
- Deploy NebulaGraph using Docker: 2.quick-start/1.quick-start-workflow.md
- Deploy NebulaGraph on-premise:
- Step 1 Install NebulaGraph: 2.quick-start/2.install-nebula-graph.md
- Step 2 Manage NebulaGraph Service: 2.quick-start/5.start-stop-service.md
- Step 3 Connect to NebulaGraph: 2.quick-start/3.connect-to-nebula-graph.md
- Step 4 Register the Storage Service: 2.quick-start/3.1add-storage-hosts.md
- Step 5 Use nGQL (CRUD): 2.quick-start/4.nebula-graph-crud.md
- nGQL cheatsheet: 2.quick-start/6.cheatsheet-for-ngql.md
- nGQL guide:
- nGQL overview:
- Overview: 3.ngql-guide/1.nGQL-overview/1.overview.md
- Graph patterns: 3.ngql-guide/1.nGQL-overview/3.graph-patterns.md
- Comments: 3.ngql-guide/1.nGQL-overview/comments.md
- Identifier case sensitivity: 3.ngql-guide/1.nGQL-overview/identifier-case-sensitivity.md
- Keywords: 3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md
- nGQL style guide: 3.ngql-guide/1.nGQL-overview/ngql-style-guide.md
- Data types:
- Numeric: 3.ngql-guide/3.data-types/1.numeric.md
- Boolean: 3.ngql-guide/3.data-types/2.boolean.md
- String: 3.ngql-guide/3.data-types/3.string.md
- Date and time: 3.ngql-guide/3.data-types/4.date-and-time.md
- Null: 3.ngql-guide/3.data-types/5.null.md
- List: 3.ngql-guide/3.data-types/6.list.md
- Set: 3.ngql-guide/3.data-types/7.set.md
- Map: 3.ngql-guide/3.data-types/8.map.md
- Type conversion: 3.ngql-guide/3.data-types/9.type-conversion.md
- Geography: 3.ngql-guide/3.data-types/10.geography.md
- Operators:
- Comparison: 3.ngql-guide/5.operators/1.comparison.md
- Boolean: 3.ngql-guide/5.operators/2.boolean.md
- Pipe: 3.ngql-guide/5.operators/4.pipe.md
- Set: 3.ngql-guide/5.operators/6.set.md
- String: 3.ngql-guide/5.operators/7.string.md
- List: 3.ngql-guide/5.operators/8.list.md
- Arithmetic: 3.ngql-guide/5.operators/10.arithmetic.md
- Precedence: 3.ngql-guide/5.operators/9.precedence.md
- Functions and expressions:
- Math functions: 3.ngql-guide/6.functions-and-expressions/1.math.md
- Aggregate functions: 3.ngql-guide/6.functions-and-expressions/15.aggregating.md
- String functions: 3.ngql-guide/6.functions-and-expressions/2.string.md
- Date and time functions: 3.ngql-guide/6.functions-and-expressions/3.date-and-time.md
- Schema functions: 3.ngql-guide/6.functions-and-expressions/4.schema.md
- List functions: 3.ngql-guide/6.functions-and-expressions/6.list.md
- Type conversion functions: 3.ngql-guide/6.functions-and-expressions/16.type-conversion.md
- Conditional expressions: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md
- Predicate functions: 3.ngql-guide/6.functions-and-expressions/8.predicate.md
- Geography functions: 3.ngql-guide/6.functions-and-expressions/14.geo.md
# - User-defined functions: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md
- General queries statements:
- Overview: 3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.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 CONFIGS: 3.ngql-guide/7.general-query-statements/6.show/3.show-configs.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
- FIND PATH: 3.ngql-guide/7.general-query-statements/6.find-path.md
- GET SUBGRAPH: 3.ngql-guide/7.general-query-statements/7.get-subgraph.md
- Clauses and options:
- 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
- INNER JOIN: 3.ngql-guide/8.clauses-and-options/joins.md
- Variables and composite queries:
- Composite queries: 3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md
- User-defined variables: 3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md
- Property references: 3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md
- Space statements:
- 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 statements:
- CREATE TAG: 3.ngql-guide/10.tag-statements/1.create-tag.md
- DROP TAGS: 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
- Add or delete tag: 3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md
- Edge type statements:
- 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
- Vertex statements:
- 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
- Edge statements:
- 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
- Native index statements:
- Index overview: 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
- Full-text index statements:
# - Index overview: 3.ngql-guide/14.native-index-statements/README.md
- Full-text restrictions: 4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md
- Deploy Elasticsearch cluster: 4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md
- Deploy Raft Listener cluster: 4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md
- Search with full-text index: 3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md
- Query tuning and terminating statements:
- EXPLAIN and PROFILE: 3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md
- Kill queries: 3.ngql-guide/17.query-tuning-statements/6.kill-query.md
- Kill sessions: 3.ngql-guide/17.query-tuning-statements/2.kill-session.md
- Job statements: 3.ngql-guide/4.job-statements.md
- Deploy and install:
- Resource preparations: 4.deployment-and-installation/1.resource-preparations.md
- Compile and install:
- Compile the source: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
- Compile using Docker: 4.deployment-and-installation/2.compile-and-install-nebula-graph/7.compile-using-docker.md
- Local single-node installation:
- Install using RPM or DEB package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
- Install using TAR package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- Install standalone NebulaGraph: 4.deployment-and-installation/standalone-deployment.md
- Local multi-node installation: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- Install using Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- Install with ecosystem tools: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
- Manage Service: 4.deployment-and-installation/manage-service.md
- Connect to Service: 4.deployment-and-installation/connect-to-nebula-graph.md
- Manage Storage host: 4.deployment-and-installation/manage-storage-host.md
- Upgrade: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-comm.md
- Uninstall NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md
- Configure and log:
- Configurations:
- Configurations: 5.configurations-and-logs/1.configurations/1.configurations.md
- Meta Service configurations: 5.configurations-and-logs/1.configurations/2.meta-config.md
- Graph Service configurations: 5.configurations-and-logs/1.configurations/3.graph-config.md
- Storage Service configurations: 5.configurations-and-logs/1.configurations/4.storage-config.md
- Kernel configurations: 5.configurations-and-logs/1.configurations/6.kernel-config.md
- Log management:
- Runtime logs: 5.configurations-and-logs/2.log-management/logs.md
- Monitor:
- Query NebulaGraph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md
- RocksDB Statistics: 6.monitor-and-metrics/2.rocksdb-statistics.md
- Data security:
- Authentication and authorization:
- Authentication: 7.data-security/1.authentication/1.authentication.md
- User management: 7.data-security/1.authentication/2.management-user.md
- Roles and privileges: 7.data-security/1.authentication/3.role-list.md
- SSL: 7.data-security/4.ssl.md
- Backup and restore:
- NebulaGraph BR Community:
- What is BR Community: backup-and-restore/nebula-br/1.what-is-br.md
- Install BR: backup-and-restore/nebula-br/2.compile-br.md
- Use BR to back up data: backup-and-restore/nebula-br/3.br-backup-data.md
- Use BR to restore data: backup-and-restore/nebula-br/4.br-restore-data.md
- Manage snapshots: backup-and-restore/3.manage-snapshot.md
- Synchronize and migrate:
- Load balance: synchronization-and-migration/2.balance-syntax.md
- Import and export:
- Overview: import-export/write-tools.md
- Use NebulaGraph Importer: import-export/use-importer.md
- NebulaGraph Exchange:
- Introduction:
- What is NebulaGraph Exchange: import-export/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
- Limitations: import-export/nebula-exchange/about-exchange/ex-ug-limitations.md
- Get Exchange: import-export/nebula-exchange/ex-ug-compile.md
- Exchange configurations:
- Options for import: import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md
- Parameters in the configuration file: import-export/nebula-exchange/parameter-reference/ex-ug-parameter.md
- Use NebulaGraph Exchange:
- Import data from CSV files: import-export/nebula-exchange/use-exchange/ex-ug-import-from-csv.md
- Import data from JSON files: import-export/nebula-exchange/use-exchange/ex-ug-import-from-json.md
- Import data from ORC files: import-export/nebula-exchange/use-exchange/ex-ug-import-from-orc.md
- Import data from Parquet files: import-export/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md
- Import data from HBase: import-export/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md
- Import data from MySQL/PostgreSQL: import-export/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md
- Import data from Oracle: import-export/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md
- Import data from ClickHouse: import-export/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md
- Import data from Neo4j: import-export/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
- Import data from Hive: import-export/nebula-exchange/use-exchange/ex-ug-import-from-hive.md
- Import data from MaxCompute: import-export/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md
- Import data from Pulsar: import-export/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md
- Import data from Kafka: import-export/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md
- Import data from JDBC: import-export/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md
- Import data from SST files: import-export/nebula-exchange/use-exchange/ex-ug-import-from-sst.md
- Exchange FAQ: import-export/nebula-exchange/ex-ug-FAQ.md
- Connectors:
- NebulaGraph Spark Connector: connector/nebula-spark-connector.md
- NebulaGraph Flink Connector: connector/nebula-flink-connector.md
- Best practices:
- Compaction: 8.service-tuning/compaction.md
- Storage load balance: 8.service-tuning/load-balance.md
- Modeling suggestions: 8.service-tuning/2.graph-modeling.md
- System design suggestions: 8.service-tuning/3.system-design.md
- Execution plan: 8.service-tuning/4.plan.md
- Processing super vertices: 8.service-tuning/super-node.md
- Enable AutoFDO: 8.service-tuning/enable_autofdo_for_nebulagraph.md
- Best practices: 8.service-tuning/practice.md
- Clients:
- Clients overview: 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
- Studio:
- About NebulaGraph Studio:
- What is NebulaGraph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
- Limitations: nebula-studio/about-studio/st-ug-limitations.md
- Deploy and connect:
- Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- Connect to NebulaGraph: nebula-studio/deploy-connect/st-ug-connect.md
- Quick start:
- Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
- Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
- Import data: nebula-studio/quick-start/st-ug-import-data.md
- Use Console: nebula-studio/quick-start/st-ug-console.md
- Use Schema:
- Manage graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
- Manage tags: nebula-studio/manage-schema/st-ug-crud-tag.md
- Manage edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- Manage indexes: nebula-studio/manage-schema/st-ug-crud-index.md
- View schema: nebula-studio/manage-schema/st-ug-view-schema.md
- Schema drafting: nebula-studio/quick-start/draft.md
- Global settings: nebula-studio/system-settings.md
- Troubleshooting:
- Database connection error: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- Unable to access Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
- FAQ: nebula-studio/troubleshooting/st-ug-faq.md
- Dashboard (Community):
- What is NebulaGraph Dashboard: nebula-dashboard/1.what-is-dashboard.md
- Deploy Dashboard: nebula-dashboard/2.deploy-dashboard.md
- Connect to Dashboard: nebula-dashboard/3.connect-dashboard.md
- Use Dashboard: nebula-dashboard/4.use-dashboard.md
- Monitoring metrics: nebula-dashboard/6.monitor-parameter.md
- NebulaGraph Operator:
- What is NebulaGraph Operator: k8s-operator/1.introduction-to-nebula-operator.md
- Getting started:
- Install NebulaGraph Operator: k8s-operator/2.get-started/2.1.install-operator.md
- Create a NebulaGraph cluster: k8s-operator/2.get-started/2.3.create-cluster.md
- Connect to a NebulaGraph cluster: k8s-operator/2.get-started/2.4.connect-to-cluster.md
- NebulaGraph Operator management:
- Customize installation defaults: k8s-operator/3.operator-management/3.1.customize-installation.md
- Update NebulaGraph Operator: k8s-operator/3.operator-management/3.2.update-operator.md
- Upgrade NebulaGraph Operator: k8s-operator/3.operator-management/3.3.upgrade-operator.md
- Uninstall NebulaGraph Operator: k8s-operator/3.operator-management/3.4.unistall-operator.md
- Cluster administration:
- Deployment:
- Install clusters: k8s-operator/4.cluster-administration/4.1.installation/4.1.1.cluster-install.md
- Upgrade clusters: k8s-operator/4.cluster-administration/4.1.installation/4.1.2.cluster-upgrade.md
- Uninstall clusters: k8s-operator/4.cluster-administration/4.1.installation/4.1.3.cluster-uninstall.md
- Customize cluster configurations: k8s-operator/4.cluster-administration/4.2.configuration.md
- Storage management:
# - Use local PV: k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md
- Dynamically expand persistent volumes: k8s-operator/4.cluster-administration/4.4.storage-management/4.4.2.pv-expansion.md
- Configure PV reclaim: k8s-operator/4.cluster-administration/4.4.storage-management/4.4.3.configure-pv-reclaim.md
- Log management: k8s-operator/4.cluster-administration/4.5.logging.md
- Security:
- Enable admission control: k8s-operator/4.cluster-administration/4.7.security/4.7.2.enable-admission-control.md
- HA and balancing:
- Self-healing overview: k8s-operator/4.cluster-administration/4.8.ha-and-balancing/4.8.1.self-healing.md
- Advanced:
- Optimize leader transfer in rolling updates: k8s-operator/4.cluster-administration/4.9.advanced/4.9.1.rolling-update-strategy.md
# - Restart clusters: k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md
- FAQ: k8s-operator/5.FAQ.md
- Graph computing:
- NebulaGraph Algorithm: graph-computing/nebula-algorithm.md
- Bench: nebula-bench.md
- FAQ: 20.appendix/0.FAQ.md
- Appendix:
- Release Note:
- NebulaGraph Community: 20.appendix/release-notes/nebula-comm-release-note.md
- NebulaGraph Studio: 20.appendix/release-notes/studio-release-note.md
- NebulaGraph Dashboard Community: 20.appendix/release-notes/dashboard-comm-release-note.md
# - Learning path: 20.appendix/learning-path.md
- Ecosystem tools: 20.appendix/6.eco-tool-version.md
- Port guide for company products: 20.appendix/port-guide.md
- How to contribute: 15.contribution/how-to-contribute.md
- History timeline: 20.appendix/history.md
- Error code: 20.appendix/error-code.md
- PDF: ./pdf/NebulaGraph-EN.pdf
# en.end
# zh.begin
- 前言: README.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
- 快速入门:
- 基于 Docker: 2.quick-start/1.quick-start-overview.md
- 从云开始（免费试用）: 2.quick-start/2.start-free-trial-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/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/6.set.md
- 字符串运算符: 3.ngql-guide/5.operators/7.string.md
- 列表运算符: 3.ngql-guide/5.operators/8.list.md
- 算术运算符: 3.ngql-guide/5.operators/10.arithmetic.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
# - 自定义函数: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md
- 通用查询语句:
- 查询语句概述: 3.ngql-guide/7.general-query-statements/1.general-query-statements-overview.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
- FIND PATH: 3.ngql-guide/7.general-query-statements/6.find-path.md
- GET SUBGRAPH: 3.ngql-guide/7.general-query-statements/7.get-subgraph.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
- INNER JOIN: 3.ngql-guide/8.clauses-and-options/joins.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
- 图空间语句:
- 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
- 查询调优与终止:
- 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/17.query-tuning-statements/2.kill-session.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
- 使用 Docker 编译: 4.deployment-and-installation/2.compile-and-install-nebula-graph/7.compile-using-docker.md
- 本地单机安装:
- 使用 RPM/DEB 包安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
- 使用 TAR 包安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- 安装存算合并版服务: 4.deployment-and-installation/standalone-deployment.md
- 本地多机安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- 使用 Docker Compose 安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.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
- 升级版本: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-comm.md
- 卸载: 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
- 监控:
- 查询监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md
- RocksDB 统计数据: 6.monitor-and-metrics/2.rocksdb-statistics.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
- 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
- 快照: backup-and-restore/3.manage-snapshot.md
- 同步与迁移:
- 负载均衡: synchronization-and-migration/2.balance-syntax.md
- 导入与导出:
- 概述: import-export/write-tools.md
- 使用 NebulaGraph Importer: import-export/use-importer.md
- NebulaGraph Exchange:
- 认识 NebulaGraph Exchange:
- 什么是 NebulaGraph Exchange: import-export/nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
- 使用限制: import-export/nebula-exchange/about-exchange/ex-ug-limitations.md
- 获取 NebulaGraph Exchange: import-export/nebula-exchange/ex-ug-compile.md
- 参数说明:
- 导入命令参数: import-export/nebula-exchange/parameter-reference/ex-ug-para-import-command.md
- 配置参数: import-export/nebula-exchange/parameter-reference/ex-ug-parameter.md
- 使用 NebulaGraph Exchange:
- 导入 CSV 文件数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-csv.md
- 导入 JSON 文件数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-json.md
- 导入 ORC 文件数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-orc.md
- 导入 Parquet 文件数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md
- 导入 HBase 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md
- 导入 MySQL/PostgreSQL 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md
- 导入 Oracle 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md
- 导入 ClickHouse 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md
- 导入 Neo4j 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
- 导入 Hive 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-hive.md
- 导入 MaxCompute 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md
- 导入 Pulsar 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md
- 导入 Kafka 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md
- 导入通用 JDBC 数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md
- 导入 SST 文件数据: import-export/nebula-exchange/use-exchange/ex-ug-import-from-sst.md
- Exchange 常见问题: import-export/nebula-exchange/ex-ug-FAQ.md
- 连接器:
- NebulaGraph Spark Connector: connector/nebula-spark-connector.md
- NebulaGraph Flink Connector: connector/nebula-flink-connector.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
- 启用 AutoFDO: 8.service-tuning/enable_autofdo_for_nebulagraph.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 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
- 连接数据库: 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/manage-schema/st-ug-view-schema.md
- Schema 草图: nebula-studio/quick-start/draft.md
- 全局设置: nebula-studio/system-settings.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 Operator:
- 什么是 NebulaGraph Operator: k8s-operator/1.introduction-to-nebula-operator.md
- 快速入门:
- 安装 NebulaGraph Operator: k8s-operator/2.get-started/2.1.install-operator.md
- 快速创建集群: k8s-operator/2.get-started/2.3.create-cluster.md
- 连接集群: k8s-operator/2.get-started/2.4.connect-to-cluster.md
- 管理 NebulaGraph Operator:
- 自定义安装配置: k8s-operator/3.operator-management/3.1.customize-installation.md
- 更新配置: k8s-operator/3.operator-management/3.2.update-operator.md
- 升级版本: k8s-operator/3.operator-management/3.3.upgrade-operator.md
- 卸载: k8s-operator/3.operator-management/3.4.unistall-operator.md
- 管理集群:
- 部署:
- 创建集群: k8s-operator/4.cluster-administration/4.1.installation/4.1.1.cluster-install.md
- 升级集群版本: k8s-operator/4.cluster-administration/4.1.installation/4.1.2.cluster-upgrade.md
- 删除集群: k8s-operator/4.cluster-administration/4.1.installation/4.1.3.cluster-uninstall.md
- 更新配置: k8s-operator/4.cluster-administration/4.2.configuration.md
- 存储管理:
# - 使用本地持久化存储: k8s-operator/4.cluster-administration/4.4.storage-management/4.4.1.use-local-pv.md
- 动态在线扩容存储卷: k8s-operator/4.cluster-administration/4.4.storage-management/4.4.2.pv-expansion.md
- 回收 PV: k8s-operator/4.cluster-administration/4.4.storage-management/4.4.3.configure-pv-reclaim.md
- 日志管理: k8s-operator/4.cluster-administration/4.5.logging.md
- 安全:
- 开启准入控制: k8s-operator/4.cluster-administration/4.7.security/4.7.2.enable-admission-control.md
- 高可用和负载均衡:
- 故障自愈: k8s-operator/4.cluster-administration/4.8.ha-and-balancing/4.8.1.self-healing.md
- 高阶功能:
- 优化滚动更新中的 Leader 分布: k8s-operator/4.cluster-administration/4.9.advanced/4.9.1.rolling-update-strategy.md
# - 重启集群: k8s-operator/4.cluster-administration/4.9.advanced/4.9.2.restart-cluster.md
- 常见问题: k8s-operator/5.FAQ.md
- 图计算:
- NebulaGraph Algorithm: graph-computing/nebula-algorithm.md
- NebulaGraph Bench: nebula-bench.md
- 常见问题: 20.appendix/0.FAQ.md
- 附录:
- 更新说明:
- NebulaGraph 社区版: 20.appendix/release-notes/nebula-comm-release-note.md
- NebulaGraph Studio: 20.appendix/release-notes/studio-release-note.md
- NebulaGraph Dashboard 社区版: 20.appendix/release-notes/dashboard-comm-release-note.md
# - 学习路径: 20.appendix/learning-path.md