A
Note: 这篇文档会持续更新。 HugeGraph 1.8.0 的源码构建与发行包运行验证统一使用 Java 17(Maven 源码构建仅接受 JDK 17);1.7.0 请使用 Java 11。从 1.5.0 版本开始 (除 client 外) 不再支持 Java 8。 毕业说明:Apache HugeGraph 已于 2026 年 1 月毕业。正式发版投票现由 HugeGraph 社区内部完成(dev@hugegraph.apache.org 上的 PMC binding 投票),不再需要 Incubator general@incubator.apache.org 审批。
A
概述 HugeGraph 内置 StandardAuthenticator,支持多用户认证和基于“用户、用户组、操作、资源”的权限控制。
A
1 HugeGraph-Store 概述 HugeGraph-Store 是 HugeGraph 分布式版本的存储节点组件,负责实际存储和管理图数据。它与 HugeGraph-PD 协同工作,共同构成 HugeGraph 的分布式存储引擎,提供高可用性和水平扩展能力。
A
1 HugeGraph-Tools概述 HugeGraph-Tools 提供图与任务管理、备份和恢复命令,也保留旧版 Server/Studio 的部署命令。 测试指南:如需在本地运行 Tools 测试,请参考 工具链本地测试指南
A
1.3 VertexLabel 假设已经创建好了 1.1.3 中列出来的 PropertyKeys Params 说明 id:顶点类型 id 值 name:顶点类型名称,必填 id_strategy: 顶点类型的 ID 策略,主键 ID、自动生成、自定义字符串、自定义数字、自定义 UUID,默认主键 ID properties: 顶点类型关联的属性类型 primary_keys: 主键属性,当 ID 策略为 PRIMARY_KEY 时必须有值,其他 ID 策略时必须为空; enable_label_index:是否开启类型索引,默认关闭 index_names:顶点类型创建的索引,详情见 3.4 nullable_keys:可为空的属性 user_data:设置顶点类型的通用信息,作用同属性类型 1.3.1 创建一个 VertexLabel Method & Url 1POST http://localhost:8080/graphspaces/DEFAULT/graphs/hugegraph/schema/vertexlabels Request Body 1{ 2 "name":…
A
WIP: This doc is under construction, please wait for the final version (BETA) 运行环境/版本说明 1.5.0版开始, hugegraph 相关组件仅支持 Java 11 编译/运行环境 PS: 未来 HugeGraph 组件的版本会朝着 Java 11 -> Java 17 -> Java 21 演进
A
本页按 Web 页面的操作顺序,说明如何建立索引、查询文档和生成 Gremlin。服务启动方式见 HugeGraph-LLM。 先准备可连接的 HugeGraph Server、生成模型和 Embedding 模型。查看配置或在 Graph Tools 手写 Gremlin 不需要模型; 文档向量化需要 Embedding,图数据抽取和答案生成还需要 LLM。Reranker 可选,初次运行可用本地 bleu。
A
Note: 当前的性能指标测试基于很早期的版本。最新版本在性能和功能上都有显著的改进。我们鼓励您参考最新的发布版本, 该版本具有自主分布式存储和增强的计算推下能力。或者,您可以等待社区更新相关测试数据 (也欢迎反馈共建)。
A
插件接入计划用于 1.8.0 的共享基础模块 API 时,请按Java/SPI 迁移指南调整并使用配套 artifacts 重新编译。 下方示例描述 1.7.0 API。 背景 HugeGraph 不仅开源开放,而且要做到简单易用,一般用户无需更改源码也能轻松增加插件扩展功能。 HugeGraph 支持多种内置存储后端,也允许用户无需更改现有源码的情况下扩展自定义后端。 HugeGraph 支持全文检索,全文检索功能涉及到各语言分词,目前已内置 7 种分词器(ansj、hanlp、smartcn、jieba、jcseg、mmseg4j、ikanalyzer),也允许用户无需更改现有源码的情况下扩展自定义分词器。 可扩展维度 目前插件方式提供如下几个维度的扩展项:
A
Gremlin-Console 是 TinkerPop 的交互式客户端,支持离线操作图,也可以连接 Server 提交查询。常用 Gremlin 遍历语法与示例请参阅 Gremlin 查询语言。主要包含两种工作模式: 单机离线调用模式 — 直接执行 Groovy 脚本操作 HugeGraph-Core,无需启动 Server 服务。 Client/Server 请求模式 — 通过 WebSocket 连接运行中的 HugeGraph Server,远程执行 Gremlin 查询。 说明 Gremlin-Console 适合快速体验、原型探索与排查调试,不推荐直接用于高并发或高吞吐的生产环境。生产环境建议使用相应语言的客户端(如 HugeGraph-Client)。
A
HugeGraph Go Client 是 Toolchain 仓库中的 Go SDK,目前提供版本查询、Schema(PropertyKey、VertexLabel、EdgeLabel)、顶点和 Gremlin API。边数据 API 尚未实现。
A
Computer 配置选项 表格中的默认值来自 computer-api 模块的 ComputerOptions.java;发行包的 conf/computer.properties 显式设置的值以“代码默认值(发行包:实际值)”标注。rpc.* 等通用配置由 HugeGraph Commons 提供,以下会单独标出发行包实际值。
A
HugeGraph 使用 dev@hugegraph.apache.org 讨论开发和使用问题。向列表发信前需要先订阅,否则邮件可能被拦截。 订阅 使用准备订阅的邮箱向 dev-subscribe@hugegraph.apache.org 发送一封任意主题、任意内容的邮件。 收到确认邮件后直接回复。 收到订阅成功邮件后,即可向 dev@hugegraph.apache.org 发信。 如果没有收到确认邮件,先检查垃圾邮件和自动分类目录。仍未收到时,等待一段时间后重新发送订阅邮件。
A
1. 属性图模型 版本说明:本页保留早期设计内容。属性图模型和顶点 ID 策略仍与 当前主线源码相符;图示、分区结论及事务实现描述按各节注明的范围阅读,不能直接当作当前部署或存储实现说明。
A
1 HugeGraph-PD 概述 HugeGraph-PD(Placement Driver)是 HugeGraph 分布式版本的元数据管理组件,负责管理图数据的分布和存储节点的协调。它在分布式 HugeGraph 中扮演着核心角色,维护集群状态并协调 HugeGraph-Store 存储节点。
A
如果你需要把数据从一张 HugeGraph 图复制到另一张图,使用 graph2graph:HugeGraph Source 从源图(A 图)读取顶点和边,数据经过可选的 Transform 后,由 HugeGraph Sink 写入目标图(B 图)。数据方向是 A 图 → HugeGraph Source →(可选 Transform)→ HugeGraph Sink → B 图。如果要把图数据导出到文件、JDBC、Kafka 等其他系统,则使用 graph2any,由下游 Sink 接收 Source 读取的数据。本文介绍这两类任务。
A
SeaTunnel 可以把数据库、Kafka 等数据源接入 HugeGraph。连接器分为两部分:Source 负责读取,Sink 负责写入[1][2],中间可以接 SeaTunnel 的数据转换组件。需要从 HugeGraph 导出或迁移数据时,请查看SeaTunnel Source 导出与迁移文档。
A
本文以 Toolchain master 分支(以 1.8 为基线,尚未正式发布)为准。发布版和 Docker latest 可能存在部分差异,使用未发布功能前请先核对版本。 快速上手:本地文件导入 下面通过一个最简示例体验 Loader 的基本导入流程:导入两个人和一条关系,并在 Hubble 中查询验证。 请先安装 Loader 并启动 HugeGraph Server。 以下命令均在 Loader 安装目录下执行,连接本地默认图 hugegraph。若 Server 已启用鉴权,在命令中追加 --username 与 --password(或 --token)。
A
1. 组件说明 HugeGraph-Computer 是基于 BSP(Bulk Synchronous Parallel,批量同步并行)模型的 Java 分布式图计算框架,算法按超步迭代运行。它可由 Kubernetes Operator 或 YARN 调度,也可在单机上启动 master 和 worker 进程进行小规模试跑。
A
Note: 当前的性能指标测试基于很早期的版本。最新版本在性能和功能上都有显著的改进。我们鼓励您参考最新的发布版本, 该版本具有自主分布式存储和增强的计算推下能力。或者,您可以等待社区更新相关测试数据 (也欢迎反馈共建)。
A
表格中的默认值指选项未在配置文件中显式设置时采用的源码默认值;发行包配置文件可能写入不同的值并覆盖它,实际运行值应以对应安装包的配置文件为准。
A
hugegraph-python-client 是 HugeGraph 的 Python SDK,可管理 Schema、读写图数据并执行 Gremlin 查询。HugeGraph-LLM 和 HugeGraph-ML 也使用这个客户端。 该模块位于 hugegraph-ai 仓库的 hugegraph-python-client/ 目录下,导入名为 pyhugegraph。
A
1.2 PropertyKey Params 说明: name:属性类型名称,必填 data_type:属性类型数据类型,包括:bool、byte、int、long、float、double、text、date、uuid、blob,默认 text 类型 (代表 string 字符串类型) cardinality:属性类型基数,包括:single、list、set,默认 single (代表单属性值) 请求体字段说明:
A
HugeGraph-ML 从 HugeGraph 读取图数据并转换为 DGL 图,供节点嵌入、节点分类、图分类、链接预测和欺诈检测等任务使用。模型实现位于 hugegraph-ml/src/hugegraph_ml/models/。 环境要求 Python 3.10 或更高版本 HugeGraph Server 1.5.0 或更高版本;当前 workspace 中的 Python 客户端会拒绝可探测到的更低版本 uv 0.7 或更高版本 所有服务端访问都通过同一仓库中的 hugegraph-python-client(即 pyhugegraph 包)完成。HugeGraph2DGL 使用 Gremlin 接口的 g.V().hasLabel(...) 和 g.E().hasLabel(...) 拉取点边,数据集导入函数则通过 schema 接口和顶点、边的批量接口写入,每批 500 条。
A
本文的代码都是java语言写的,但其风格与gremlin(groovy)是非常类似的。用户只需要把代码中的变量声明替换成def或直接去掉, 就能将java代码转变为groovy;另外就是每一行语句最后可以不加分号,groovy认为一行就是一条语句。
A
1 概述 本示例将TitanDB Getting Started 为模板来演示 HugeGraph 的使用方法。通过对比 HugeGraph 和 TitanDB,了解 HugeGraph 和 TitanDB 的差异。 1.1 HugeGraph 与 TitanDB 的异同 HugeGraph 和 TitanDB 都是基于Apache TinkerPop3框架的图数据库,均支持Gremlin图查询语言,在使用方法和接口方面具有很多相似的地方。然而 HugeGraph 是全新设计开发的,其代码结构清晰,功能较为丰富,接口更为友好等特点。
A
本篇重点介绍 HStore + PD 分布式部署与单机 RocksDB 的核心差异。图建模、数据导入和图遍历等通用操作请参考 Hubble 基础与单机指南。 内容以 Toolchain、Server、PD 与 Store 的 master 分支(当前版本均为 1.8.0)为准。
A
指南: 推荐使用已发布的软件包。Server 1.7.0 建议使用 Java 11,其他 JDK 的支持范围见 Server 启动指南;Toolchain、AI、Vermeer 等组件的运行环境请按各自版本的快速入门核对。 验证下载版本, 请使用相应的哈希 (SHA512)、签名和 项目签名验证 KEYS 检查哈希 (SHA512)、签名的说明在 版本验证 页面, 也可参考 ASF 验证说明 注: HugeGraph 所有组件版本号已保持一致, client/loader/hubble/common 等 maven 仓库版本号同理, 依赖引用可参考 maven 示例 兼容说明: HugeGraph 于 2026 年 1 月毕业后,下载路径已从 /incubator/hugegraph 迁移到 /hugegraph。历史版本的发布文件名可能仍包含 -incubating-。 从源码构建请参考 编译构建说明 文件名中的 src 表示源码包,需要按对应组件的指南编译,不能直接按二进制包的目录执行启动脚本。源码主线…
A
选择贡献方式 可以通过 GitHub Issues 报告问题,也可以提交代码、测试或文档。准备较大的改动前,建议先创建 Issue 并说明范围,避免重复工作。
A
全栈组件 HugeGraph 生态由职责不同的图数据库、图计算、图 AI 和工具链组件组成。HugeGraph Server 提供 OLTP 图数据库服务;HugeGraph-Computer 与 Vermeer 是独立的 OLAP 图计算引擎;HugeGraph-AI 提供图 AI 能力。Toolchain 中的客户端、数据导入、可视化和运维工具为应用及运维人员提供配套入口。