Skip to content

Commit

Permalink
Merge branch 'master' into book
Browse files Browse the repository at this point in the history
  • Loading branch information
whitewum committed Sep 26, 2021
2 parents 3fa45f1 + c2999bc commit 4fc44b3
Show file tree
Hide file tree
Showing 20 changed files with 1,070 additions and 104 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ jobs:
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.DEPLOY_TOKEN }}
# publish_dir: ./site
# publish_dir: ./site
16 changes: 12 additions & 4 deletions docs-2.0/20.appendix/0.FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,21 @@ Storage 服务使用 Raft 协议(多数表决),为保证可用性,要求

### 使用`GO``MATCH`执行相同语义的查询,查询结果为什么不同?

路径的类型不同,导致查询结果可能会不同。
原因可能有以下几种:

- `GO`语句采用的是`walk`类型,遍历时点和边可以重复
* `GO`查询到了悬挂边

- `MATCH`语句兼容openCypher,采用的是`trail`类型,遍历时只有点可以重复,边不可以重复。
* `RETURN` 命令未指定排序方式。

* 触发了Storage服务中`max_edge_returned_per_vertex`定义的稠密点截断限制。

* 路径的类型不同,导致查询结果可能会不同。

- `GO`语句采用的是`walk`类型,遍历时点和边可以重复。

- `MATCH`语句兼容openCypher,采用的是`trail`类型,遍历时只有点可以重复,边不可以重复。

例如下图
因路径类型不同导致查询结果不同的示例图和说明如下

![路径示例](../images/path1.png)

Expand Down
10 changes: 9 additions & 1 deletion docs-2.0/20.appendix/6.eco-tool-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Nebula Dashboard(简称Dashboard)是一款用于监控Nebula Graph集群中

## Nebula Explorer

Nebula Explorer(简称 Explorer)是一款可以通过 Web 访问的图探索可视化工具,搭配 Nebula Graph 内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。详情参见[什么是Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)
Nebula Explorer(简称Explorer)是一款可以通过Web访问的图探索可视化工具,搭配Nebula Graph内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。详情参见[什么是Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)

|Nebula Graph版本|Explorer版本(commit id)|
|:---|:---|
Expand All @@ -62,6 +62,14 @@ Nebula Exchange(简称Exchange)是一款Apache Spark™应用,用于
|:---|:---|
| {{ nebula.release }} | {{exchange.release}}(3c0f4c6) |

## Nebula Operator

Nebula Operator(简称Operator)是用于在Kubernetes系统上自动化部署和运维Nebula Graph集群的工具。依托于Kubernetes扩展机制,Nebula Graph将其运维领域的知识全面注入至Kubernetes系统中,让Nebula Graph成为真正的云原生图数据库。详情请参考[什么是Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md)

|Nebula Graph版本|Operator版本(commit id)|
|:---|:---|
| {{ nebula.release }} | {{operator.release}}(6d1104e) |

## Nebula Importer

Nebula Importer(简称Importer)是一款Nebula Graph的CSV文件导入工具。Importer可以读取本地的CSV文件,然后导入数据至Nebula Graph图数据库中。详情请参见[什么是Nebula Importer](../nebula-importer/use-importer.md)
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ nebula> CREATE TAG player(name string, age int);
在[Nebula Graph Issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3Aincompatible)中已经列出已知的多处不兼容项。如果发现这种类型的新问题,请提交问题并附带`incompatible`标签。在本文搜索"compatibility"或者“兼容性”查看具体不兼容细节。


### nGQL和openCypher 9的主要差异有哪些
### nGQL 和 openCypher 9的 主要差异有哪些

|类别| openCypher 9 | nGQL |
| :--- | :--- |:--- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
DROP EDGE [IF EXISTS] <edge_type_name>
```

- `IF NOT EXISTS`:检测待删除的Edge type是否存在,只有存在时,才会删除Edge type。
- `IF EXISTS`:检测待删除的Edge type是否存在,只有存在时,才会删除Edge type。

- `edge_type_name`:指定要删除的Edge type名称。一次只能删除一个Edge type。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

全文搜索是基于全文索引对值为字符串类型的属性进行前缀搜索、通配符搜索、正则表达式搜索和模糊搜索。

`LOOKUP``MATCH`语句中,使用`WHERE`子句指定字符串的搜索条件。
`LOOKUP`语句中,使用`WHERE`子句指定字符串的搜索条件。

## 前提条件

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

目前为止,全文索引有如下限制:

- 全文索引当前仅支持`LOOKUP`语句。

- 定长字符串长度超过256字节,将无法创建全文索引。

- 如果Tag/Edge type上存在全文索引,无法删除或修改Tag/Edge type。
Expand All @@ -14,8 +16,6 @@

- 属性的类型必须为`String`

- 全文搜索语句`LOOKUP`/`MATCH`中的`WHERE`子句不支持逻辑运算`AND``OR`

- 全文索引不支持多个Tag/Edge type的搜索。

- 不支持排序全文搜索的返回结果,而是按照数据插入的顺序返回。
Expand All @@ -24,9 +24,9 @@

- 不支持修改Elasticsearch索引。

- `LOOKUP``MATCH`语句不支持管道符,文档中的示例除外
- 不支持管道符

- 只能用单个条件进行全文搜索
- `WHERE`子句只能用单个条件进行全文搜索

- 全文索引不会与图空间一起删除。

Expand Down
67 changes: 67 additions & 0 deletions docs-2.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# 欢迎阅读Nebula Graph {{ nebula.release }} 文档

!!! Note "确认正在阅读最新的版本"

本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}, [GitHub commit](https://github.com/vesoft-inc/nebula-docs-cn/tree/v{{ nebula.release }}) {{ git.short_commit }}。

Nebula Graph是一款开源的、分布式的、易扩展的原生图数据库,能够承载数千亿个点和数万亿条边的超大规模数据集,并且提供毫秒级查询。

## 快速开始

* [简介](1.introduction/1.what-is-nebula-graph.md)
* [快速开始](2.quick-start/1.quick-start-workflow.md)
* [配置要求](4.deployment-and-installation/1.resource-preparations.md)
* [FAQ](20.appendix/0.FAQ.md)
* [生态工具](20.appendix/6.eco-tool-version.md)

## 其他资料

- [《开源分布式图数据库 Nebula
Graph 完全指南》](https://docs.nebula-graph.com.cn/site/pdf/NebulaGraph-book.pdf)
- [Release note](20.appendix/releasenote.md)
- [论坛](https://discuss.nebula-graph.com.cn/)
- [项目主页](https://nebula-graph.com.cn/)
- [系列视频](https://space.bilibili.com/472621355)
- [思维导图](20.appendix/mind-map.md)
- [English](https://docs.nebula-graph.io/)

## 图例说明


<!--
本文有 40+ 个 caution。
本文有 30+ 个 danger。
本文有 80+ 个 compatibility 和兼容性提示。
-->

!!! note

额外的信息或者操作相关的提醒等。

!!! caution

需要严格遵守的注意事项。不遵守 caution 可能导致系统故障、数据丢失、安全问题等。

!!! danger

会引发危险的事项。不遵守danger必定会导致系统故障、数据丢失、安全问题等。

!!! performance

性能调优时需要注意的事项。

!!! faq

常见问题。

!!! compatibility

nGQL与openCypher的兼容性或nGQL当前版本与历史版本的兼容性。

!!! enterpriseonly

描述社区版和企业版的差异。

## 修改文档中的错误

Nebula Graph 文档以 Markdown 语言编写。单击文档标题右上侧的铅笔图标即可提交修改建议。
37 changes: 37 additions & 0 deletions docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 什么是Nebula Operator

## 基本概念

Nebula Operator是用于在[Kubernetes](https://kubernetes.io)系统上自动化部署和运维[Nebula Graph](https://github.com/vesoft-inc/nebula)集群的工具。依托于Kubernetes扩展机制,Nebula Graph将其运维领域的知识全面注入至Kubernetes系统中,让Nebula Graph成为真正的[云原生图数据库](https://www.nebula-cloud.io/)

## 工作原理

对于Kubernetes系统内不存在的资源类型,用户可以通过添加自定义API对象的方式注册,常见的方法是使用[CustomResourceDefinition(CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)

Nebula Operator将Nebula Graph集群的部署管理抽象为CRD。通过结合多个内置的API对象,包括StatefulSet、Service和ConfigMap,Nebula Graph集群的日常管理和维护被编码为一个控制循环。在Kubernetes系统内,每一种内置资源对象,都运行着一个特定的控制循环,将它的实际状态通过事先规定好的编排动作,逐步调整为最终的期望状态。当一个CR实例被提交时,Nebula Operator会根据控制流程驱动数据库集群进入最终状态。

## 功能介绍

Nebula Operator已具备的功能如下:

- **集群创建和卸载**:Nebula Operator简化了用户部署和卸载集群的过程。用户只需提供对应的CR文件,Nebula Operator即可快速创建或者删除一个对应的Nebula Graph集群。更多信息参考[使用Kubectl部署Nebula Graph集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用Helm部署Nebula Graph集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)

- **集群扩容和缩容**:通过在控制循环中调用Nebula Graph原生提供的扩缩容接口,Nebula Graph封装Nebula Operator实现了扩缩容的逻辑,用户可以通过YAML配置进行简单的扩缩容,且保证数据的稳定性。更多信息参考[使用Kubeclt扩缩容集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md#_3)[使用Helm扩缩容集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md#_2)

- **故障自愈**:Nebula Operator调用Nebula Graph集群提供的接口,动态地感知服务状态。一旦发现异常,Nebula Operator自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)

- **均衡调度**: 基于调度器扩展接口,Nebula Operator提供的调度器可以将应用Pods均匀地分布在Nebula Graph集群中。

## 使用限制

### 版本限制

Nebula Operator不支持v1.x版本的Nebula Graph,其与Nebula Graph版本的对应关系如下:

| Nebula Operator版本 | Nebula Graph版本 |
| ------------------- | ---------------- |
| {{operator.release}}| {{nebula.release}} |

### 功能限制

目前Nebula Operator只支持手动扩缩容Nebula Graph集群,不支持自动扩缩容Nebula Graph集群。
Loading

0 comments on commit 4fc44b3

Please sign in to comment.