forked from vesoft-inc/nebula-docs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
747 lines (691 loc) · 36.9 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
# Project information
site_name: NebulaGraph Database Manual
site_description: Documentation for NebulaGraph Database
site_author: NebulaGraph
site_url: https://docs.nebula-graph.io/
docs_dir: docs-2.0
repo_name: 'vesoft-inc/nebula'
repo_url: 'https://github.com/vesoft-inc/nebula'
copyright: Copyright © 2022 NebulaGraph
# modify
edit_uri: 'https://github.com/vesoft-inc/nebula-docs/edit/master/docs-2.0/'
theme:
name: material
custom_dir: overrides
# git repo icon
icon:
repo: fontawesome/brands/github
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
language: 'en'
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:
permalink: true
separator: "_"
# toc_depth: 1
- 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
- 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
- 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-cloud/*
- nebula-cloud.md
# When publishing a version of a document that includes Enterprise Edition, annotation the following page
# ent.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
- nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md
- synchronization-and-migration/replication-between-clusters.md
- 20.appendix/release-notes/nebula-ent-release-note.md
- nebula-dashboard-ent/4.cluster-operator/operator/scale.md
- backup-and-restore/nebula-br-ent/*
- 6.monitor-and-metrics/3.bbox/*
# ent.end
# comm.begin
# comm.end
# Exclude the file with the following file name.
# - abc.md
# Exclude files with regular expressions (regexes)
# regex:
# - '.*\.(tmp|bin|tar)$'
- with-pdf:
copyright: 2022 Vesoft Inc.
cover_subtitle: master
author: Min Wu, Yao Zhou, Cooper Liang, Foesa Yang, Abby Huang
cover: true
back_cover: true
cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png'
output_path: pdf/NebulaGraph-EN.pdf
#show_anchors: true
#render_js: true
#headless_chrome_path: headless-chromium
#enabled_if_env: ENABLE_PDF_EXPORT
#debug_html: true
#show_anchors: true
#verbose: true
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:
# For conditional rendering
# Valid options: enterprise, community, both
# enterprise means this version is for the Enterprise only. And so on in a similar fashion
database_edition: both
# Language selector.
alternate:
- name: 中文
link: https://docs.nebula-graph.com.cn/
lang: zh
analytics:
provider: google
property: UA-60523578-16
# 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'
nebula:
release: 3.4.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 # 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
ent:
ent_begin: <!-- --> # change to "<!-->" when releasing core-ent
ent_end: <!-- --> # change to "<!-->" when releasing core-ent
nav:
- About: README.md
- Introduction:
- Introduction to graphs: 1.introduction/0-0-graph.md
- Graph databases: 1.introduction/0-1-graph-database.md
- Related technologies: 1.introduction/0-2.relates.md
- 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:
- Quick start workflow: 2.quick-start/1.quick-start-workflow.md
- 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
- 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 reference: 3.ngql-guide/4.variable-and-composite-queries/3.property-reference.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
- Property reference: 3.ngql-guide/5.operators/5.property-reference.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
- 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:
- 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
- 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
- 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
- Subgraph and path:
- 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
- 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
- Deployment and installation:
- Resource preparations: 4.deployment-and-installation/1.resource-preparations.md
- Compile and install Nebula Graph:
- Install Nebula Graph by compiling the source code: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
- Install NebulaGraph with RPM or DEB package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
- Install NebulaGraph with the tar.gz file: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- Deploy NebulaGraph with Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- Deploy a NebulaGraph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- Deploy NebulaGraph Grpah with ecosystem tools: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
- Deploy standalone NebulaGraph: 4.deployment-and-installation/standalone-deployment.md
#ent
- Deploy licenses for NebulaGraph Enterprise Edition clusters: 4.deployment-and-installation/deploy-license.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
# - Manage zone: 4.deployment-and-installation/5.zone.md
- Upgrade:
- Upgrade NebulaGraph from v2.x to v3.4 (Community Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md
- Upgrade NebulaGraph from v3.x to v3.4 (Community Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md
#ent
- Upgrade NebulaGraph from v3.x to v3.4 (Enterprise Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md
- Uninstall NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md
- Configurations and logs:
- 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
#ent
- Audit logs(Enterprise): 5.configurations-and-logs/2.log-management/audit-log.md
- Monitor and metrics:
- Query NebulaGraph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md
- RocksDB Statistics: 6.monitor-and-metrics/2.rocksdb-statistics.md
#ent
- Black-box monitoring:
- What is black-box monitoring: 6.monitor-and-metrics/3.bbox/3.1.bbox.md
- Black-box monitoring tool: 6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.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
#ent
- OpenLDAP authentication: 7.data-security/1.authentication/4.ldap.md
- SSL: 7.data-security/4.ssl.md
- Backup & Restore:
- NebulaGraph BR (Community Edition):
- What is Backup & Restore (Community Edition): 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
#ent
- NebulaGraph BR (Enterprise Edition):
- What is Backup & Restore (Enterprise Edition): backup-and-restore/nebula-br-ent/1.br-ent-overview.md
- Install BR: backup-and-restore/nebula-br-ent/2.install-tools.md
- Back up data with BR: backup-and-restore/nebula-br-ent/3.backup-data.md
- Restore data with BR: backup-and-restore/nebula-br-ent/4.restore-data.md
- Manage snapshots: backup-and-restore/3.manage-snapshot.md
- Synchronization & Migration:
- Load balance: synchronization-and-migration/2.balance-syntax.md
#ent
- Synchronize between two clusters: synchronization-and-migration/replication-between-clusters.md
- 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
- Client:
- 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
# - NebulaGraph Cloud: nebula-cloud.md
# - NebulaGraph Cloud:
# - What is NebulaGraph Cloud: nebula-cloud/1.what-is-cloud.md
# - Create a subscription: nebula-cloud/2.how-to-create-subsciption.md
# - Configure a Solution: nebula-cloud/3.how-to-set-solution.md
# - Cloud Solution roles: nebula-cloud/4.user-role-description.md
# - Solution operation:
# - Solution: nebula-cloud/5.solution/5.0.introduce-solution.md
# - Accessory applications(Dashboard/Studio/Explorer): nebula-cloud/5.solution/5.1.supporting-application.md
# - Private Link: nebula-cloud/5.solution/5.2.connection-configuration-and-use.md
# - Roles and authority management: nebula-cloud/5.solution/5.3.role-and-authority-management.md
# - Pricing: nebula-cloud/6.pricing.md
# - Terms of service: nebula-cloud/7.terms-and-conditions.md
# - Privacy policy: nebula-cloud/8.privacy-policy.md
- NebulaGraph 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:
- Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
- Operate Tags: nebula-studio/manage-schema/st-ug-crud-tag.md
- Operate Edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- Operate 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
- 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
- NebulaGraph Dashboard Community Edition:
- 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 Dashboard Enterprise Edition:
- What is NebulaGraph Dashboard Enterprise Edition: nebula-dashboard-ent/1.what-is-dashboard-ent.md
- Deploy Dashboard Enterprise Edition: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
- Connect to Dashboard: nebula-dashboard-ent/3.connect-dashboard.md
- NebulaGraph Dashboard Enterprise Edition license: nebula-dashboard-ent/11.dashboard-ent-license.md
- Create and import clusters:
- Create clusters: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md
- Import clusters: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md
- Cluster management:
- Cluster overview: nebula-dashboard-ent/4.cluster-operator/1.overview.md
- Cluster monitoring: nebula-dashboard-ent/4.cluster-operator/2.monitor.md
- Notification: nebula-dashboard-ent/4.cluster-operator/9.notification.md
- Information:
- Information overview: nebula-dashboard-ent/4.cluster-operator/cluster-information/overview-info.md
- Cluster diagnostics: nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md
- Job management: nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
- Audit log: nebula-dashboard-ent/4.cluster-operator/cluster-information/audit-log.md
- Runtime log: nebula-dashboard-ent/4.cluster-operator/cluster-information/runtime-log.md
- Operation:
- Node: nebula-dashboard-ent/4.cluster-operator/operator/node.md
- Scale: nebula-dashboard-ent/4.cluster-operator/operator/scale.md
- Service: nebula-dashboard-ent/4.cluster-operator/operator/service.md
- Update config: nebula-dashboard-ent/4.cluster-operator/operator/update-config.md
- Member management: nebula-dashboard-ent/4.cluster-operator/operator/member-management.md
- Version upgrade: nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md
- Backup and restore: nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md
- Operation records: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md
- Other settings: nebula-dashboard-ent/4.cluster-operator/6.settings.md
- Authority management: nebula-dashboard-ent/5.account-management.md
- Task center: nebula-dashboard-ent/10.tasks.md
- System settings:
- System settings: nebula-dashboard-ent/system-settings/system-settings.md
- Notification endpoint: nebula-dashboard-ent/system-settings/notification-endpoint.md
- Single sign-on: nebula-dashboard-ent/system-settings/single-sign-on.md
- Package management: nebula-dashboard-ent/system-settings/manage-package.md
- Monitoring metrics: nebula-dashboard-ent/7.monitor-parameter.md
- FAQ: nebula-dashboard-ent/8.faq.md
- NebulaGraph Explorer:
- What is NebulaGraph Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md
- Deploy and connect:
- Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md
- Connect to NebulaGraph: nebula-explorer/deploy-connect/ex-ug-connect.md
- NebulaGraph Explorer License: nebula-explorer/deploy-connect/3.explorer-license.md
- Page overview: nebula-explorer/ex-ug-page-overview.md
- Database management:
- Schema drafting: nebula-explorer/db-management/draft.md
- Schema management: nebula-explorer/db-management/10.create-schema.md
- Data import: nebula-explorer/db-management/11.import-data.md
- Console: nebula-explorer/db-management/explorer-console.md
- nGQL template: nebula-explorer/db-management/ngql-template.md
- Database user management: nebula-explorer/db-management/dbuser_management.md
- Graph explorer:
- Choose graph space: nebula-explorer/graph-explorer/13.choose-graphspace.md
- Start querying: nebula-explorer/graph-explorer/ex-ug-query-exploration.md
- Vertex Filter: nebula-explorer/graph-explorer/node-filtering.md
- Graph exploration: nebula-explorer/graph-explorer/ex-ug-graph-exploration.md
- Graph computing: nebula-explorer/graph-explorer/graph-algorithm.md
- Property calculation: nebula-explorer/graph-explorer/property-calculation.md
- Visual query: nebula-explorer/12.query-visually.md
- Canvas:
- Canvas overview: nebula-explorer/canvas-operations/canvas-overview.md
- Visualization modes: nebula-explorer/canvas-operations/visualization-mode.md
- Canvas snapshots: nebula-explorer/canvas-operations/canvas-snapshot.md
- Workflow:
- Workflow overview: nebula-explorer/workflow/workflows.md
- Resource preparations: nebula-explorer/workflow/1.prepare-resources.md
- Workflow example: nebula-explorer/workflow/2.create-workflow.md
- Workflow management: nebula-explorer/workflow/3.workflow-management.md
- Job management: nebula-explorer/workflow/4.jobs-management.md
- Workflow API:
- API overview: nebula-explorer/workflow/workflow-api/workflow-api-overview.md
- Add a new job: nebula-explorer/workflow/workflow-api/api-post-jobs.md
- Get a list of all jobs: nebula-explorer/workflow/workflow-api/api-get-jobs.md
- Get a list of jobs for a specified workflow: nebula-explorer/workflow/workflow-api/api-get-workflow-jobs.md
- Query details for a specified job: nebula-explorer/workflow/workflow-api/api-desc-job.md
- Cancel a running job: nebula-explorer/workflow/workflow-api/api-cancel-job.md
- Get the result data of a specified task: nebula-explorer/workflow/workflow-api/api-desc-task.md
- Inline frame: nebula-explorer/iframe.md
- Basic operations and shortcuts: nebula-explorer/ex-ug-shortcuts.md
- FAQ: nebula-explorer/faq.md
- NebulaGraph Importer:
- Use NebulaGraph Importer: nebula-importer/use-importer.md
- Configuration with Header: nebula-importer/config-with-header.md
- Configuration without Header: nebula-importer/config-without-header.md
- NebulaGraph Exchange:
- Introduction:
- What is NebulaGraph Exchange: nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
- Limitations: nebula-exchange/about-exchange/ex-ug-limitations.md
- Get Exchange: nebula-exchange/ex-ug-compile.md
- Exchange configurations:
- Options for import: nebula-exchange/parameter-reference/ex-ug-para-import-command.md
- Parameters in the configuration file: nebula-exchange/parameter-reference/ex-ug-parameter.md
- Use NebulaGraph Exchange:
- Import data from CSV files: nebula-exchange/use-exchange/ex-ug-import-from-csv.md
- Import data from JSON files: nebula-exchange/use-exchange/ex-ug-import-from-json.md
- Import data from ORC files: nebula-exchange/use-exchange/ex-ug-import-from-orc.md
- Import data from Parquet files: nebula-exchange/use-exchange/ex-ug-import-from-parquet.md
- Import data from HBase: nebula-exchange/use-exchange/ex-ug-import-from-hbase.md
- Import data from MySQL/PostgreSQL: nebula-exchange/use-exchange/ex-ug-import-from-mysql.md
- Import data from Oracle: nebula-exchange/use-exchange/ex-ug-import-from-oracle.md
- Import data from ClickHouse: nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md
- Import data from Neo4j: nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
- Import data from Hive: nebula-exchange/use-exchange/ex-ug-import-from-hive.md
- Import data from MaxCompute: nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md
- Import data from Pulsar: nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md
- Import data from Kafka: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md
- Import data from JDBC: nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md
- Import data from SST files: nebula-exchange/use-exchange/ex-ug-import-from-sst.md
- Export data from NebulaGraph: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md
- Exchange FAQ: nebula-exchange/ex-ug-FAQ.md
- NebulaGraph Operator:
- What is NebulaGraph Operator: nebula-operator/1.introduction-to-nebula-operator.md
- Overview of using NebulaGraph Operator: nebula-operator/6.get-started-with-operator.md
- Deploy NebulaGraph Operator: nebula-operator/2.deploy-nebula-operator.md
- Deploy clusters:
- Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
- Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
- Configure clusters:
- Custom configuration parameters for a NebulaGraph cluster: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md
- Reclaim PVs: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md
#ent
- Balance storage data after scaling out: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md
- Upgrade NebulaGraph clusters: nebula-operator/9.upgrade-nebula-cluster.md
- Connect to NebulaGraph databases: nebula-operator/4.connect-to-nebula-graph-service.md
- Self-healing: nebula-operator/5.operator-failover.md
- FAQ: nebula-operator/7.operator-faq.md
- Graph computing:
- Algorithm overview: 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 workflow: graph-computing/use-explorer.md
- NebulaGraph Spark Connector: nebula-spark-connector.md
- NebulaGraph Flink Connector: nebula-flink-connector.md
- NebulaGraph Bench: nebula-bench.md
- Appendix:
- Release Note:
- NebulaGraph Community Edition: 20.appendix/release-notes/nebula-comm-release-note.md
#ent
- NebulaGraph Enterprise Edition: 20.appendix/release-notes/nebula-ent-release-note.md
- NebulaGraph Studio: 20.appendix/release-notes/studio-release-note.md
- NebulaGraph Dashboard Community Edition: 20.appendix/release-notes/dashboard-comm-release-note.md
- NebulaGraph Dashboard Enterprise Edition: 20.appendix/release-notes/dashboard-ent-release-note.md
- NebulaGraph Explorer: 20.appendix/release-notes/explorer-release-note.md
- Learning path: 20.appendix/learning-path.md
- About NebulaGraph licenses: 20.appendix/8.about-license.md
- FAQ: 20.appendix/0.FAQ.md
- Ecosystem tools: 20.appendix/6.eco-tool-version.md
- Write tools: 20.appendix/write-tools.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