This document provides a high-level introduction to Apache HugeGraph, a distributed graph database system. It covers the system's purpose, architecture, key features, deployment modes, and major components. For detailed information about specific subsystems, refer to the following child pages:
Sources: README.md23-31 pom.xml28-31
Apache HugeGraph is a fast-speed and highly-scalable graph database that supports more than 100 billion data entities with high performance and scalability. It is an OLTP (Online Transaction Processing) graph engine compliant with the Apache TinkerPop 3 framework, enabling complex graph queries through the Gremlin graph traversal language.
Key Characteristics:
Sources: README.md25-28 pom.xml28-31 hugegraph-store/README.md8-20
Apache HugeGraph is designed with a layered architecture that bridges high-level query languages to low-level distributed storage.
The following diagram associates natural language system components with their specific code entities and identifiers within the codebase.
Diagram: Bridging Natural Language Space to Code Entity Space
Sources: README.md59-99 hugegraph-store/README.md59-73 hugegraph-store/docs/development-guide.md93-109
The project is organized as a multi-module Maven project. The root pom.xml defines the primary modules that constitute the ecosystem.
| Module | Description | Code Location |
|---|---|---|
hugegraph-server | Core graph engine, REST API, and Gremlin/Cypher support | hugegraph-server/ |
hugegraph-pd | Placement Driver for distributed metadata and partition management | hugegraph-pd/ |
hugegraph-store | Distributed storage engine with Raft consensus | hugegraph-store/ |
hugegraph-commons | Shared utilities, RPC, and common configurations | hugegraph-commons/ |
hugegraph-struct | Common data structures (Schema, Vertex, Edge) | hugegraph-struct/ |
Sources: pom.xml101-109 README.md108-116
HugeGraph supports two primary deployment modes to cater to different scales and reliability requirements. For detailed guides, see Deployment.
| Mode | Components | Use Case | Data Scale | High Availability |
|---|---|---|---|---|
| Standalone | Server + RocksDB (embedded) | Development, Testing | < 1TB | Basic |
| Distributed | Server + PD (3-5 nodes) + Store (3+ nodes) | Production, HA | < 1000 TB | Yes (Raft) |
Diagram: Deployment Mode Code Associations
Sources: README.md101-107 hugegraph-store/README.md28-40
Apache HugeGraph includes a comprehensive toolchain for data management and analysis:
The project is governed by the Apache Software Foundation, ensuring open development and license compliance pom.xml2-16 Automated CI/CD pipelines handle license checking and code quality README.md10-11
Sources: README.md39-53 .asf.yaml1-26 .github/workflows/licence-checker.yml1-32
hg-store-node and PartitionService interact, see Ecosystem Components.