hugegraph
/
hugegraph-sync
mirror of https://github.com/apache/hugegraph
0
0
Fork 2
Code Issues Packages Projects Releases Wiki Activity
hugegraph-sync/hugegraph-commons
History
imbajin 2fb3ced8cc docs: add AGENTS.md with project guidance 
Introduced AGENTS.md files to the root and all major modules to provide AI coding tool guidance, including architecture, build, test, and development workflows for each component.

Updated .gitignore to exclude various AI prompt files, ensuring only AGENTS.md is kept and others can be soft-linked as needed.
 		2025-10-29 15:58:32 +08:00
..
hugegraph-common chore: bump project version from 1.5.0 to 1.7.0 (#72) 2025-10-29 15:58:32 +08:00
hugegraph-dist fix(test): fix test to support graphSpace 2025-10-29 15:58:32 +08:00
hugegraph-rpc refactor: centralize version management in project (#2797) 2025-06-25 19:51:50 +08:00
AGENTS.md docs: add AGENTS.md with project guidance 2025-10-29 15:58:32 +08:00
README.md git mv to hugegraph-commons 2024-08-03 20:34:23 +08:00
pom.xml chore: bump project version from 1.5.0 to 1.7.0 (#72) 2025-10-29 15:58:32 +08:00

README.md

hugegraph-commons

License codecov Maven Central CodeQL hugegraph-commons ci

hugegraph-commons is a common module for HugeGraph and its peripheral components. hugegraph-commons encapsulates locks, configurations, events, iterators, rest and some numeric or collection util classes to simplify the development of HugeGraph and its components.

Components

  • Lock: atomic lock, key lock, lock group and lock manger
  • Config: register and load config option with security check
  • Event: listening and notification, do something asynchronously
  • Iterator: some iterators with extra functions, map, filter, extend, etc.
  • Rest: RESTful client implemented on OkHttp, POST, PUT, GET and DELETE
  • Util: performance analyzer, version checker, numeric and Collection utils, log and exception utils, etc.
  • Rpc: rpc component for inner module communication, currently it's based on Sofa-RPC

You could use import the dependencies in maven like this:

  <dependency>
       <groupId>org.apache.hugegraph</groupId>
       <artifactId>hugegraph-common</artifactId>
       <version>1.2.0</version>
  </dependency>

Learn More

The doc page contains more information about hugegraph modules.

And here are links of other repositories:

  1. hugegraph-server (graph's core component - OLTP server)
  2. hugegraph-toolchain (include loader/dashboard/tool/client)
  3. hugegraph-computer (graph processing system - OLAP)
  4. hugegraph-website/doc (include doc & website code)

Contributing

  • Welcome to contribute to HugeGraph, please see How to Contribute 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

Licence

Same as HugeGraph, hugegraph-commons are also licensed under Apache 2.0 License.

Contact Us

QR png