40 lines
2.3 KiB
Markdown
40 lines
2.3 KiB
Markdown
# hugegraph-commons
|
|
|
|
[](https://www.apache.org/licenses/LICENSE-2.0.html)
|
|
[](https://codecov.io/gh/hugegraph/hugegraph-common)
|
|
[](https://mvnrepository.com/artifact/org.apache.hugegraph/hugegraph-common)
|
|
|
|
hugegraph-commons is a common module for [HugeGraph](https://github.com/apache/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 Jersey, 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](https://github.com/sofastack/sofa-rpc)
|
|
|
|
## Learn More
|
|
|
|
The [doc page](https://hugegraph.apache.org/docs/) contains more information about hugegraph modules.
|
|
|
|
And here are links of other repositories:
|
|
1. [hugegraph-server](https://github.com/apache/hugegraph) (graph's core component - OLTP server)
|
|
2. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (include loader/dashboard/tool/client)
|
|
3. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (graph processing system - OLAP)
|
|
4. [hugegraph-website/doc](https://github.com/apache/hugegraph-doc) (include doc & website code)
|
|
|
|
## Contributing
|
|
|
|
Welcome to contribute, please see [`How to Contribute`](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md) for more information
|
|
|
|
Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to **greatly simplify** the PR and commit process.
|
|
|
|
## Licence
|
|
|
|
Same as HugeGraph, hugegraph-commons is also licensed under `Apache 2.0` License.
|