forked from vesoft-inc/nebula-docs-cn
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
executable file
·329 lines (291 loc) · 20.8 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
# Project information
site_name: Nebula Graph Database 手册
site_description: Documentation for Nebula Graph Database
site_author: Nebula Graph
site_url: https://docs.nebula-graph.com.cn/
edit_uri: ''
# repository
repo_name: 'vesoft-inc/nebula'
repo_url: 'https://github.com/vesoft-inc/nebula'
# Copyright
copyright: Copyright © 2020 Nebula Graph - 浙ICP备20010487号
# Configuration
theme:
name: 'material'
logo: 'https://cloud-cdn.nebula-graph.com.cn/vesoft-nebula-logo-white.png'
favicon: 'assets/images/favicon.ico'
palette:
primary: 'indigo'
accent: 'indigo'
feature:
tabs: true
language: 'zh'
extra_css:
- 'stylesheets/logo.css'
# - 'theme/structor-menu.css'
# - 'theme/extra.css'
# Customization
extra:
social:
- type: 'github'
link: 'https://github.com/vesoft-inc/nebula'
- type: 'weibo'
link: 'https://www.weibo.com/u/7122684542?is_hot=1'
- type: 'twitter'
link: 'https://twitter.com/NebulaGraph'
- type: 'linkedin'
link: 'https://www.linkedin.com/company/vesoft-nebula-graph/'
- type: 'facebook'
link: 'https://www.facebook.com/NebulaGraph/'
- type: 'slack'
link: 'https://app.slack.com/client/TJB3N2BPD/CJNFUM7AR'
nav:
# - Version: '../'
- 简介:
- 关于本手册: manual-CN/0.about-this-manual.md
- 目录索引: manual-CN/README.md
- 基本概念:
- 数据模型: manual-CN/1.overview/1.concepts/1.data-model.md
- 查询语言概览: manual-CN/1.overview/1.concepts/2.nGQL-overview.md
- 快速开始和常用链接:
- 开始试用: manual-CN/1.overview/2.quick-start/1.get-started.md
- 常见问题 FAQ: manual-CN/1.overview/2.quick-start/2.FAQ.md
- 系统要求: manual-CN/3.build-develop-and-administration/3.configurations/0.system-requirement.md
- Nebula Graph 客户端: manual-CN/1.overview/2.quick-start/3.supported-clients.md
- 编译源代码: manual-CN/3.build-develop-and-administration/1.build/1.build-source-code.md
- 导入 .csv 文件: manual-CN/1.overview/2.quick-start/4.import-csv-file.md
# - Ingest .sst File: manual-CN/3.build-develop-and-administration/5.storage-service-administration/data-import/download-and-ingest-sst-file.md
- 系统设计与架构:
- 设计总览: manual-CN/1.overview/3.design-and-architecture/1.design-and-architecture.md
- 存储层架构: manual-CN/1.overview/3.design-and-architecture/2.storage-design.md
- 查询引擎架构: manual-CN/1.overview/3.design-and-architecture/3.query-engine.md
- 查询语言:
- 查询语言简介: manual-CN/2.query-language/0.README.md
- 数据类型:
- 基本数据类型: manual-CN/2.query-language/1.data-types/data-types.md
- 类型转换: manual-CN/2.query-language/1.data-types/type-conversion.md
- 函数与操作符:
- 位运算: manual-CN/2.query-language/2.functions-and-operators/bitwise-operators.md
- 内置函数: manual-CN/2.query-language/2.functions-and-operators/built-in-functions.md
- 比较运算: manual-CN/2.query-language/2.functions-and-operators/comparison-functions-and-operators.md
- 分组 GROUP BY: manual-CN/2.query-language/2.functions-and-operators/group-by-function.md
- LIMIT 语法: manual-CN/2.query-language/2.functions-and-operators/limit-syntax.md
- 逻辑运算: manual-CN/2.query-language/2.functions-and-operators/logical-operators.md
- 运算符优先级: manual-CN/2.query-language/2.functions-and-operators/operator-precedence.md
- ORDER BY 函数: manual-CN/2.query-language/2.functions-and-operators/order-by-function.md
- SET 运算符: manual-CN/2.query-language/2.functions-and-operators/set-operations.md
- 字符比较函数和运算符: manual-CN/2.query-language/2.functions-and-operators/string-comparison-functions-and-operators.md
- UUID 函数: manual-CN/2.query-language/2.functions-and-operators/uuid.md
- 语言结构:
- 字面值常量:
- 布尔类型: manual-CN/2.query-language/3.language-structure/literal-values/boolean-literals.md
- 数值类型: manual-CN/2.query-language/3.language-structure/literal-values/numeric-literals.md
- 字符串类型: manual-CN/2.query-language/3.language-structure/literal-values/string-literals.md
- 注释语法: manual-CN/2.query-language/3.language-structure/comment-syntax.md
- 标识符大小写: manual-CN/2.query-language/3.language-structure/identifier-case-sensitivity.md
- 关键字和保留字: manual-CN/2.query-language/3.language-structure/keywords-and-reserved-words.md
- 管道: manual-CN/2.query-language/3.language-structure/pipe-syntax.md
- 属性引用: manual-CN/2.query-language/3.language-structure/property-reference.md
- 标识符命名规则: manual-CN/2.query-language/3.language-structure/schema-object-names.md
- 语句组合: manual-CN/2.query-language/3.language-structure/statement-composition.md
- 用户自定义变量: manual-CN/2.query-language/3.language-structure/user-defined-variables.md
- 语句语法:
- 数据定义语句 (DDL):
- ALTER EDGE : manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/alter-edge-syntax.md
- ALTER TAG : manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/alter-tag-syntax.md
- CREATE SPACE: manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-space-syntax.md
- CREATE EDGE : manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-edge-syntax.md
- CREATE TAG : manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/create-tag-syntax.md
- DROP EDGE: manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-edge-syntax.md
- DROP TAG: manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-tag-syntax.md
- DROP SPACE: manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/drop-space-syntax.md
- INDEX: manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/index.md
- TTL: manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/TTL.md
- 数据查询与操作语句 (DQL 和 DML):
- DELETE EDGE: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/delete-edge-syntax.md
- DELETE VERTEX: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/delete-vertex-syntax.md
- FETCH: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/fetch-syntax.md
- GO: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/go-syntax.md
- INSERT EDGE: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/insert-edge-syntax.md
- INSERT VERTEX: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/insert-vertex-syntax.md
- LOOKUP: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/lookup-syntax.md
- RETURN: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/return-syntax.md
- UPDATE EDGE: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/update-edge-syntax.md
- UPDATE VERTEX: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/update-vertex-syntax.md
- UPSERT: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/upsert-syntax.md
- WHERE: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/where-syntax.md
- YIELD: manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/yield-syntax.md
- 辅助功能语句:
- SHOW 语句:
- SHOW CHARSET: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-charset-syntax.md
- SHOW COLLATION: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-collation-syntax.md
- SHOW CONFIGS: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-configs-syntax.md
- SHOW CREATE SPACE: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-space-syntax.md
- SHOW CREATE TAG EDGE: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-create-tag-edge-syntax.md
- SHOW HOSTS: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-hosts-syntax.md
- SHOW INDEXES: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-indexes-syntax.md
- SHOW PARTS: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-parts-syntax.md
- SHOW ROLES: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-roles-syntax.md
- SHOW SNAPSHOTS: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-snapshots-syntax.md
- SHOW SPACES: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-spaces-syntax.md
- SHOW TAGS EDGES: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-tags-edges-syntax.md
- SHOW USERS: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/show-statements/show-users-syntax.md
- DESCRIBE: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/describe-syntax.md
- USE: manual-CN/2.query-language/4.statement-syntax/3.utility-statements/use-syntax.md
- 图算法:
- FIND PATH: manual-CN/2.query-language/4.statement-syntax/4.graph-algorithms/find-path-syntax.md
- 编译、部署与运维:
- 编译:
- 编译源代码: manual-CN/3.build-develop-and-administration/1.build/1.build-source-code.md
- 使用 Docker 编译: manual-CN/3.build-develop-and-administration/1.build/2.build-by-docker.md
- 安装:
- rpm 安装: manual-CN/3.build-develop-and-administration/2.install/1.install-with-rpm-deb.md
- 启停服务: manual-CN/3.build-develop-and-administration/2.install/2.start-stop-service.md
- 集群部署: manual-CN/3.build-develop-and-administration/2.install/deploy-nebula-with-swarm.md
- Docker 安装: manual-CN/3.build-develop-and-administration/2.install/3.install-with-docker.md
- 配置:
- 系统要求: manual-CN/3.build-develop-and-administration/3.configurations/0.system-requirement.md
- 配置持久化与优先级: manual-CN/3.build-develop-and-administration/3.configurations/1.config-persistency-and-priority.md
- CONFIG 语法: manual-CN/3.build-develop-and-administration/3.configurations/2.configs-syntax.md
# - Metad 配置: manual-CN/3.build-develop-and-administration/3.configurations/3.meta-config.md
- Graphd 配置: manual-CN/3.build-develop-and-administration/3.configurations/4.graph-config.md
- Storaged 配置: manual-CN/3.build-develop-and-administration/3.configurations/5.storage-config.md
- Console 配置: manual-CN/3.build-develop-and-administration/3.configurations/6.console-config.md
- Kernel 配置: manual-CN/3.build-develop-and-administration/3.configurations/7.kernel-config.md
- 单机日志: manual-CN/3.build-develop-and-administration/3.configurations/8.single-node-log.md
- 账号权限管理:
- Alter User: manual-CN/3.build-develop-and-administration/4.account-management-statements/alter-user-syntax.md
- 身份验证: manual-CN/3.build-develop-and-administration/4.account-management-statements/authentication.md
- Built-in Roles: manual-CN/3.build-develop-and-administration/4.account-management-statements/built-in-roles.md
- Change Password: manual-CN/3.build-develop-and-administration/4.account-management-statements/change-password.md
- Create User: manual-CN/3.build-develop-and-administration/4.account-management-statements/create-user-syntax.md
- Drop User: manual-CN/3.build-develop-and-administration/4.account-management-statements/drop-user-syntax.md
- Grant Role: manual-CN/3.build-develop-and-administration/4.account-management-statements/grant-role-syntax.md
- LDAP: manual-CN/3.build-develop-and-administration/4.account-management-statements/LDAP.md
- Revoke: manual-CN/3.build-develop-and-administration/4.account-management-statements/revoke-syntax.md
- 批量数据管理:
- 离线数据导入:
# - Download And Ingest .sst File: manual-CN/3.build-develop-and-administration/5.storage-service-administration/data-import/download-and-ingest-sst-file.md
- 读取 .csv 文件: manual-CN/3.build-develop-and-administration/5.storage-service-administration/data-import/import-csv-file.md
- Spark 导入工具: manual-CN/3.build-develop-and-administration/5.storage-service-administration/data-import/spark-writer.md
- 离线数据转储:
- Dump Tool: manual-CN/3.build-develop-and-administration/5.storage-service-administration/data-export/dump-tool.md
- 负载均衡和数据迁移: manual-CN/3.build-develop-and-administration/5.storage-service-administration/storage-balance.md
- 集群快照: manual-CN/3.build-develop-and-administration/5.storage-service-administration/cluster-snapshot.md
- 长耗时任务管理: manual-CN/3.build-develop-and-administration/5.storage-service-administration/job-manager.md
- Compact: manual-CN/3.build-develop-and-administration/5.storage-service-administration/compact.md
- 监控与统计:
# - 接入 Prometheus: manual-CN/3.build-develop-and-administration/7.monitor/0.connect-prometheus.md
- Metrics: manual-CN/3.build-develop-and-administration/7.monitor/1.metrics-exposer.md
- Meta Metrics: manual-CN/3.build-develop-and-administration/7.monitor/2.meta-metrics.md
- Storage Metrics: manual-CN/3.build-develop-and-administration/7.monitor/3.storage-metrics.md
- Graph Metrics: manual-CN/3.build-develop-and-administration/7.monitor/4.graph-metrics.md
- RocksDB Statistics: manual-CN/3.build-develop-and-administration/7.monitor/5.rocksdb-statistics.md
- 源码开发和 API:
- Key Value API: manual-CN/3.build-develop-and-administration/6.develop-and-interface/kv-interfaces.md
- Nebula Graph 客户端: manual-CN/1.overview/2.quick-start/3.supported-clients.md
- 图算法:
- nebula-algorithm:
- 什么是 nebula-algorithm: nebula-algorithm/na-ug-what-is-nebula-algorithm.md
- 使用限制: nebula-algorithm/na-ug-limitations.md
- 编译 nebula-algorithm: nebula-algorithm/na-ug-compile.md
- 使用示例: nebula-algorithm/na-ug-example.md
- 数据传输:
- Nebula Exchange:
- 认识 Nebula Exchange:
- 什么是 Nebula Exchange: nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
- 使用限制: nebula-exchange/about-exchange/ex-ug-limitations.md
- 名词解释: nebula-exchange/about-exchange/ex-ug-terms.md
- 常见问题: nebula-exchange/about-exchange/ex-ug-faq.md
- 编译 Exchange: nebula-exchange/ex-ug-compile.md
- 操作指南:
- 导入数据步骤: nebula-exchange/use-exchange/ex-ug-import-steps.md
- 导入 Neo4j 数据: nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
- 导入 SST 文件: nebula-exchange/use-exchange/ex-ug-import-sst.md
- 导入 HIVE 数据: nebula-exchange/use-exchange/ex-ug-import-hive.md
- 导入 CSV 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-csv.md
- 导入 JSON 文件数据: nebula-exchange/use-exchange/ex-ug-import-json.md
- 参数说明:
- Spark 参数: nebula-exchange/parameter-reference/ex-ug-paras-spark.md
- Nebula Graph 参数: nebula-exchange/parameter-reference/ex-ug-paras-nebulagraph.md
#- 数据源参数:
#- Neo4j 数据源相关参数: nebula-exchange/parameter-reference/ex-ug-paras-neo4j.md
- 导入命令参数: nebula-exchange/parameter-reference/ex-ug-para-import-command.md
- Nebula Flink Connector:
- 什么是 Nebula Flink Connector: nebula-flink/nf-ug-what-is-flink-connector.md
- 编译 Nebula Flink Connector: nebula-flink/nf-ug-compile.md
- 使用限制: nebula-flink/nf-ug-limitations.md
- 自定义 source (NebulaSource): nebula-flink/nf-ug-customize-source.md
- 自定义 sink (NebulaSink): nebula-flink/nf-ug-customize-sink.md
- 特殊说明: nebula-flink/nf-ug-notes.md
- Nebula Spark Connector:
- 什么是 Nebula Spark Connector: spark-connector/sc-ug-what-is-spark-connector.md
- 编译 Nebula Spark Connector: spark-connector/sc-ug-compile.md
- 使用限制: spark-connector/sc-ug-limitations.md
- Nebula Spark Connector Reader:
- 什么是 Nebula Spark Connector Reader: spark-connector/reader/sc-ug-what-is-reader.md
- 使用示例: spark-connector/reader/sc-ug-reader-example.md
- Nebula Spark Connector Writer:
- 什么是 Nebula Spark Connector Writer: spark-connector/writer/sc-ug-what-is-writer.md
- 使用示例: spark-connector/writer/sc-ug-writer-example.md
- Nebula Graph Studio:
- 认识 Nebula Graph Studio:
- 什么是 Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
- 名词解释: nebula-studio/about-studio/st-ug-terms.md
- 使用限制: nebula-studio/about-studio/st-ug-limitations.md
- 版本更新: nebula-studio/about-studio/st-ug-check-updates.md
- 快捷键: nebula-studio/about-studio/st-ug-shortcuts.md
- 安装与登录:
- 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- 连接数据库: nebula-studio/deploy-connect/st-ug-connect.md
- 清除连接: nebula-studio/deploy-connect/st-ug-reset-connection.md
- 快速开始:
- 规划 Schema: nebula-studio/quick-start/st-ug-plan-schema.md
- 准备 CSV 文件: nebula-studio/quick-start/st-ug-prepare-csv.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-explore.md
- 操作指南:
- 管理 Schema:
- 操作图空间: nebula-studio/manage-schema/st-ug-crud-space.md
- 操作标签: nebula-studio/manage-schema/st-ug-crud-tag.md
- 操作边类型: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- 操作索引: nebula-studio/manage-schema/st-ug-crud-index.md
- 使用控制台:
- 控制台界面: nebula-studio/use-console/st-ug-console.md
- 导入图探索: nebula-studio/use-console/st-ug-open-in-explorer.md
- 查看子图: nebula-studio/use-console/st-ug-visualize-findpath.md
- 故障排查:
- 连接数据库错误: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
- 常见问题: nebula-studio/troubleshooting/st-ug-faq.md
- 社区贡献:
- 贡献文档: manual-CN/4.contributions/contribute-to-documentation.md
- C++ 编程风格: manual-CN/4.contributions/cpp-coding-style.md
# - Developer Documentation Style Guide: manual-CN/4.contributions/developer-documentation-style-guide.md
- 如何贡献: manual-CN/4.contributions/how-to-contribute.md
- PR and Commit 信息指南: manual-CN/4.contributions/pull-request-commit-message-guidelines.md
- 文档工程师 Visual Studio Code 推荐配置: manual-CN/4.contributions/vscode-config.md
- 附录:
- Cypher & nGQL: manual-CN/5.appendix/cypher-ngql.md
- Gremlin & nGQL: manual-CN/5.appendix/gremlin-ngql.md
- SQL & nGQL: manual-CN/5.appendix/sql-ngql.md
- 点标识符和分区: manual-CN/5.appendix/vid-partition.md
- 超级顶点（稠密点）处理: manual-CN/5.appendix/super-node.md
- English:
- https://docs.nebula-graph.io/
# Extensions
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
- toc:
permalink: true
separator: "_"
- mdx_truly_sane_lists
- pymdownx.superfences
# Plugins
plugins:
- search
# - mkdocs-versioning:
# version: 1.0