gospice

gospice

Golang SDK for Spice.ai

See Go Docs at pkg.go.dev/github.com/spiceai/gospice/v3.

For full documentation visit docs.spice.ai.

Usage

Note: There is a bug in Apache Arrow v13 that causes a high rate of errors from concurrent queries. We've addressed this in our fork. To apply the fix, add the following to your go.mod file until the fix is released upstream:

replace github.com/apache/arrow/go/v13 => github.com/spicehq/arrow/go/v13 v13.0.0-20231011105758-b46797bef61d

1. Get the gospice package.

go get github.com/spiceai/gospice/v3

1. Import the package.

import "github.com/spiceai/gospice/v3"

1. Create a SpiceClient passing in your API key. Get your free API key at spice.ai.

spice := NewSpiceClient()
defer spice.Close()

1. Initialize the SpiceClient.

if err := spice.Init("API Key"); err != nil {
    panic(fmt.Errorf("error initializing SpiceClient: %w", err))
}

1. Execute a query and get back an Apache Arrow Reader.

    reader, err := spice.Query(context.Background(), "SELECT * FROM eth.recent_blocks ORDER BY number LIMIT 10")
    if err != nil {
        panic(fmt.Errorf("error querying: %w", err))
    }
    defer reader.Release()

1. Iterate through the reader to access the records.

    for reader.Next() {
        record := reader.Record()
        defer record.Release()
        fmt.Println(record)
    }

Example

Run go run . to execute a sample query and print the results to the console.

See client_test.go for examples on querying Ethereum and Polygon blocks.