README.md

hugegraph-toolchain

hugegraph-toolchain is the integration project contains a series of utilities for HugeGraph, it includes 5+ main modules.

Modules

• hugegraph-loader: Loading datasets into the HugeGraph from multiple data sources.
• hugegraph-hubble: Online HugeGraph management and analysis dashboard (Include: data loading, schema management, graph traverser and display).
• hugegraph-tools: Command line tool for deploying, managing and backing-up/restoring graphs from HugeGraph.
• hugegraph-client: A Java-written client for HugeGraph, providing RESTful APIs for accessing graph vertex/edge/schema/gremlin/variables and traversals etc.
• hugegraph-client-go: A Go-written client for HugeGraph, providing RESTful APIs for accessing graph vertex/edge/schema/gremlin/variables and traversals etc. (WIP)
• hugegraph-spark-connector: A Spark connector for reading & writing HugeGraph data in Spark standard format.

Usage

• hugegraph-loader: We can follow the doc to learn how to quickly start with loader.
• hugegraph-hubble: We can follow the doc to learn how to quickly start with hubble.
• hugegraph-client: We can follow the doc to learn how to quickly start with client.

Maven Dependencies

You could use import the dependencies in maven like this:

  <!-- Note: use the latest release version in maven repo, here is just an example -->
  <dependency>
       <groupId>org.apache.hugegraph</groupId>
       <artifactId>hugegraph-client</artifactId>
       <version>1.5.0</version>
  </dependency>
  
  <dependency>
       <groupId>org.apache.hugegraph</groupId>
       <artifactId>hugegraph-loader</artifactId>
       <version>1.5.0</version>
  </dependency>

And here are links of other HugeGraph component/repositories:

1. hugegraph (pd/store/server/commons)
2. hugegraph-computer (integrated graph computing system)
3. hugegraph-ai (integrated Graph AI/LLM/KG system)
4. hugegraph-website (doc & website code)

Doc

The project homepage contains more information about hugegraph-toolchain.

License

hugegraph-toolchain is licensed under Apache 2.0 License.

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!

Contact Us

---

• GitHub Issues: Feedback on usage issues and functional requirements (quick response)
• Feedback Email: [email protected] (subscriber only)
• WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us.