Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
62 changes: 62 additions & 0 deletions assets/scss/community-members.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.hg-community-members {
--hg-community-columns: 5;
&__role + &__role { margin-top: 2.5rem; }
&__grid {
display: grid;
grid-template-columns: repeat(var(--hg-community-columns), minmax(0, 1fr));
gap: 1rem;
padding: 0;
margin: 1rem 0 0;
list-style: none;
}
}
.hg-community-member {
min-width: 0;
padding: 0;
&__link {
display: flex;
min-height: 100%;
flex-direction: column;
align-items: center;
gap: .65rem;
padding: 1rem .75rem;
color: inherit;
text-align: center;
text-decoration: none;
border: 1px solid var(--td-border-color);
border-radius: var(--td-card-border-radius, .75rem);
background: var(--td-card-bg, var(--bs-body-bg));
&:hover, &:focus-visible {
color: var(--td-link-color, var(--bs-link-color));
border-color: currentColor;
}
}
&__avatar {
position: relative;
display: grid;
width: 8rem;
height: 8rem;
overflow: hidden;
place-items: center;
border-radius: 50%;
background: var(--td-secondary-bg, var(--bs-secondary-bg));
img, .hg-community-member__initials { position: absolute; inset: 0; width: 100%; height: 100%; }
img { object-fit: cover; }
}
&__initials {
display: grid;
place-items: center;
font-size: 1.65rem;
font-weight: 700;
color: var(--td-body-color, var(--bs-body-color));
}
&__identity { max-width: 100%; overflow-wrap: anywhere; font-weight: 650; }
&__role-label { font-size: .8rem; color: var(--td-secondary-color, var(--bs-secondary-color)); }
}
@media (max-width: 1199.98px) {
.hg-community-members { --hg-community-columns: 3; }
}
@media (max-width: 767.98px) {
.hg-community-members { --hg-community-columns: 2; }
.hg-community-member__avatar { width: 6rem; height: 6rem; }
}
3 changes: 3 additions & 0 deletions content/cn/docs/clients/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "客户端与 API"
description: "通过 Java 客户端、REST API、Gremlin Console 和其他客户端库连接 HugeGraph。"
linkTitle: "客户端与 API"
weight: 5
search_keywords: [HugeGraph 客户端, Java 客户端, 客户端库]
search_boost: 1.5
---

本节包含 REST API、Gremlin Console 和客户端说明。当前 Server REST API 使用图空间和图名称组成资源路径;具体路径以各 API 页面和 Server 的 OpenAPI 页面为准。
2 changes: 2 additions & 0 deletions content/cn/docs/clients/restful-api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph RESTful API"
linkTitle: "RESTful API"
weight: 1
search_keywords: [HugeGraph REST API, RESTful API, OpenAPI]
search_boost: 1.7
---

> ⚠️ **版本兼容性说明**
Expand Down
9 changes: 5 additions & 4 deletions content/cn/docs/clients/restful-api/vertex.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 7
description: "Vertex(顶点)REST 接口:创建、查询、更新和删除图中的顶点数据,支持批量操作和条件过滤。"
---

### 2.1 Vertex
### 2.1 Vertex {#vertex-api}

顶点类型中的 `Id` 策略决定了顶点的 `Id` 类型,其对应的 `id` 类型如下:

Expand All @@ -16,6 +16,7 @@ description: "Vertex(顶点)REST 接口:创建、查询、更新和删除图
| CUSTOMIZE_STRING | string |
| CUSTOMIZE_NUMBER | number |
| CUSTOMIZE_UUID | uuid |
{#vertex-id-strategy .full-width caption="顶点 ID 策略"}

顶点的 `GET/PUT/DELETE` API 中 url 的 id 部分应该传入带有类型信息的 id 值,这个类型信息通过 json 串是否带引号来表示,也就是说:

Expand All @@ -41,7 +42,7 @@ schema.vertexLabel("software").properties("name", "lang", "price").primaryKeys("
schema.indexLabel("personByAge").onV("person").by("age").range().ifNotExist().create();
```

#### 2.1.1 创建一个顶点
#### 2.1.1 创建一个顶点 {#create-vertex}

##### Params

Expand All @@ -58,7 +59,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices

##### Request Body

```json
```json {filename="request.json" wrap=true}
{
"label": "person",
"properties": {
Expand All @@ -76,7 +77,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices

##### Response Body

```json
```json {filename="response.json" wrap=true}
{
"id": "1:marko",
"label": "person",
Expand Down
2 changes: 2 additions & 0 deletions content/cn/docs/config/config-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph 内置用户权限与扩展权限配置及使用"
linkTitle: "权限配置"
weight: 3
search_keywords: [HugeGraph 认证, 权限配置, StandardAuthenticator]
search_boost: 1.7
---

### 概述
Expand Down
4 changes: 3 additions & 1 deletion content/cn/docs/config/config-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Server 启动指南"
linkTitle: "Server 启动指南"
weight: 1
search_keywords: [HugeGraph 配置, Server 配置, 配置指南]
search_boost: 1.6
---

### 1 概述
Expand All @@ -21,7 +23,7 @@ HugeGraphServer 内部集成了 GremlinServer 和 RestServer,而 gremlin-serve

`gremlin-server.yaml` 的主要结构如下。示例省略了部分导入项;完整内容以发布包中的文件为准。

```yaml
```yaml {filename="conf/gremlin-server.yaml" wrap=true collapse=18}
# host and port of gremlin server, need to be consistent with host and port in rest-server.properties
#host: 127.0.0.1
#port: 8182
Expand Down
2 changes: 2 additions & 0 deletions content/cn/docs/download/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "下载 Apache HugeGraph"
linkTitle: "Download"
weight: 2
search_keywords: [HugeGraph 下载, 发布包, SHA512]
search_boost: 3
---

> 指南:
Expand Down
2 changes: 2 additions & 0 deletions content/cn/docs/introduction/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Apache HugeGraph 介绍"
linkTitle: "系统介绍"
weight: 1
search_keywords: [HugeGraph 介绍, 图数据库简介, 系统架构]
search_boost: 3
aliases:
# Hugo 0.165 prefixes aliases with the current language path.
- /docs/introduction/readme/
Expand Down
2 changes: 2 additions & 0 deletions content/cn/docs/quickstart/computing/hugegraph-computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph-Computer Quick Start"
linkTitle: "使用 Computer 进行 OLAP 分析"
weight: 2
search_keywords: [HugeGraph Computer, 图计算, OLAP]
search_boost: 1.6
---

## 1 HugeGraph-Computer 概述
Expand Down
6 changes: 3 additions & 3 deletions content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: "HugeGraph-Store Quick Start"
linkTitle: "安装/构建 HugeGraph-Store"
weight: 3
search_keywords:
- HugeGraph HStore
- 分布式存储
- server.port
- REST 端口
- Store REST 端口
search_boost: 1.5
search_boost: 1.6
Comment on lines 5 to +9
---

### 1 HugeGraph-Store 概述
Expand Down
2 changes: 2 additions & 0 deletions content/cn/docs/quickstart/hugegraph/hugegraph-pd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph-PD Quick Start"
linkTitle: "安装/构建 HugeGraph-PD"
weight: 2
search_keywords: [HugeGraph PD, 元数据管理, 集群调度]
search_boost: 1.6
---

### 1 HugeGraph-PD 概述
Expand Down
17 changes: 10 additions & 7 deletions content/cn/docs/quickstart/hugegraph/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph Server 快速开始"
linkTitle: "安装/构建 HugeGraph Server"
weight: 1
search_keywords: [HugeGraph Server, Server 快速开始, 图数据库服务]
search_boost: 1.7
aliases:
- /docs/quickstart/hugegraph-server/
---
Expand Down Expand Up @@ -34,10 +36,11 @@ HugeGraph 1.7.0 中的 `hugegraph-server` 模块使用 Java 11 编译,运行

有四种方式可以部署 Server 服务:

- 方式 1:使用 Docker 容器 (便于**测试**)
- 方式 2:下载 tar 包
- 方式 3:源码编译
- 方式 4:使用 tools 工具部署 (Outdated)
1. 使用 Docker 容器进行测试或开发。
1. 下载二进制 tar 包。
1. 从源码编译。
1. 使用已过时的一键部署工具。
{.steps}

> 不要把 Gremlin、Cypher 等查询接口直接暴露到公网。生产环境应启用[认证与授权](/cn/docs/config/config-authentication/),限制网络访问并保留审计日志;部署建议见[安全指南](/cn/docs/guides/security/)。

Expand Down Expand Up @@ -72,7 +75,7 @@ HugeGraph 1.7.0 中的 `hugegraph-server` 模块使用 Java 11 编译,运行
| HA 参考 | `docker-compose-3pd-3store-3server.yml` | 3 PD + 3 Store + 3 Server + 1 Hubble |
| 最小 HStore 拓扑的源码构建覆盖文件 | `docker-compose.dev.yml` | (需与 `docker-compose-hstore.yml` 一起使用) |

```bash
```bash {filename="docker/docker-compose.yml" wrap=true}
cd hugegraph/docker
# 注意版本号请随时保持更新 → 1.x.0
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose.yml up -d --wait
Expand All @@ -92,7 +95,7 @@ compose 文件从 `HUGEGRAPH_ADMIN_PASSWORD` 读取管理员密码,从 `HUGEGR

### 3.2 下载 tar 包

```bash
```bash {filename="download-release.sh" wrap=true collapse=2}
# 1.7.0 是项目孵化期发布的历史版本,因此文件名仍带 incubating
wget https://downloads.apache.org/hugegraph/1.7.0/apache-hugegraph-incubating-1.7.0.tar.gz
tar zxf apache-hugegraph-incubating-1.7.0.tar.gz
Expand All @@ -104,7 +107,7 @@ tar zxf apache-hugegraph-incubating-1.7.0.tar.gz

下载 HugeGraph 源代码

```bash
```bash {filename="build-from-source.sh" wrap=true collapse=2}
git clone https://github.com/apache/hugegraph.git
```

Expand Down
3 changes: 3 additions & 0 deletions content/cn/docs/quickstart/toolchain/hugegraph-hubble.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "HugeGraph-Hubble Quick Start"
description: "部署 HugeGraph-Hubble,进行图可视化、元数据管理、数据导入,以及 Gremlin 或 Cypher 查询。"
linkTitle: "使用 Hubble 实现图可视化"
weight: 1
search_keywords: [HugeGraph Hubble, 图可视化, Web 管理界面]
search_boost: 1.6
---

### 1 HugeGraph-Hubble 概述
Expand Down
2 changes: 2 additions & 0 deletions content/cn/docs/quickstart/toolchain/hugegraph-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph-Loader Quick Start"
linkTitle: "使用 Loader 实时/流式导入数据"
weight: 2
search_keywords: [HugeGraph Loader, 批量导入, 数据导入]
search_boost: 1.6
---

### 1 HugeGraph-Loader 概述
Expand Down
3 changes: 3 additions & 0 deletions content/en/docs/clients/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
title: "Clients and APIs"
description: "Connect to HugeGraph with the Java client, REST API, Gremlin Console, and other client libraries."
linkTitle: "Clients and APIs"
weight: 5
search_keywords: [HugeGraph clients, Java client, client libraries]
search_boost: 1.5
---

This section covers the REST API, Gremlin Console, and client libraries. The current Server REST API identifies graph resources with both a graph space and a graph name. Refer to each API page and the Server OpenAPI page for the exact paths.
2 changes: 2 additions & 0 deletions content/en/docs/clients/restful-api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph RESTful API"
linkTitle: "RESTful API"
weight: 1
search_keywords: [HugeGraph REST API, RESTful API, OpenAPI]
search_boost: 1.7
---

> ⚠️ **Version compatibility notes**
Expand Down
9 changes: 5 additions & 4 deletions content/en/docs/clients/restful-api/vertex.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 7
description: "Vertex REST API: Create, query, update, and delete vertex data in the graph with support for batch operations and conditional filtering."
---

### 2.1 Vertex
### 2.1 Vertex {#vertex-api}

In vertex types, the `Id` strategy determines the type of the vertex `Id`, with the corresponding relationships as follows:

Expand All @@ -16,6 +16,7 @@ In vertex types, the `Id` strategy determines the type of the vertex `Id`, with
| CUSTOMIZE_STRING | string |
| CUSTOMIZE_NUMBER | number |
| CUSTOMIZE_UUID | uuid |
{#vertex-id-strategy .full-width caption="Vertex ID strategies"}

For the `GET/PUT/DELETE` API of a vertex, the id part in the URL should be passed as the id value with type information. This type information is indicated by whether the JSON string is enclosed in quotes, meaning:

Expand All @@ -41,7 +42,7 @@ schema.vertexLabel("software").properties("name", "lang", "price").primaryKeys("
schema.indexLabel("personByAge").onV("person").by("age").range().ifNotExist().create();
```

#### 2.1.1 Create a vertex
#### 2.1.1 Create a vertex {#create-vertex}

##### Method & Url

Expand All @@ -51,7 +52,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices

##### Request Body

```json
```json {filename="request.json" wrap=true}
{
"label": "person",
"properties": {
Expand All @@ -69,7 +70,7 @@ POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/graph/vertices

##### Response Body

```json
```json {filename="response.json" wrap=true}
{
"id": "1:marko",
"label": "person",
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/config/config-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Built-in User Authentication and Authorization Configuration and Usage in HugeGraph"
linkTitle: "Config Authentication"
weight: 3
search_keywords: [HugeGraph authentication, authorization, StandardAuthenticator]
search_boost: 1.7
---

### Overview
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/config/config-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Server Startup Guide"
linkTitle: "Server Startup Guide"
weight: 1
search_keywords: [HugeGraph configuration, server config, configuration guide]
search_boost: 1.6
---

### 1 Overview
Expand All @@ -21,7 +23,7 @@ Now let's introduce these three configuration files one by one.

The main structure of `gremlin-server.yaml` is shown below. Some imports are omitted from this example; refer to the file included in the release package for the complete content.

```yaml
```yaml {filename="conf/gremlin-server.yaml" wrap=true collapse=18}
# host and port of gremlin server, need to be consistent with host and port in rest-server.properties
#host: 127.0.0.1
#port: 8182
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/download/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Download Apache HugeGraph"
linkTitle: "Download"
weight: 2
search_keywords: [HugeGraph download, release artifacts, SHA512]
search_boost: 3
---


Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/introduction/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Apache HugeGraph Introduction"
linkTitle: "System Introduction"
weight: 1
search_keywords: [HugeGraph overview, graph database introduction, architecture]
search_boost: 3
aliases:
# Hugo 0.165 prefixes aliases with the current language path.
- /docs/introduction/readme/
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/quickstart/computing/hugegraph-computer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "HugeGraph-Computer Quick Start"
linkTitle: "Analysis with HugeGraph-Computer"
weight: 2
search_keywords: [HugeGraph Computer, graph computing, OLAP]
search_boost: 1.6
---

## 1 HugeGraph-Computer Overview
Expand Down
Loading
Loading