Skip to content
Permalink
Browse files
Update the document of the hugegraph 0.8 version
Change-Id: I42aa6d5ab23e114aae87f767743f4a282b856312
  • Loading branch information
Linary authored and zhoney committed Nov 23, 2018
1 parent 7c31934 commit 9441c223188666be20fdcb8a1221d77e7467e737
Showing 10 changed files with 298 additions and 19 deletions.
@@ -13,11 +13,15 @@
## Guides
* [Architecture Overview](guides/architectural.md)
* [Design Concepts](guides/desgin-concept.md)
* [Configuration Guide](guides/config-guide.md)
* [Config Options](guides/config-option.md)
* [Custom Plugins](guides/custom-plugin.md)
* [Backup Restore](guides/backup-restore.md)
* [FAQ](guides/faq.md)

## Config
* [Config Guide](config/config-guide.md)
* [Config Options](config/config-option.md)
* [Config Authentication](config/config-authentication.md)

## Query Language
* [Gremlin Query Language](language/hugegraph-gremlin.md)
* [HugeGraph Examples](language/hugegraph-example.md)
@@ -50,6 +54,7 @@
* [HugeGraph-Loader Performance](performance/hugegraph-loader-performance.md)

## ChangeLogs
* [Release-0.8.0](changelog/hugegraph-0.8.0-release-notes.md)
* [Release-0.7.4](changelog/hugegraph-0.7.4-release-notes.md)
* [Release-0.6.1](changelog/hugegraph-0.6.1-release-notes.md)
* [Release-0.5.6](changelog/hugegraph-0.5.6-release-notes.md)
@@ -0,0 +1,106 @@
## HugeGraph 0.8 Release Notes

### API & Client

#### 功能更新

- 服务端增加 rays 和 rings 的 RESTful API(hugegraph #45)
- 使创建 IndexLabel 返回异步任务(hugegraph #95,hugegraph-client #9)
- 客户端增加恢复模式相关的 API(hugegraph-client #10)
- 让 task-list API 不返回 task_input 和 task_result(hugegraph #143)
- 增加取消异步任务的API(hugegraph #167,hugegraph-client #15)
- 增加获取后端 metrics 的 API(hugegraph #155)

#### BUG修复

- 分页获取时最后一页的 page 应该为 null 而非 "null"(hugegraph #168)
- 分页迭代获取服务端已经没有下一页了应该停止获取(hugegraph-client #16)
- 添加顶点使用自定义 Number Id 时报类型无法转换(hugegraph-client #21)

#### 内部修改

- 增加持续集成测试(hugegraph-client #19)

### Core

#### 功能更新

- 取消异步任务通过 label 查询时 80w 的限制(hugegraph #93)
- 允许 cardinality 为 set 时传入 Json List 形式的属性值(hugegraph #109)
- 支持在恢复模式和合并模式来恢复图(hugegraph #114)
- RocksDB 后端支持多个图指定为同一个存储目录(hugegraph #123)
- 支持用户自定义权限认证器(hugegraph-loader #133)
- 当服务重启后重新开始未完成的任务(hugegraph #188)
- 当顶点的 Id 策略为自定义时,检查是否已存在相同 Id 的顶点(hugegraph #189)

#### BUG修复

- 增加对 HasContainer 的 predicate 不为 null 的检查(hugegraph #16)
- RocksDB 后端由于数据目录和日志目录错误导致 init-store 失败(hugegraph #25)
- 启动 hugegraph 时由于 logs 目录不存在导致提示超时但实际可访问(hugegraph #38)
- ScyllaDB 后端遗漏注册顶点表(hugegraph #47)
- 使用 hasLabel 查询传入多个 label 时失败(hugegraph #50)
- Memory 后端未初始化 task 相关的 schema(hugegraph #100)
- 当使用 hasLabel 查询时,如果元素数量超过 80w,即使加上 limit 也会报错(hugegraph #104)
- 任务的在运行之后没有保存过状态(hugegraph #113)
- 检查后端版本信息时直接强转 HugeGraphAuthProxy 为 HugeGraph(hugegraph #127)
- 配置项 batch.max_vertices_per_batch 未生效(hugegraph #130)
- 配置文件 rest-server.properties 有错误时 HugeGraphServer 启动不报错,但是无法访问(hugegraph #131)
- MySQL 后端某个线程的提交对其他线程不可见(hugegraph #163)
- 使用 union(branch) + has(date) 查询时提示 String 无法转换为 Date(hugegraph #181)
- 使用 RocksDB 后端带 limit 查询顶点时会返回不完整的结果(hugegraph #197)
- 提示其他线程无法操作 tx(hugegraph #204)

#### 内部修改

- 拆分 graph.cache_xx 配置项为 vertex.cache_xx 和 edge.cache_xx 两类(hugegraph #56)
- 去除 hugegraph-dist 对 hugegraph-api 的依赖(hugegraph #61)
- 优化集合取交集和取差集的操作(hugegraph #85)
- 优化 transaction 的缓存处理和索引及 Id 查询(hugegraph #105)
- 给各线程池的线程命名(hugegraph #124)
- 增加并优化了一些 metrics 统计(hugegraph #138)
- 增加了对未完成任务的 metrics 记录(hugegraph #141)
- 让索引更新以分批方式提交,而不是全量提交(hugegraph #150)
- 在添加顶点/边时一直持有 schema 的读锁,直到提交/回滚完成(hugegraph #180)
- 加速 Tinkerpop 测试(hugegraph #19)
- 修复 Tinkerpop 测试在 resource 目录下找不到 filter 文件的 BUG(hugegraph #26)
- 开启 Tinkerpop 测试中 supportCustomIds 特性(hugegraph #69)
- 持续集成中添加 HBase 后端的测试(hugegraph #41)
- 避免持续集成的 deploy 脚本运行多次(hugegraph #170)
- 修复 cache 单元测试跑不过的问题(hugegraph #177)
- 持续集成中修改部分后端的存储为 tmpfs 以加快测试速度(hugegraph #206)

#### 其它

- 增加 issue 模版(hugegraph #42)
- 增加 CONTRIBUTING 文件(hugegraph #59)

### Loader

#### 功能更新

- 支持忽略源文件某些特定列(hugegraph-loader #2)
- 支持导入 cardinality 为 Set 的属性数据(hugegraph-loader #10)
- 单条插入也使用多个线程执行,解决了错误多时最后单条导入慢的问题(hugegraph-loader #12)

#### BUG修复

- 导入过程可能统计出错(hugegraph-loader #4)
- 顶点使用自定义 Number Id 导入出错(hugegraph-loader #6)
- 顶点使用联合主键时导入出错(hugegraph-loader #18)

#### 内部修改

- 增加持续集成测试(hugegraph-loader #8)
- 优化检测到文件不存在时的提示信息(hugegraph-loader #16)

### Tools

#### 功能更新

- 增加 KgDumper (hugegraph-tools #6)
- 支持在恢复模式和合并模式中恢复图(hugegraph-tools #9)

#### BUG修复

- 脚本中的工具函数 get_ip 在系统未安装 ifconfig 时报错(hugegraph-tools #13)
@@ -21,14 +21,13 @@ POST http://localhost:8080/graphs/hugegraph/schema/indexlabels
"fields": [
"city"
]
}
```

##### Response Status

```json
201
202
```

##### Response Body
@@ -2,8 +2,6 @@

#### 6.1.1 列出某个图中全部的异步任务



##### Params

- status: 异步任务的状态
@@ -86,3 +84,43 @@ DELETE http://localhost:8080/graphs/hugegraph/tasks/2
```json
204
```

#### 6.1.4 取消某个异步任务,**该异步任务必须具有处理中断的能力**

假设已经通过[Gremlin API](gremlin.md)创建了一个异步任务如下:

```groovy
"for (int i = 0; i < 10; i++) {" +
"hugegraph.addVertex(T.label, 'man');" +
"hugegraph.tx().commit();" +
"try {" +
"sleep(1000);" +
"} catch (InterruptedException e) {" +
"break;" +
"}" +
"}"
```

##### Method & Url

```
PUT http://localhost:8080/graphs/hugegraph/tasks/2?action=cancel
```

> 请保证在10秒内发送该请求,如果超过10秒发送,任务可能已经执行完成,无法取消。
##### Response Status

```json
202
```

##### Response Body

```json
{
"cancelled": true
}
```

此时查询 label 为 man 的顶点数目,一定是小于 10 的。
@@ -0,0 +1,32 @@
## 如何配置HugeGraph支持用户认证及扩展自定义用户认证系统

### 配置用户认证

HugeGraph默认不启用用户认证功能,可通过修改配置文件来启用该功能。默认实现了`StandardAuthenticator`类来支持用户认证,该实现是基于配置好的静态`tokens`来验证用户是否合法,认证方式使用HTTP Basic Authentication。下面是具体的配置流程(重启服务生效):

在配置文件`gremlin-server.yaml`中配置`authenticator`及其`rest-server`文件路径:

```yaml
authentication: {
authenticator: com.baidu.hugegraph.auth.StandardAuthenticator,
config: {tokens: /etc/hugegraph/rest-server.properties}
}
```

在配置文件`rest-server.properties`中配置`authenticator`及其`tokens`信息:

```ini
auth.authenticator=com.baidu.hugegraph.auth.StandardAuthenticator
auth.admin_token=token-value-a
auth.user_tokens=[hugegraph1:token-value-1, hugegraph2:token-value-2]
```

在配置文件`hugegraph{n}.properties`中配置`gremlin.graph`信息:

```ini
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
```

### 自定义用户认证系统

如果需要支持更加灵活的用户系统,可自定义authenticator进行扩展,自定义authenticator实现接口`com.baidu.hugegraph.auth.HugeAuthenticator`即可,然后修改配置文件中`authenticator`指向该实现。
File renamed without changes.
File renamed without changes.
@@ -2,27 +2,29 @@

### Latest version

The latest HugeGraph: **0.7.4**, released on _2018-07-30_.
The latest HugeGraph: **0.8.0**, released on _2018-11-23_.

components | description | download
---------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------
HugeGraph-Server | HugeGraph的主程序 | [0.7.4](https://github.com/hugegraph/hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz)
HugeGraph-Studio | 基于Web的图形化IDE环境 | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz)
HugeGraph-Spark | 基于Spark GraphX的图分析工具 | [0.7.0](https://github.com/hugegraph/hugegraph-spark/releases/download/v0.7.0/hugegraph-spark-0.7.0.tar.gz)
HugeGraph-Loader | 数据导入工具 | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz)
HugeGraph-Tools | 命令行工具集 | [1.1.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.1.0/hugegraph-tools-1.1.0.tar.gz)
HugeGraph-Server | HugeGraph的主程序 | [0.8.0](https://github.com/hugegraph/hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz)
HugeGraph-Studio | 基于Web的图形化展示工具 | [0.8.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz)
HugeGraph-Loader | 数据导入工具 | [0.8.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz)
HugeGraph-Tools | 命令行工具集 | [1.2.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.2.0/hugegraph-tools-1.2.0.tar.gz)
HugeGraph-Spark | 基于Spark GraphX的图分析工具 |

### Versions mapping

server | client | loader | studio | spark | common | tools
------------------------------------------------------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | ------ | -----------------------------------------------------------------------------------------------------------
[0.7.4](https://github.com/hugegraph/hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz) | 1.5.8 | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-spark/releases/download/v0.7.0/hugegraph-spark-0.7.0.tar.gz) | 1.4.9 | [1.1.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.1.0/hugegraph-tools-1.1.0.tar.gz)
[0.6.1](https://github.com/hugegraph/hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz) | 1.5.6 | [0.6.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-spark/releases/download/v0.6.1/hugegraph-spark-0.6.1.tar.gz) | 1.4.3 | [1.0.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.0.0/hugegraph-tools-1.0.0.tar.gz)
[0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz) | 1.5.0 | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz) | [0.5.0](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz) | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-spark/hugespark-0.5.6.tar.gz) | 1.4.0 |
[0.4.5](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz) | 1.4.7 | [0.2.2](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz) | [0.4.1](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz) | | 1.3.12 |
server | client | loader | studio | spark | common | tools
------------------------------------------------------------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----- | ------ | -----------------------------------------------------------------------------------------------------------
[0.8.0](https://github.com/hugegraph/hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz) | 1.6.4 | [0.8.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.8.0/hugegraph-loader-0.8.0.tar.gz) | [0.8.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.8.0/hugegraph-studio-0.8.0.tar.gz) | | 1.5.3 | [1.2.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.2.0/hugegraph-tools-1.2.0.tar.gz)
[0.7.4](https://github.com/hugegraph/hugegraph/releases/download/v0.7.4/hugegraph-0.7.4.tar.gz) | 1.5.8 | [0.7.0](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.7.0/hugegraph-loader-0.7.0.tar.gz) | [0.7.0](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.7.0/hugegraph-studio-0.7.0.tar.gz) | | 1.4.9 | [1.1.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.1.0/hugegraph-tools-1.1.0.tar.gz)
[0.6.1](https://github.com/hugegraph/hugegraph/releases/download/v0.6.1/hugegraph-0.6.1.tar.gz) | 1.5.6 | [0.6.1](https://github.com/hugegraph/hugegraph-loader/releases/download/v0.6.1/hugegraph-loader-0.6.1.tar.gz) | [0.6.1](https://github.com/hugegraph/hugegraph-studio/releases/download/v0.6.1/hugegraph-studio-0.6.1.tar.gz) | | 1.4.3 | [1.0.0](https://github.com/hugegraph/hugegraph-tools/releases/download/v1.0.0/hugegraph-tools-1.0.0.tar.gz)
[0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.5.6-SNAPSHOT.tar.gz) | 1.5.0 | [0.5.6](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.5.6-bin.tar.gz) | [0.5.0](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.5.0-SNAPSHOT.tar.gz) | | 1.4.0 |
[0.4.5](https://hugegraph.github.io/hugegraph-downloads/hugegraph-release-0.4.5-SNAPSHOT.tar.gz) | 1.4.7 | [0.2.2](https://hugegraph.github.io/hugegraph-downloads/hugegraph-loader/hugegraph-loader-0.2.2-bin.tar.gz) | [0.4.1](https://hugegraph.github.io/hugegraph-downloads/hugegraph-studio/hugestudio-release-0.4.1-SNAPSHOT.tar.gz) | | 1.3.12 |

### Release Notes

- 2018-11-23: Release HugeGraph 0.8.0,see [HugeGraph 0.8.0 Release Notes](changelog/hugegraph-0.8.0-release-notes.md)
- 2018-07-30: Release HugeGraph 0.7.4,see [HugeGraph 0.7.4 Release Notes](changelog/hugegraph-0.7.4-release-notes.md)
- 2018-06-01: Release HugeGraph 0.6.1,see [HugeGraph 0.6.1 Release Notes](changelog/hugegraph-0.6.1-release-notes.md)
- 2018-03-29: Release HugeGraph 0.5.6,see [HugeGraph 0.5.6 Release Notes](changelog/hugegraph-0.5.6-release-notes.md)

0 comments on commit 9441c22

Please sign in to comment.