Go to file
imbajin 58c1a58797
docs: add DeepWiki badge to README (#2883)
* feat: add switch for role election

* feat: classNotCass

* Update role election default and refactor TaskManager

Changed the default value of the role election option to false in ServerOptions. Refactored TaskManager for improved readability, updated comments, removed unnecessary protected modifiers, and streamlined thread pool initialization and shutdown logic. Added deprecation notice for local master-worker mechanism.

* docs: add DeepWiki badge to README

- Add DeepWiki badge for interactive documentation access
- Badge enables users to easily access AI-powered documentation assistant
- Positioned with other project badges for consistency

---------

Co-authored-by: vaughn <vaughn@apache.org>
2025-10-05 11:25:41 -05:00
.github BREAKING CHANGE(server): disable legacy backends include `MySQL/PG/c*`(.etc) (#2746) 2025-04-28 15:20:37 +08:00
.idea chore: make IDEA support IssueNavigationLink and add icon (#2521) 2024-04-15 15:31:12 +08:00
docker feat(dist): support docker deployment for PD and Store (#2573) 2024-07-15 11:12:25 +08:00
hugegraph-cluster-test chore: improve maven Reproducible Builds (#2874) 2025-09-20 14:27:24 +08:00
hugegraph-commons refactor: centralize version management in project (#2797) 2025-06-25 19:51:50 +08:00
hugegraph-pd chore: improve maven Reproducible Builds (#2874) 2025-09-20 14:27:24 +08:00
hugegraph-server refactor: remove the package existing in java8 (#2792) 2025-09-28 12:24:20 +08:00
hugegraph-store chore: improve maven Reproducible Builds (#2874) 2025-09-20 14:27:24 +08:00
install-dist fix(dist): add license for swagger-ui & reset use stage to false in ci yml (#2706) 2024-12-30 23:05:24 +08:00
style fix(server): unify the license headers (#2438) 2024-02-07 12:53:57 +08:00
.asf.yaml Update .asf.yaml (#2751) 2025-04-14 16:29:55 +08:00
.editorconfig chore: migrate the `hg-style.xml` to `.editorconfig` (#2561) 2024-06-28 22:34:07 +08:00
.gitattributes chore(dist): fix licenses and remove empty files (#2692) 2024-11-12 16:09:55 +08:00
.gitignore chore(dist): tar source and binary package for hugegraph with pd-store (#2594) 2024-08-06 21:21:14 +08:00
.licenserc.yaml chore: reset license header for file declared in LICENSE (#2550) 2024-06-11 10:08:23 +08:00
BUILDING.md chore(commons): basic adapt for commons migration 2024-08-21 16:09:00 +08:00
CONTRIBUTING.md docs: update repo artifacts references (#2695) 2024-11-19 00:09:25 +08:00
DISCLAIMER chore: add DISCLAIMER & NOTICE & LICENSE file to binary package (#2071) 2023-01-06 22:44:43 +08:00
LICENSE fix: update resource references (#2522) 2024-04-16 15:10:49 +08:00
NOTICE chore: update notice year (#2826) 2025-07-09 11:59:53 +08:00
README.md docs: add DeepWiki badge to README (#2883) 2025-10-05 11:25:41 -05:00
pom.xml chore: improve maven Reproducible Builds (#2874) 2025-09-20 14:27:24 +08:00

README.md

hugegraph-logo

A graph database that supports more than 10 billion vertices & edges, high performance and scalability

License HugeGraph-CI License checker GitHub Releases Downloads Ask DeepWiki

What is Apache HugeGraph?

HugeGraph is a fast and highly-scalable graph database. Billions of vertices and edges can be easily stored into and queried from HugeGraph due to its excellent OLTP capabilities. HugeGraph is compliant with the Apache TinkerPop 3 framework allowing complicated graph queries to be achieved through the powerful Gremlin graph traversal language.

Features

  • Compliant to Apache TinkerPop 3, supports Gremlin & Cypher language
  • Schema Metadata Management, including VertexLabel, EdgeLabel, PropertyKey and IndexLabel
  • Multi-type Indexes, supporting exact query, range query and complex conditions combination query
  • Plug-in Backend Store Framework, mainly support RocksDB/HStore + HBase for now and you could choose other backends in the legacy version1.5.0 (like MySQL/PG/Cassandra ...)
  • Integration with Flink/Spark/HDFS, and friendly to connect other big data platforms
  • Complete graph ecosystem (including both in/out-memory Graph Computing + Graph Visualization & Tools + Graph Learning & AI, see here)

Quick Start

1. Docker (For Test)

Use Docker to quickly start a HugeGraph server with RocksDB (in the background) for testing or development:

# (Optional) 
# - add "-e PRELOAD=true" to auto-load a sample graph
docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 hugegraph/hugegraph:1.5.0

Please visit doc page or the README for more details. (Docker Compose)

Note:

  1. The Docker image of HugeGraph is a convenience release, but not official distribution artifacts. You can find more details from ASF Release Distribution Policy.
  2. Recommend to use release tag (like 1.5.0/1.x.0) for the stable version. Use latest tag to experience the newest functions in development.

2. Download

Visit Download Page and refer the doc to download the latest release package and start the server.

Note: if you want to use it in the production environment or expose it to the public network, must enable the AuthSystem to ensure safe.

3. Build From Source

Visit Build From Source Page and follow the steps to build the source code and start the server.

The project doc page contains more information on HugeGraph and provides detailed documentation for users. (Structure / Usage / API / Configs...)

And here are links of other HugeGraph component/repositories:

  1. hugegraph-toolchain (graph tools loader/dashboard/tool/client)
  2. hugegraph-computer (integrated graph computing system)
  3. hugegraph-ai (integrated Graph AI/LLM/KG system)
  4. hugegraph-website (doc & website code)

License

HugeGraph is licensed under Apache 2.0 License.

Contributing

  • Welcome to contribute to HugeGraph, please see How to Contribute & Guidelines for more information.
  • Note: It's recommended to use GitHub Desktop to greatly simplify the PR and commit process.
  • Thank you to all the people who already contributed to HugeGraph!

contributors graph

Thanks

HugeGraph relies on the TinkerPop framework, we refer to the storage structure of Titan and the schema definition of DataStax. Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other organizations or authors who contributed to the project.

You are welcome to contribute to HugeGraph, and we are looking forward to working with you to build an excellent open-source community.

Contact Us

QR png