HugeGraph-Java-Client

Mon, 01 Jan 0001 00:00:00 +0000

1 Overview Of Hugegraph

HugeGraph-Client sends HTTP request to HugeGraph-Server to get and parse the execution result of Server. We support HugeGraph-Client for Java/Go/Python language. You can use Client-API to write code to operate HugeGraph, such as adding, deleting, modifying, and querying schema and graph data, or executing gremlin statements.

HugeGraph client SDK tool based on Go language (version >=1.2.0)

2 What You Need

Java 11 (also supports Java 8)
Maven 3.5+

3 How To Use

The basic steps to use HugeGraph-Client are as follows:

HugeGraph Python Client Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

The hugegraph-python-client is a Python client/SDK for HugeGraph Database.

It is used to define graph structures, perform CRUD operations on graph data, manage schemas, and execute Gremlin queries. Both the hugegraph-llm and hugegraph-ml modules depend on this foundational library.

Installation

Install the released package (Stable)

To install the hugegraph-python-client, you can use uv/pip or source code building:

# uv is optional, you can use pip directly
uv pip install hugegraph-python # Note: may not the latest version, recommend to install from source
# WIP: we will use 'hugegraph-python-client' as the package name soon

Install from Source (Latest Code)

To install from the source, clone the repository and install the required dependencies:

HugeGraph Go Client Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

A HugeGraph Client SDK tool based on the Go language.

Software Architecture

(Software architecture description)

Installation Tutorial

go get github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go

Implemented APIs

API	Description
schema	Get schema information
version	Get version information

Usage Instructions

1. Initialize the Client

package main

import (
	"log"
	"os"

	"github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go"
	"github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go/hgtransport"
)

func main() {
	client, err := hugegraph.NewCommonClient(hugegraph.Config{
		Host: "127.0.0.1",
		Port: 8080,
		Graph: "hugegraph",
		Username: "", // Fill in the username according to the actual situation
		Password: "", // Fill in the password according to the actual situation
		Logger: &hgtransport.ColorLogger{
			Output: os.Stdout,
			EnableRequestBody: true,
			EnableResponseBody: true,
		},
	})

	if err != nil {
		log.Fatalf("Error creating the client: %s\n", err)
	}

	// Use the client for operations...
	_ = client // Avoid "imported and not used" error
}

2. Get HugeGraph Version

Get Version Information Using SDK

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go"
	"github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go/hgtransport"
)

// initClient initializes and returns a HugeGraph client instance
func initClient() *hugegraph.CommonClient {
	client, err := hugegraph.NewCommonClient(hugegraph.Config{
		Host: "127.0.0.1",
		Port: 8080,
		Graph: "hugegraph",
		Username: "",
		Password: "",
		Logger: &hgtransport.ColorLogger{
			Output: os.Stdout,
			EnableRequestBody: true,
			EnableResponseBody: true,
		},
	})
	if err != nil {
		log.Fatalf("Error creating the client: %s\n", err)
	}
	return client
}

func getVersion() {
	client := initClient()
	// Assume client has a Version method that returns version information and an error
	// res, err := client.Version() // Actual call
	// Simulate return, as the client.Version() return type in the original README does not fully match the usage here
	type VersionInfo struct {
		Versions struct {
			Version string `json:"version"`
			Core string `json:"core"`
			Gremlin string `json:"gremlin"`
			API string `json:"api"`
		} `json:"versions"`
		// Body io.ReadCloser // Assume there is a Body to close, adjust according to the actual SDK
	}

	// Simulate API call and return
	res := &VersionInfo{
		Versions: struct {
			Version string `json:"version"`
			Core string `json:"core"`
			Gremlin string `json:"gremlin"`
			API string `json:"api"`
		}{
			Version: "1.0.0", // Example version
			Core: "1.0.0",
			Gremlin: "3.x.x",
			API: "v1",
		},
	}
	// err := error(nil) // Assume no error

	// if err != nil {
	// 	log.Fatalf("Error getting the response: %s\n", err)
	// }
	// defer res.Body.Close() // If there is a Body, it needs to be closed

	fmt.Println(res.Versions)
	fmt.Println(res.Versions.Version)
}

func main() {
	getVersion()
}

Structure of the Return Value

package main

// VersionResponse defines the structure returned by the version API
type VersionResponse struct {
	Versions struct {
		Version string `json:"version"` // hugegraph version
		Core string `json:"core"` // hugegraph core version
		Gremlin string `json:"gremlin"` // hugegraph gremlin version
		API string `json:"api"` // hugegraph api version
	} `json:"versions"`
}

HugeGraph Client on Apache HugeGraph

HugeGraph-Java-Client

1 Overview Of Hugegraph

2 What You Need

3 How To Use

HugeGraph Python Client Quick Start

Installation

Install the released package (Stable)

Install from Source (Latest Code)

HugeGraph Go Client Quick Start

Software Architecture

Installation Tutorial

Implemented APIs

Usage Instructions

1. Initialize the Client

2. Get HugeGraph Version

Get Version Information Using SDK

Structure of the Return Value

API Reference