Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update from upstream #3

Merged
merged 59 commits into from
Nov 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
75bdc8a
set-precedence (#42)
Amber1990Zhang Jun 10, 2020
d07de5b
remove the upgrade file (#45)
whitewum Jun 10, 2020
94d17c4
re-organize-part-2 (#44)
Amber1990Zhang Jun 10, 2020
733b1a2
pdf-1.0.0 (#46)
Amber1990Zhang Jun 12, 2020
8a5fd1b
uninstall & install without internet (#48)
Amber1990Zhang Jun 12, 2020
82bbfbe
job-previlege (#49)
Amber1990Zhang Jun 17, 2020
c02084d
minor (#50)
Amber1990Zhang Jun 23, 2020
fe7f92c
property-ref-update (#51)
Amber1990Zhang Jun 23, 2020
1f0c8fd
example-commands (#52)
Amber1990Zhang Jun 30, 2020
972a4a7
get-start-update (#57)
Amber1990Zhang Jul 6, 2020
510b2ff
home-page add link (#58)
Amber1990Zhang Jul 7, 2020
52c6cc7
go-0-step (#55)
Amber1990Zhang Jul 7, 2020
aeb09ef
rank (#54)
Amber1990Zhang Jul 7, 2020
707318e
compact (#53)
Amber1990Zhang Jul 7, 2020
f8235e1
Cluster deploy (#56)
Amber1990Zhang Jul 7, 2020
06638ad
gremlin-format (#62)
Amber1990Zhang Jul 15, 2020
557e924
add LDAP and update TOC (#59)
Amber1990Zhang Jul 20, 2020
ff9e8fa
Sql ngql (#61)
Amber1990Zhang Jul 21, 2020
b035730
minors (#63)
Amber1990Zhang Jul 21, 2020
e093d65
Authentication (#60)
Amber1990Zhang Jul 22, 2020
f5b3221
fetch update (#65)
Amber1990Zhang Jul 27, 2020
c84154f
single Node log (#64)
Amber1990Zhang Jul 27, 2020
c3b8dfa
minors (#66)
Amber1990Zhang Jul 28, 2020
6e62606
compact (#67)
Amber1990Zhang Jul 28, 2020
3150d73
go pipe (#69)
Amber1990Zhang Aug 4, 2020
30038a5
vid-par (#68)
Amber1990Zhang Aug 11, 2020
dc5c71a
yml update (#71)
Amber1990Zhang Aug 19, 2020
df8f1cb
rocksdb-stats (#72)
Amber1990Zhang Aug 24, 2020
05bea79
minors (#70)
Amber1990Zhang Aug 24, 2020
60ef8e8
delete extra | (#73)
Amber1990Zhang Aug 25, 2020
0e473e7
typo fix (#74)
Amber1990Zhang Aug 25, 2020
d87663a
video link (#75)
Amber1990Zhang Aug 26, 2020
7001e7c
sst migration (#76)
Amber1990Zhang Sep 11, 2020
0d60182
rebuild index (#77)
Amber1990Zhang Sep 11, 2020
dd6f908
uuid and find path (#78)
Amber1990Zhang Sep 11, 2020
2810a2b
update index (#80)
Amber1990Zhang Sep 18, 2020
e3f8a54
RocksDB configs 1.1.0 (#81)
Amber1990Zhang Sep 18, 2020
68162ae
Authentication faq (#79)
Amber1990Zhang Sep 18, 2020
ed0b8c7
Vscode config (#83)
Amber1990Zhang Sep 21, 2020
700b10a
index or (#84)
Amber1990Zhang Sep 23, 2020
37adc01
add links in quick start (#82)
Amber1990Zhang Sep 23, 2020
73a99ff
version num & index faq (#85)
Amber1990Zhang Sep 23, 2020
f4cca45
typo fixed (#86)
Amber1990Zhang Sep 25, 2020
3510369
update lookup syntax (#88)
Amber1990Zhang Sep 30, 2020
364978d
chore: modify logo (#89)
nianiaJR Sep 30, 2020
428efbd
fix typos (#91)
oldLady344 Oct 9, 2020
34a55ba
fix-insert-vertex (#90)
Amber1990Zhang Oct 10, 2020
58c7368
docker swarm (#87)
Amber1990Zhang Oct 12, 2020
02c8291
update swarm (#93)
Amber1990Zhang Oct 12, 2020
39eea16
add submit job in quick start (#92)
Amber1990Zhang Oct 12, 2020
6c843f3
fix install by swarm (#94)
gumupaier Oct 12, 2020
d3a9a98
update install doc (#95)
hy9125 Oct 12, 2020
b3b1661
delete TTL negative (#96)
Amber1990Zhang Oct 21, 2020
763fc8e
port-faq (#97)
Amber1990Zhang Oct 27, 2020
224d293
auto_remove_invalid_space (#100)
Amber1990Zhang Nov 10, 2020
de24928
add-port-info (#102)
Amber1990Zhang Nov 13, 2020
4e29e16
Move studio docs (cn) (#103)
oldLady344 Nov 16, 2020
1ef7afc
Move java docs (#104)
oldLady344 Nov 16, 2020
5946cc3
Updated the example and a step (#105)
randomJoe211 Nov 16, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/AliYun.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
username: ${{ secrets.USER_NAME }}
password: ${{ secrets.PASSWORD }}
port: ${{ secrets.port }}
source: nebula-docs.tar.gz
source: nebula-docs.tar.gz
target: /usr/web

- name: UnCompress
Expand Down
3 changes: 0 additions & 3 deletions .gitignore

This file was deleted.

18 changes: 15 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nebula Graph 是什么

**Nebula Graph** 是一款开源的图数据库,擅长处理千亿个顶点和万亿条边的超大规模数据集
**Nebula Graph** 是一款开源的图数据库,擅长处理千亿个点和万亿条边的超大规模数据集

下图为 **Nebula Graph** 产品架构图:

Expand All @@ -15,22 +15,34 @@
* 类 SQL 查询语言
* 用户鉴权

## 快速使用
## [视频教程](https://space.bilibili.com/472621355)

如果你想通过观看视频的方式学习 Nebula Graph,请访问我们的 [B 站频道](https://space.bilibili.com/472621355)。目前有两个教程系列:

* [Nebula Graph 快速入门](https://space.bilibili.com/472621355/channel/detail?cid=86880)
* [Nebula Graph studio](https://space.bilibili.com/472621355/channel/detail?cid=121139)

## [快速使用](manual-CN/1.overview/2.quick-start/1.get-started.md)

请查看[快速使用手册](manual-CN/1.overview/2.quick-start/1.get-started.md),开始使用 **Nebula Graph**。

在开始使用 **Nebula Graph** 之前,必须通过[编译源码](manual-CN/3.build-develop-and-administration/1.build/1.build-source-code.md),[rpm/deb 包](manual-CN/3.build-develop-and-administration/2.install/1.install-with-rpm-deb.md) 或者 [docker compose](https://github.com/vesoft-inc/nebula-docker-compose/blob/master/README_zh-CN.md) 方式安装 **Nebula Graph**。您也可以观看[视频](https://space.bilibili.com/472621355)学习如何安装 **Nebula Graph**。

如果您遇到任何问题,请前往 Nebula Graph [官方论坛](https://discuss.nebula-graph.com.cn) 提问。

## 常见问题

* [查询返回时间解释](manual-CN/1.overview/2.quick-start/2.FAQ.md)
* [关于机械硬盘和千兆网络](https://docs.nebula-graph.com.cn/manual-CN/3.build-develop-and-administration/3.configurations/0.system-requirement/#_7)

## 文档

* [简体中文](https://docs.nebula-graph.com.cn/)
* [English](https://docs.nebula-graph.io/)

## 产品路线图

**Nebula Graph** 产品规划路线图请参见 [roadmap](https://github.com/vesoft-inc/nebula/wiki/Nebula-Graph-Roadmap)。
**Nebula Graph** 产品规划路线图请参见 [roadmap](https://github.com/vesoft-inc/nebula/wiki/Nebula-Graph-Roadmap-2020)。

## 可视化工具:Nebula Graph Studio

Expand Down
2 changes: 1 addition & 1 deletion docs/manual-CN/0.about-this-manual.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 关于本手册

此手册为 **Nebula Graph** 的用户手册,版本为 1.0。详细版本更新信息参见 [Release Notes](https://github.com/vesoft-inc/nebula/releases)。
此手册为 **Nebula Graph** 的用户手册,版本为 1.1。详细版本更新信息参见 [Release Notes](https://github.com/vesoft-inc/nebula/releases)。

## 面向的读者

Expand Down
2 changes: 1 addition & 1 deletion docs/manual-CN/1.overview/0.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 什么是 Nebula Graph

**Nebula Graph** 是一个开源 (Apache 2.0),高性能的分布式图数据库,是世界上唯一一个支持百亿节点,万亿条边,并提供毫秒延迟的图数据库解决方案。
**Nebula Graph** 是一个开源 (Apache 2.0),高性能的分布式图数据库,是一个支持百亿节点,万亿条边,并提供毫秒延迟的图数据库解决方案。

**Nebula Graph** 的目标是提供高并发低延时的读写及计算。 **Nebula Graph** 是一个开源项目,我们期待与社区一起共同推进行业发展。

Expand Down
36 changes: 24 additions & 12 deletions docs/manual-CN/1.overview/1.concepts/1.data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,51 @@

**Nebula Graph** 存储的图为 **_有向属性图_**,边为有向边,点和边均可包含属性。可表示为:
G = < V, E, P<sub>V</sub>, P<sub>E</sub> >,
其中 **V** 表示节点,**E** 表示有向边,**P<sub>V</sub>** 表示节点属性,**P<sub>E</sub>** 表示边属性。
其中 **V** 表示点,**E** 表示有向边,**P<sub>V</sub>** 表示点属性,**P<sub>E</sub>** 表示边属性。
此文档将使用如下示例图数据介绍属性图的基本概念:

![map300](https://user-images.githubusercontent.com/42762957/64932536-51b1f800-d872-11e9-9016-c2634b1eeed6.png)

上图为 NBA 球员及球队信息数据,图中包含 2 种类型的 11 个节点,即 player 和 team,2 种类型的边,即 serve 和 like。
上图为 NBA 球员及球队信息数据,图中包含 2 种类型的 11 个点,即 player 和 team,2 种类型的边,即 serve 和 like。
以下为示例图数据涉及到的概念介绍。

## 节点
## 点(Vertex)

节点用于表示现实世界中的实体,本例的数据中共包含 11 个节点。
点用于表示现实世界中的实体。在 **Nebula Graph** 中,点必须拥有唯一的标识符(即 `VID`)。在每个图空间中的 `VID` 必须是唯一的。

本例的数据中共包含 11 个点。

<img src="https://user-images.githubusercontent.com/42762957/64932628-00eecf00-d873-11e9-844b-6b2a535ca734.png" width="15%" height="20%">

## 标签
## 点类型——标签(Tag)

**Nebula Graph** 使用**标签**对节点进行分类,本例包含的节点标签为 **player** 和 **team**。
**Nebula Graph** 使用**标签**表示点类型;一个点可以同时有多种类型(Tag)。本例中有两种类型的点,其标签(类型)分别为 **player** 和 **team**。

<img src="https://user-images.githubusercontent.com/42762957/64932330-bff5bb00-d870-11e9-9940-4ff76ceca353.png" width="50%" height="25%">

## 边
## 边(Edge)

边用来连接节点,边通常表示两个节点间的某种关系或行为,本例中的边为 _**serve**_ 和 _**like**_。
边用来连接点,边通常表示两个点间的某种关系或行为,本例中的边为 _**serve**_ 和 _**like**_。

<img src="https://user-images.githubusercontent.com/42762957/64932285-68efe600-d870-11e9-8dc7-051f7b43c4aa.png" width="50%" height="25%">

## 边类型
## 边类型(Edge Type)

每条边都有唯一的边类型。两个点之间允许有多个相同或者不同类型的边。例如,以球员-球队的服役关系 _**serve**_ 为例,(球员)点 `101`(表示一名球员)为起始点,(球队)点 `215`(表示一支球队)为目标点。点 `101` 有一条出边,而点 `215` 有一条入边。

## 边 rank

两个点之间的边除了必须有类型之外,还必须有 rank。边 rank 是用户分配的 64 位整数;如不指定,边 rank 默认值为 0。

四元组[起点、边类型、权重、终点]可以唯一表示一条边。

边 rank 决定了两个点之间相同类型的边的排序方式。边 rank 值较高的边排名靠前。

每条边都有一种边类型,以边 _**serve**_ 为例,节点 `101`(表示一名球员)为起始点,节点 `215`(表示一支球队)为目标点。节点 `101` 有一条出边,而节点 `215` 有一条入边
目前的排序依据为“二进制编码顺序“:即 0, 1, 2, ... 9223372036854775807, -9223372036854775808, -9223372036854775807, ..., -1

## 属性
## 点和边的属性(Property)

属性为点和边内部的键值对。本例中,节点 **player** 拥有属性 `id``name` 和 `age`,边 **like** 则拥有属性 `likeness`。
点和边均可拥有属性,属性以键值对的方式描述。本例中, **player** 拥有属性 `id``name` 和 `age`,边 **like** 则拥有属性 `likeness`。

## Schema

Expand Down
47 changes: 24 additions & 23 deletions docs/manual-CN/1.overview/1.concepts/2.nGQL-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@
- 每个标签都有一个人类可读的名称,并且每个标签内部都会分配一个 32 位的整数
- 每个标签与一个属性列表相关联,每个属性都有一个名称和类型
- 标签之间可存在依赖关系作为约束。例如,如果标签 S 依赖于标签 T,则除非标签 T 存在,否则标签 S 无法存在。
- **节点** :图数据中代表实体的点
- 每个节点都有一个唯一的 64 位(有符号整数)ID (**VID**)
- 一个节点可以拥有多个**标签**
- **边**:节点之间的联系称为边
- **** :图数据中代表实体的点
- 每个点都有一个唯一的 64 位(有符号整数)ID (**VID**)
- 一个点可以拥有多个**标签**
- **边**:点之间的联系称为边
- 每条边由唯一数组 **<src_vid, dst_vid, edge_type, rank>** 标识
- ***边类型*** 是人类可读的字符串,并且每条边内部都会分配一个 32 位的整数。边类型决定边上的属性(模式)
- ***边 ranking*** 是用户分配的不可变的 64 位带符号整数,决定两个顶点之间的边顺序。等级值较高的边排名靠前。如未指定,则默认等级值为零。
- ***边 rank*** 是用户分配的不可变的 64 位带符号整数,决定两个点之间相同类型的边顺序。等级值较高的边排名靠前。如未指定,则默认等级值为零。目前的排序依据为“二进制编码顺序“:即 0, 1, 2, ... 9223372036854775807, -9223372036854775808, -9223372036854775807, ..., -1
- 每条边只能有一种类型
- **路径** : 多个节点与边的**非分支**连接
- 路径长度为该路径上的边数,比节点数少 1
- 路径可由一系列节点,边类型及权重表示。一条边是一个长度为 1 的特殊路径
- **路径**: 多个点与边的**非分支**连接
- 路径长度为该路径上的边数,比点数少 1
- 路径可由一系列点,边类型及权重表示。一条边是一个长度为 1 的特殊路径

```plain
<vid, <edge_type, rank>, vid, ...>
Expand All @@ -65,10 +65,11 @@
- 简单类型: **vid**、**double**、**int**、**bool**、**string** 和 **timestamp**
<!-- **float**,**path**, **year**, **month** (year/month), **date**, **datetime** -->
- **vid** : 64 位有符号整数,用来表示点 ID
- 简单类型列表,如: **integer[]**, **double[]**, **string[]**

<!-- - 简单类型列表,如: **integer[]**, **double[]**, **string[]**
- **Map**: 键值对列表。键类型必须为 **字符**,值类型必须与给定 map
- **Object** (未来版本支持): 键值对列表。键类型必须为**字符**,值可以是任意简单类型
- **Tuple List**: *只适用于返回值*。由元数据和数据(多行)组成 。元数据包含列名和类型。
- **Tuple List**: *只适用于返回值*。由元数据和数据(多行)组成 。元数据包含列名和类型。 -->

### 类型转换

Expand Down Expand Up @@ -142,9 +143,9 @@
<edge\_type\_name> := <label\>


#### 插入节点
#### 插入点

使用以下语句插入一个或多个节点
使用以下语句插入一个或多个点

<span style="color:blue">**INSERT VERTEX**</span> [<span style="color:blue">**NO OVERWRITE**</span>] <tag\_list> <span style="color:blue">**VALUES**</span> <vertex\_list> <br/>

Expand All @@ -160,11 +161,11 @@

<span style="color:blue">**INSERT EDGE**</span> [<span style="color:blue">**NO OVERWRITE**</span>] <edge\_type\_name> [(<prop\_list>)] <span style="color:blue">**VALUES**</span> (<edge\_value>)+

edge\_value ::= <vertex\_id> -> <vertex\_id> [@ <weight\>] : <prop\_value\_list>
edge\_value ::= <vertex\_id> -> <vertex\_id> [@ <rank\>] : <prop\_value\_list>

#### 更新节点
#### 更新点

使用以下语句更新节点
使用以下语句更新点

<span style="color:blue">**UPDATE VERTEX**</span> <vertex\_id>
<span style="color:blue">**SET**</span> \<update\_decl\>
Expand All @@ -179,14 +180,14 @@ edge\_value ::= <vertex\_id> -> <vertex\_id> [@ <weight\>] : <prop\_value\_list>

使用以下语句更新边

<span style="color:blue">**UPDATE EDGE**</span> <vertex\_id> -> <vertex\_id> [@<weight\>] <span style="color:blue">**OF**</span> <edge\_type>
<span style="color:blue">**UPDATE EDGE**</span> <vertex\_id> -> <vertex\_id> [@<rank\>] <span style="color:blue">**OF**</span> <edge\_type>
<span style="color:blue">**SET**</span> <update\_decl>
[<span style="color:blue">**WHERE**</span> <conditions\>]
[<span style="color:blue">**YIELD**</span> <field\_list>]

#### 图遍历

根据指定条件遍历给定节点的关联节点,返回节点 ID 列表或数组
根据指定条件遍历给定点的关联点,返回点 ID 列表或数组

<span style="color:blue">**GO**</span>
[<steps\_decl> <span style="color:blue">**STEPS**</span>]
Expand Down Expand Up @@ -237,7 +238,7 @@ GO 3 TO 5 STEPS FROM me OVER friend WHERE birthday > "1988/1/1/"

#### 搜索

以下语句对满足筛选条件的节点或边进行搜索
以下语句对满足筛选条件的点或边进行搜索

<span style="color:blue">**FIND VERTEX**</span>
<span style="color:blue">**WHERE**</span> <filter\_list>
Expand Down Expand Up @@ -274,8 +275,8 @@ $- 为输入值, $$ 为目标值。

### 内建属性

\_id: 节点 ID
\_type: 边类型
\_src: 边起始点 ID
\_dst: 边终点 ID
\_rank: 边 ranking
- \_id: ID
- \_type: 边类型
- \_src: 边起始点 ID
- \_dst: 边终点 ID
- \_rank: 边 rank
Loading