rockset

May 28, 2024

Changes in this version

type RockClient

+ func (rc *RockClient) AddDocumentsRaw(ctx context.Context, workspace, collection string, docs json.RawMessage) ([]openapi.DocumentStatus, error)

Apr 4, 2024

Changes in this version

type RockClient

+ func (rc *RockClient) CreateScheduledLambda(ctx context.Context, workspace, apikey string, cronString string, ...) (openapi.ScheduledLambda, error)

+ func (rc *RockClient) DeleteScheduledLambda(ctx context.Context, workspace, scheduledLambdaRRN string) error

+ func (rc *RockClient) GetScheduledLambda(ctx context.Context, workspace, scheduledLambdaRRN string) (openapi.ScheduledLambda, error)

+ func (rc *RockClient) UpdateScheduledLambda(ctx context.Context, workspace string, scheduledLambdaRRN string, ...) (openapi.ScheduledLambda, error)

Feb 7, 2024

Changes in this version

type RockClient

+ func (rc *RockClient) AddDocumentsWithOffset(ctx context.Context, workspace, collection string, docs []interface{}) (openapi.AddDocumentsResponse, error)

+ func (rc *RockClient) DeleteDocumentsWithOffset(ctx context.Context, workspace, collection string, docIDs []string) (openapi.DeleteDocumentsResponse, error)

+ func (rc *RockClient) GetCollectionCommit(ctx context.Context, workspace, name string, offsets []string) (openapi.GetCollectionCommitData, error)

Jan 16, 2024

Changes in this version

type RockConfig

+ APIClient *openapi.APIClient

type RockOption

+ func WithAPIClient(c *openapi.APIClient) RockOption

Nov 2, 2023

Changes in this version

+ var ErrDuplicateCredentials = errors.New("duplicate API credentials provided")

+ var ErrNoAPICredentials = errors.New("no API credentials provided")

+ var ErrNoAPIServer = errors.New("no API server provided")

Oct 10, 2023

Changes in this version

+ var DuplicateCredentialsErr = errors.New("duplicate API credentials provided")

+ var NoAPICredentialsErr = errors.New("no API credentials provided")

+ var NoAPIServerErr = errors.New("no API server provided")

type RockConfig

+ Organization string

+ Token string

type RockOption

+ func WithBearerToken(token, org string) RockOption

Oct 5, 2023

Changes in this version

type RockConfig

+ Wait *wait.Waiter

Sep 13, 2023

Changes in this version

+ const MountActive

+ const MountCreating

+ const MountDeleting

+ const MountExpired

+ const MountRefreshing

+ const MountSuspended

+ const MountSuspending

+ const MountSwitchingRefreshType

type RockClient

+ func (rc *RockClient) ListVirtualInstanceQueries(ctx context.Context, vID string) ([]openapi.QueryInfo, error)

+ func (rc *RockClient) MountCollections(ctx context.Context, vID string, collectionPaths []string) ([]openapi.CollectionMount, error)

+ func (rc *RockClient) WaitUntilMountActive(ctx context.Context, vID, workspace, collection string) error

type RockOption

+ func WithCustomHeader(key, value string) RockOption

Aug 23, 2023

Changes in this version

+ func ValidEntityName(name string) error

May 16, 2023

Changes in this version

+ const DefaultDocumentCount

+ const DefaultFlushInterval

+ const MaxDocumentCount

+ type DocumentAdder interface

+ AddDocuments func(ctx context.Context, workspace, collection string, docs []interface{}) ([]openapi.DocumentStatus, error)

+ type WriteRequest struct

+ Collection string

+ Data interface{}

+ Workspace string

+ type WriteStats struct

+ DocumentCount uint64

+ ErrorCount uint64

+ type Writer struct

+ func NewWriter(conf WriterConfig, client DocumentAdder) (*Writer, error)

+ func (w *Writer) C() chan<- WriteRequest

+ func (w *Writer) Run(ctx context.Context)

+ func (w *Writer) Stats() WriteStats

+ func (w *Writer) Stop()

+ func (w *Writer) Wait()

+ func (w *Writer) Worker(ctx context.Context)

+ func (w *Writer) Workers() int

+ type WriterConfig struct

+ BatchDocumentCount uint64

+ FlushInterval time.Duration

+ Workers uint64

+ func (c WriterConfig) Validate() error

May 1, 2023

Changes in this version

+ const VirtualInstanceActive

+ const VirtualInstanceDeleted

+ const VirtualInstanceInitializing

+ const VirtualInstanceProvisioningResources

+ const VirtualInstanceRebalancingCollections

+ const VirtualInstanceResuming

+ const VirtualInstanceSuspended

+ const VirtualInstanceSuspending

type RockClient

+ func (rc *RockClient) CreateVirtualInstance(ctx context.Context, name string, options ...option.VirtualInstanceOption) (openapi.VirtualInstance, error)

+ func (rc *RockClient) DeleteVirtualInstance(ctx context.Context, vID string) (openapi.VirtualInstance, error)

+ func (rc *RockClient) ExecuteQueryOnVirtualInstance(ctx context.Context, vID string, sql string, options ...option.QueryOption) (openapi.QueryResponse, error)

+ func (rc *RockClient) GetCollectionMount(ctx context.Context, vID, collectionPath string) (openapi.CollectionMount, error)

+ func (rc *RockClient) GetVirtualInstanceQueries(ctx context.Context, vID string) ([]openapi.QueryInfo, error)

+ func (rc *RockClient) ListCollectionMounts(ctx context.Context, vID string) ([]openapi.CollectionMount, error)

+ func (rc *RockClient) MountCollection(ctx context.Context, vID string, collectionPaths []string) ([]openapi.CollectionMount, error)

+ func (rc *RockClient) ResumeVirtualInstance(ctx context.Context, vID string) (openapi.VirtualInstance, error)

+ func (rc *RockClient) SuspendVirtualInstance(ctx context.Context, vID string) (openapi.VirtualInstance, error)

+ func (rc *RockClient) UnmountCollection(ctx context.Context, vID string, collectionPath string) (openapi.CollectionMount, error)

+ func (rc *RockClient) UpdateCollection(ctx context.Context, workspace, name string, ...) (openapi.Collection, error)

+ func (rc *RockClient) WaitUntilVirtualInstanceActive(ctx context.Context, id string) error

+ func (rc *RockClient) WaitUntilVirtualInstanceSuspended(ctx context.Context, id string) error

+ func (rc *RockClient) WaitUntilWorkspaceGone(ctx context.Context, workspace string) error

Dec 12, 2022

Changes in this version

+ func NewErrorWithStatusCode(err error, code int) error

type Error

+ StatusCode int

Nov 2, 2022

Changes in this version

+ func DefaultRetryableErrorCheck(err error) bool

type ExponentialRetry

+ JitterFraction float64

+ RetryableErrorCheck func(error) bool

type RetryableError

+ Retryable func() bool

type RockClient

+ func (rc *RockClient) WaitUntilAliasGone(ctx context.Context, workspace, alias string) error

Oct 27, 2022

Changes in this version

+ const AdminRole

+ const DefaultUserAgent

+ const HeaderVersionName

+ const MemberRole

+ const ReadOnlyRole

type RockClient

+ func (rc *RockClient) UpdateUser(ctx context.Context, email string, roles []string, ...) (openapi.User, error)

+ func (rc *RockClient) WaitUntilCollectionHasDocuments(ctx context.Context, workspace, name string, count int64) error

+ func (rc *RockClient) WaitUntilCollectionHasNewDocuments(ctx context.Context, workspace, name string, count int64) error

+ func (rc *RockClient) WaitUntilQueryCompleted(ctx context.Context, queryID string) error

type RockOption

+ func WithUserAgent(name string) RockOption

Oct 12, 2022

Changes in this version

+ type QueryState string

+ const QueryCancelled

+ const QueryCompleted

+ const QueryError

+ const QueryQueued

+ const QueryRunning

type RockClient

+ func (rc *RockClient) CancelQuery(ctx context.Context, queryID string) (openapi.QueryInfo, error)

+ func (rc *RockClient) CreateAzureBlobStorageIntegration(ctx context.Context, name string, connection string) (openapi.Integration, error)

+ func (rc *RockClient) GetQueryInfo(ctx context.Context, queryID string) (openapi.QueryInfo, error)

+ func (rc *RockClient) GetQueryResults(ctx context.Context, queryID string) (openapi.QueryPaginationResponse, error)

+ func (rc *RockClient) GetUser(ctx context.Context, email string) (openapi.User, error)

+ func (rc *RockClient) ListActiveQueries(ctx context.Context) ([]openapi.QueryInfo, error)

+ func (rc *RockClient) UpdateAPIKey(ctx context.Context, keyName string, options ...option.APIKeyOption) (openapi.ApiKey, error)

+ func (rc *RockClient) WaitForQuery(ctx context.Context, queryID string) error

+ func (rc *RockClient) WaitUntilKafkaIntegrationActive(ctx context.Context, integration string) error

+ func (rc *RockClient) WaitUntilWorkspaceAvailable(ctx context.Context, workspace string) error

Apr 8, 2022

Changes in this version

type RockClient

+ func (rc *RockClient) GetRole(ctx context.Context, roleName string) (openapi.Role, error)

Mar 31, 2022

Changes in this version

type RockClient

+ func (rc *RockClient) CreateRole(ctx context.Context, roleName string, options ...option.RoleOption) (openapi.Role, error)

+ func (rc *RockClient) DeleteRole(ctx context.Context, roleName string) error

+ func (rc *RockClient) ListRoles(ctx context.Context) ([]openapi.Role, error)

+ func (rc *RockClient) UpdateRole(ctx context.Context, roleName string, options ...option.RoleOption) (openapi.Role, error)

Mar 23, 2022

Changes in this version

+ type HA struct

+ func NewHA(client ...Querier) *HA

+ func (ha *HA) Query(ctx context.Context, query string, options ...option.QueryOption) (openapi.QueryResponse, []error)

+ type Querier interface

+ Query func(context.Context, string, ...option.QueryOption) (openapi.QueryResponse, error)

type RockClient

+ func (rc *RockClient) CreateView(ctx context.Context, workspace, view, query string, ...) (openapi.View, error)

+ func (rc *RockClient) DeleteView(ctx context.Context, workspace, view string) error

+ func (rc *RockClient) GetView(ctx context.Context, workspace, name string) (openapi.View, error)

+ func (rc *RockClient) ListViews(ctx context.Context, options ...option.ListViewOption) ([]openapi.View, error)

+ func (rc *RockClient) UpdateView(ctx context.Context, workspace, view, query string, ...) (openapi.View, error)

+ func (rc *RockClient) WaitUntilViewGone(ctx context.Context, workspace, name string) error

Dec 8, 2021

Changes in this version

+ type PatchDocument struct

+ ID string

+ Patches []PatchOperation

+ type PatchOperation struct

+ From *string

+ Op string

+ Path string

+ Value interface{}

type RockClient

+ func (rc *RockClient) Ping(ctx context.Context) error

Jul 9, 2021

Changes in this version

type RockClient

+ func (rc *RockClient) CreateQueryLambda(ctx context.Context, workspace, name, sql string, ...) (openapi.QueryLambdaVersion, error)

+ func (rc *RockClient) CreateQueryLambdaTag(ctx context.Context, workspace, name, version, tag string) (openapi.QueryLambdaTag, error)

+ func (rc *RockClient) DeleteQueryLambda(ctx context.Context, workspace, name string) error

+ func (rc *RockClient) DeleteQueryLambdaTag(ctx context.Context, workspace, name, tag string) error

+ func (rc *RockClient) DeleteQueryLambdaVersion(ctx context.Context, workspace, name, version string) error

+ func (rc *RockClient) UpdateQueryLambda(ctx context.Context, workspace, name, sql string, ...) (openapi.QueryLambdaVersion, error)

Jul 6, 2021

Changes in this version

type RockClient

+ func (rc *RockClient) GetIntegration(ctx context.Context, name string) (openapi.Integration, error)

+ func (rc *RockClient) GetQueryLambdaVersion(ctx context.Context, workspace, name, version string) (openapi.QueryLambdaVersion, error)

+ func (rc *RockClient) GetQueryLambdaVersionByTag(ctx context.Context, workspace, name, tag string) (openapi.QueryLambdaTag, error)

+ func (rc *RockClient) ListCollections(ctx context.Context, options ...option.ListCollectionOption) ([]openapi.Collection, error)

+ func (rc *RockClient) ListIntegrations(ctx context.Context) ([]openapi.Integration, error)

+ func (rc *RockClient) ListQueryLambdaTagVersions(ctx context.Context, tag string) ([]openapi.QueryLambdaVersion, error)

+ func (rc *RockClient) ListQueryLambdaTags(ctx context.Context, options ...option.ListQueryLambdaTagsOption) ([]openapi.QueryLambdaTag, error)

+ func (rc *RockClient) ListQueryLambdaVersions(ctx context.Context, workspace, name string) ([]openapi.QueryLambdaVersion, error)

+ func (rc *RockClient) ListQueryLambdas(ctx context.Context, options ...option.ListQueryLambdaOption) ([]openapi.QueryLambda, error)

Jun 25, 2021

Changes in this version

+ var RetryableErrors = []int

+ func RetryableError(err error) bool

type ColumnType

+ const ColumnTypeString

+ type Error struct

+ Cause error

+ func NewError(err error) Error

+ func (e Error) Error() string

+ func (e Error) IsNotFoundError() bool

+ func (e Error) RateLimited() bool

+ func (e Error) Retryable() bool

+ func (e Error) Unwrap() error

+ type ExponentialRetry struct

+ MaxBackoff time.Duration

+ WaitInterval time.Duration

+ func (r ExponentialRetry) Retry(ctx context.Context, retryFn RetryFunc) error

+ func (r ExponentialRetry) RetryWithCheck(ctx context.Context, checkFn RetryCheck) error

+ type KafkaFormat string

+ const KafkaFormatAVRO

+ const KafkaFormatJSON

+ func (f KafkaFormat) String() string

+ type Retrier interface

+ Retry func(ctx context.Context, retryFn RetryFunc) error

+ RetryWithCheck func(ctx context.Context, checkFunc RetryCheck) error

+ type RetryCheck func() (retry bool, err error)

+ type RetryFunc func() (err error)

type RockClient

+ func (rc *RockClient) AddDocuments(ctx context.Context, workspace, collection string, docs []interface{}) ([]openapi.DocumentStatus, error)

+ func (rc *RockClient) CreateAPIKey(ctx context.Context, keyName string) (openapi.ApiKey, error)

+ func (rc *RockClient) CreateAlias(ctx context.Context, workspace, alias string, collections []string, ...) (openapi.Alias, error)

+ func (rc *RockClient) CreateCollection(ctx context.Context, workspace, name string, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateIPAllowlistNetworkPolicy(ctx context.Context, name, ipAddress string, ...) (openapi.IpAllowlist, error)

+ func (rc *RockClient) CreateKafkaIntegration(ctx context.Context, name string, topics []string, format KafkaFormat, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateMongoDBIntegration(ctx context.Context, name, connectionURI string, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateRedshiftIntegration(ctx context.Context, name string, awsKeys option.AWSCredentialsFn, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateSegmentIntegration(ctx context.Context, name, connectionString string, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateUser(ctx context.Context, email string, roles []string) (openapi.User, error)

+ func (rc *RockClient) DeleteAPIKey(ctx context.Context, keyName string, options ...option.APIKeyOption) error

+ func (rc *RockClient) DeleteAlias(ctx context.Context, workspace, alias string) error

+ func (rc *RockClient) DeleteDocuments(ctx context.Context, workspace, collection string, docIDs []string) ([]openapi.DocumentStatus, error)

+ func (rc *RockClient) DeleteIPAllowlistNetworkPolicy(ctx context.Context, name string) error

+ func (rc *RockClient) DeleteUser(ctx context.Context, email string) error

+ func (rc *RockClient) GetAPIKey(ctx context.Context, name string, options ...option.APIKeyOption) (openapi.ApiKey, error)

+ func (rc *RockClient) GetAlias(ctx context.Context, workspace, alias string) (openapi.Alias, error)

+ func (rc *RockClient) GetCurrentUser(ctx context.Context) (openapi.User, error)

+ func (rc *RockClient) GetIPAllowlistNetworkPolicy(ctx context.Context, name string) (openapi.IpAllowlist, error)

+ func (rc *RockClient) GetOrganization(ctx context.Context) (openapi.Organization, error)

+ func (rc *RockClient) GetVirtualInstance(ctx context.Context, vID string) (openapi.VirtualInstance, error)

+ func (rc *RockClient) ListAPIKeys(ctx context.Context, options ...option.APIKeyOption) ([]openapi.ApiKey, error)

+ func (rc *RockClient) ListAliases(ctx context.Context, options ...option.ListAliasesOption) ([]openapi.Alias, error)

+ func (rc *RockClient) ListIPAllowlistEntries(ctx context.Context) ([]openapi.IpAllowlist, error)

+ func (rc *RockClient) ListUsers(ctx context.Context) ([]openapi.User, error)

+ func (rc *RockClient) ListVirtualInstances(ctx context.Context) ([]openapi.VirtualInstance, error)

+ func (rc *RockClient) PatchDocuments(ctx context.Context, workspace, collection string, ...) ([]openapi.DocumentStatus, error)

+ func (rc *RockClient) UpdateAlias(ctx context.Context, workspace, alias string, collections []string, ...) error

+ func (rc *RockClient) UpdateVirtualInstance(ctx context.Context, vID string, options ...option.VirtualInstanceOption) (openapi.VirtualInstance, error)

+ func (rc *RockClient) WaitUntilAliasAvailable(ctx context.Context, workspace, alias string) error

+ func (rc *RockClient) WaitUntilCollectionDocuments(ctx context.Context, workspace, name string, count int64) error

+ func (rc *RockClient) WaitUntilCollectionGone(ctx context.Context, workspace, name string) error

+ func (rc *RockClient) WaitUntilCollectionReady(ctx context.Context, workspace, name string) error

+ type RockConfig struct

+ APIKey string

+ APIServer string

type RockOption

+ func WithHTTPDebug() RockOption

+ func WithRetry(r Retrier) RockOption

May 14, 2021

Changes in this version

+ const LatestTag

+ func IsNotFoundError(err error) bool

+ type ColumnType int

+ const ColumnTypeBool

+ const ColumnTypeBoolean

+ const ColumnTypeDate

+ const ColumnTypeDatetime

+ const ColumnTypeFloat

+ const ColumnTypeInt

+ const ColumnTypeInteger

+ const ColumnTypeSTRING

+ const ColumnTypeTime

+ const ColumnTypeTimestamp

+ const ColumnTypeUnknown

+ func (c ColumnType) String() string

+ type Format func(params *openapi.FormatParams)

+ func WithCSVFormat(columnNames []string, columnTypes []ColumnType, options ...option.CSV) Format

+ func WithJSONFormat() Format

+ func WithXMLFormat(xml openapi.XmlParams) Format

type RockClient

+ func (rc *RockClient) CreateDynamoDBCollection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateDynamoDBIntegration(ctx context.Context, name string, creds option.AWSCredentialsFn, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateFileUploadCollection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateGCSCollection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateGCSIntegration(ctx context.Context, name string, creds option.GCSCredentialsFn, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateKafkaCollection(ctx context.Context, workspace, name, description, integration, topic string, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateKinesisCollection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateKinesisIntegration(ctx context.Context, name string, creds option.AWSCredentialsFn, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) CreateMongoDBCollection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateRedshiftCollection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateS3Collection(ctx context.Context, ...) (openapi.Collection, error)

+ func (rc *RockClient) CreateS3Integration(ctx context.Context, name string, creds option.AWSCredentialsFn, ...) (openapi.CreateIntegrationResponse, error)

+ func (rc *RockClient) DeleteCollection(ctx context.Context, workspace, name string) error

+ func (rc *RockClient) DeleteIntegration(ctx context.Context, name string) error

+ func (rc *RockClient) ExecuteQueryLambda(ctx context.Context, workspace, name string, ...) (openapi.QueryResponse, error)

+ func (rc *RockClient) GetCollection(ctx context.Context, workspace, name string) (openapi.Collection, error)

+ func (rc *RockClient) ValidateQuery(ctx context.Context, sql string, options ...option.QueryOption) (openapi.ValidateQueryResponse, error)

+ func (rc *RockClient) WaitForCollectionDocuments(ctx context.Context, workspace, name string, count int64) error

+ func (rc *RockClient) WaitForCollectionGone(ctx context.Context, workspace, name string) error

+ func (rc *RockClient) WaitForCollectionReady(ctx context.Context, workspace, name string) error

type RockOption

+ func Debug() RockOption

Mar 21, 2020

Changes in this version

+ const APIKeyEnvironmentVariableName

+ const APIServerEnvironmentVariableName

+ func AsRocksetError(err error) (api.ErrorModel, bool)

type RockClient

+ Organizations *api.OrganizationsApiService

+ QueryLambdas *api.QueryLambdasApiService

+ Workspaces *api.WorkspacesApiService

+ func (rc *RockClient) CreateWorkspace(name, description string) (api.Workspace, *http.Response, error)

+ func (rc *RockClient) DeleteWorkspace(name string) (api.Workspace, *http.Response, error)

+ func (rc *RockClient) GetWorkspace(name string) (api.Workspace, *http.Response, error)

+ func (rc *RockClient) ListWorkspaces() ([]api.Workspace, *http.Response, error)

+ func (rc *RockClient) Organization() (api.Organization, *http.Response, error)

Feb 14, 2020

Changes in this version

+ const DefaultAPIServer

type RockClient

+ func NewClient(options ...RockOption) (*RockClient, error)

+ func (rc *RockClient) Validate() error

+ type RockOption func(rc *RockClient)

+ func FromEnv() RockOption

+ func WithAPIKey(key string) RockOption

+ func WithAPIServer(s string) RockOption

+ func WithHTTPClient(c *http.Client) RockOption

+ func WithTimeout(t time.Duration) RockOption

Jan 23, 2019

Changes in this version

+ var Version = "0.5.9"

+ type RockClient struct

+ ApiKeys *api.ApiKeysApiService

+ Collection *api.CollectionsApiService

+ Documents *api.DocumentsApiService

+ Integration *api.IntegrationsApiService

+ QueryApi *api.QueriesApiService

+ Users *api.UsersApiService

+ func Client(apiKey string, apiServer string) *RockClient

+ func (c *RockClient) Query(body api.QueryRequest) (api.QueryResponse, *http.Response, error)