rockset

package module
v0.5.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 23, 2019 License: Apache-2.0 Imports: 4 Imported by: 15

README

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 sample examples of how to create a collection, how to put documents in a collection and how to use SQL to query your collections.

Testing

Tests are available in the Test folder.

Set ROCKSET_APIKEY and ROCKSET_APISERVER endpoint in the environment variables. To run tests:

go test ./test

Support

Feel free to log issues against this client through GitHub.

License

The Rockset Go Client is licensed under the Apache 2.0 License

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Version = "0.5.9"

Functions

This section is empty.

Types

type RockClient

type RockClient struct {

	// API Services
	ApiKeys     *api.ApiKeysApiService
	Collection  *api.CollectionsApiService
	Integration *api.IntegrationsApiService
	Documents   *api.DocumentsApiService
	QueryApi    *api.QueriesApiService
	Users       *api.UsersApiService
	// contains filtered or unexported fields
}

func Client

func Client(apiKey string, apiServer string) *RockClient

Create a Client object to securely connect to Rockset using an API key Optionally, an alternate API server host can also be provided.

func (*RockClient) Query

Execute a query against Rockset

Directories

Path Synopsis
lib
go
openapi module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL