HelixDB Docs

helix-go is a Go library for interacting with helix-db a powerful graph-vector database written in rust. It enables intuitive and type-safe access to graph-based and vector-based queries, making it ideal for building knowledge graphs, search systems, and LLM pipelines.

Installation

go get github.com/HelixDB/helix-go

Quick Start

package main

import (
    "fmt"
    "log"

    "github.com/HelixDB/helix-go"
)

func main() {
    client := helix.NewClient("http://localhost:6969")

    payload := map[string]any{
        "name": "Alice",
        "age":  uint8(25),
    }

    var result map[string]any
    err := client.
        Query("AddUser", helix.WithData(payload)).
        Scan(&result)
    if err != nil {
        log.Fatalf("AddUser query failed: %s", err)
    }

    fmt.Printf("Created user: %#v\n", result)
}

QUERY AddUser(name: String, age: U8) =>
    user <- AddN<User>({
        name: name,
        age: age
    })
    RETURN user

N::User {
    name: String,
    age: U8
}

Configuration

Custom Endpoint

client := helix.NewClient("https://my-endpoint.com:8080")

Pass your deployment URL to connect to a remote HelixDB instance.