Rockset Go Client

Official Go client library for Rockset

Installation

Install the Rockset Go client from Github:

go get github.com/rockset/rockset-go-client

or install it from a source code checkout:

cd $GOPATH/src/github.com
mkdir rockset
cd rockset
git clone git@github.com:rockset/rockset-go-client.git
go install rockset-go-client/rockclient.go

Usage

You can see a few examples in the godoc of how to create a collection, how to put documents in a collection and how to use SQL to query your collections.

client, err := rockset.NewClient()
if err != nil {
    log.Fatal(err)
}

ctx := context.TODO()
q := `SELECT * FROM "_events" LIMIT 1`

res, _, err := client.Query(ctx, q)
if err != nil {
    log.Fatal(err)
}

fmt.Printf("%+v\n", res)

Updating the OpenAPI specification

If the OpenAPI specification has changed, you need to regenerate the OpenAPI client

# bump the minor version
vi version.go 
# generate a new client
./generate.sh
# record new VCR cassettes
VCR_MODE=record go test ./...

Testing

There are a number of testable examples which require an API key, i.e. set the ROCKSET_APIKEY and ROCKSET_APISERVER environment variables.

To run tests:

go test -v -timeout 30m ./...

To generate the fakes used for testing:

go generate ./...

Go VCR

Most tests use Go VCR, and they will use a cassette (recorded response) by default, so if you want to re-record a cassette, set the environment variable VCR_MODE to record.

The VCR tracks ignore the patch version of the client version, so when the OpenAPI spec is updated you have to re-record the VCR cassettes.

If you don't have git lfs set up, install before committing new recordings:

brew install git-lfs
git lfs install
git lfs track "*.cassette.gz"

Code Coverage

go test ./... -coverprofile cover.out
go tool cover -func=cover.out
go tool cover -html=cover.out -o coverage.html

Support

Feel free to log issues against this client through GitHub.

License

The Rockset Go Client is licensed under the Apache 2.0 License

Cutting a New Release

• Update the version in version.go
• Run generate.sh
  • If you run into issues with this script, try running git submodule update --init
• Run go mod tidy
• Re-record VCR cassettes rm -rf testdata/cassettes/ && VCR_MODE=record go test -v -timeout 30m ./...
  • If you have not already, make sure to set up git lfs before committing: brew install git-lfs && git lfs install && git lfs track "*.cassette.gz"
• Push and merge branch
• Run git tag v{version_number} on master
• Run git push origin v{version_number}