Go SDK

Build and execute HelixDB requests with ordinary Go functions

Guide

The Go SDK builds the shared operation-tree AST and executes requests through a typed HTTP client.

Version v0.3.1 ships the server query builder and HTTP client. It does not distribute the native bindings required by embedded execution or native graph algorithms.

The module path remains github.com/helixdb/helix-db/sdks/go; it does not add a /v3 suffix because the module itself has not reached major version 2.

Install

go get github.com/helixdb/helix-db/sdks/go@v0.3.1

import helix "github.com/helixdb/helix-db/sdks/go"

Define a query

func FindUsers(tenantID string, limit int64) helix.Request {
	q := helix.ReadQuery("find_users")
	tenant := q.ParamString("tenant_id", tenantID)
	maxRows := q.ParamI64("limit", limit)

	return q.
		VarAs(
			"users",
			helix.G().
				NWithLabel("User").
				Where(helix.PredEq("tenantId", tenant)).
				Limit(maxRows).
				ValueMap("$id", "name", "tenantId"),
		).
		Returning("users")
}

Execute

client, err := helix.NewClient("http://localhost:6969")
if err != nil {
	return err
}

var response struct {
	Users []map[string]any `json:"users"`
}
if err := client.Exec(ctx, FindUsers("acme", 25), &response); err != nil {
	return err
}

Write requests can pass helix.WriterOnly() and helix.AwaitDurability(true) execution options. The client does not retry conflicts automatically.

Release scope

Use v0.3.1 with a local or remote Helix server through /v2/query. Embedded constructors and Client.Graph return native-binding-unavailable errors in a standard module installation.

Verify

cd sdks/go
go test ./...

Next steps

Parameters

Bind typed values and bounds.

Error handling

Diagnose validation, conflict, and runtime failures.