helix-go

The official Go SDK for HelixDB

Getting Started

Setting up HelixDB

Install HelixCLI

curl -sSL "https://install.helix-db.com" | bash
helix install
helix init

Create a HelixQL schema

// ./helixdb-cfg/schema.hx
N::User {
    name: String,
    age: U32,
    email: String,
    created_at: I32,
    updated_at: I32,
}

Create HelixQL queries

// ./helixdb-cfg/queries.hx
QUERY create_user(name: String, age: U32, email: String, now: I32) =>
    user <- AddN<User>({name: name, age: age, email: email, created_at: now, updated_at: now})
    RETURN user

QUERY get_users() =>
    users <- N<User>
    RETURN users

Check for queries (optional)

helix check

Deploy HelixQL queries

helix deploy

Using Go with HelixDB

Install helix-go

go get github.com/HelixDB/helix-go

Send requests to HelixDB

// ./main.go
var HelixClient *helix.Client

// Create user struct
type User struct {
	Name      string
	Age       int32
	Email     string
	CreatedAt int32 `json:"created_at"`
	UpdatedAt int32 `json:"updated_at"`
}

// Create a type struct for the "get_users" query
type GetUsersResponse struct {
	Users []User `json:"users"`
}

// Create a type struct for the "create_users" query
type CreateUserResponse struct {
	User []User `json:"user"`
}

func main() {

	// Connect to client
	HelixClient = helix.NewClient("http://localhost:6969")

	// Create user data

	now := time.Now()

	timestamp := now.Unix()

	timestamp32 := int32(timestamp)

	newUser := map[string]any{
		"name":  "John",
		"age":   21,
		"email": "johndoe@email.com",
		"now":   timestamp32,
	}

	// Create user in Helix
	var createdUser CreateUserResponse
	err := HelixClient.Query(
		"create_user",
		helix.WithData(newUser),
	).Scan(&createdUser)
	if err != nil {
		log.Fatalf("Error while creating user: %s", err)
	}

	fmt.Println(createdUser)

	// Get all users and put Helix's response in GetUsersResponse
	var getUsersResponse GetUsersResponse
	err = HelixClient.Query("get_users").Scan(&getUsersResponse)
	if err != nil {
		log.Fatalf("Error while getting users: %s", err)
	}

	fmt.Println(getUsersResponse)

	// Get all users and put "users" from Helix's response in the `users` variable
	var users []User
	err = HelixClient.Query("get_users").Scan(
		helix.WithDest("users", &users),
	)
	if err != nil {
		log.Fatalf("Error while getting users: %s", err)
	}

	fmt.Println(users)

	// Get all users in go's `map` data type
	usersMap, err := HelixClient.Query("get_users").AsMap()
	if err != nil {
		log.Fatalf("Error while getting users: %s", err)
	}

	fmt.Println(usersMap["users"])
}