option

package
v0.24.1 Latest Latest
Warning

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

 Go to latest Published: Mar 8, 2024 License: Apache-2.0 Imports: 3 Imported by: 7

Documentation

Overview

Package option contains optional arguments for rockset.RockClient convenience methods.

Index

Constants

View Source 
const (
	StorageCompressionLZ4  = "LZ4"
	StorageCompressionZSTD = "ZSTD"
)
View Source 
const (
	VirtualInstanceInitializing           VirtualInstanceState = "INITIALIZING"
	VirtualInstanceProvisioningResources  VirtualInstanceState = "PROVISIONING_RESOURCES"
	VirtualInstanceRebalancingCollections VirtualInstanceState = "REBALANCING_COLLECTIONS"
	VirtualInstanceActive                 VirtualInstanceState = "ACTIVE"
	VirtualInstanceSuspending             VirtualInstanceState = "SUSPENDING"
	VirtualInstanceSuspended              VirtualInstanceState = "SUSPENDED"
	VirtualInstanceResuming               VirtualInstanceState = "RESUMING"
	VirtualInstanceDeleted                VirtualInstanceState = "DELETED"

	MountCreating             MountState = "CREATING"
	MountActive               MountState = "ACTIVE"
	MountRefreshing           MountState = "REFRESHING"
	MountExpired              MountState = "EXPIRED"
	MountDeleting             MountState = "DELETING"
	MountSwitchingRefreshType MountState = "SWITCHING_REFRESH_TYPE"
	MountSuspended            MountState = "SUSPENDED"
	MountSuspending           MountState = "SUSPENDING"
)
View Source 
const AllClusters = "*ALL*"

AllClusters is the string representation of all current and future clusters.

Variables

This section is empty.

Functions

func IsGlobalAction added in v0.14.4 

func IsGlobalAction(action string) bool

IsGlobalAction returns true if action is a GlobalAction

func IsIntegrationAction added in v0.14.4 

func IsIntegrationAction(action string) bool

IsIntegrationAction returns true if action is an IntegrationAction

func IsVirtualInstanceAction added in v0.15.0 

func IsVirtualInstanceAction(action string) bool

IsVirtualInstanceAction returns true if action is an VirtualInstanceAction

func IsWorkspaceAction added in v0.14.4 

func IsWorkspaceAction(action string) bool

IsWorkspaceAction returns true if action is an WorkspaceAction

func WithWorkspace added in v0.12.3 

func WithWorkspace(name string) func(o *ListCollectionOptions)

Types

type APIKeyOption added in v0.12.0 

type APIKeyOption func(*APIKeyOptions)

func ForUser added in v0.12.0 

func ForUser(username string) APIKeyOption

ForUser is used to scope API Key commands to a particular user.

func State added in v0.15.0 

func State(state KeyState) APIKeyOption

State is used to set the key state to either KeyActive or KeySuspended.

type APIKeyOptions added in v0.12.0 

type APIKeyOptions struct {
	User  *string
	State *KeyState
}

type APIKeyRoleOption added in v0.14.3 

type APIKeyRoleOption func(*APIKeyRoleOptions)

func WithRole added in v0.14.3 

func WithRole(role string) APIKeyRoleOption

type APIKeyRoleOptions added in v0.14.3 

type APIKeyRoleOptions struct {
	Role *string
}

type AWSCredentials 

type AWSCredentials struct {
	*openapi.AwsAccessKey
	*openapi.AwsRole
}

type AWSCredentialsFn 

type AWSCredentialsFn func(o *AWSCredentials)

func AWSKeys 

func AWSKeys(accessKey, secretKey string) AWSCredentialsFn

func AWSRole 

func AWSRole(roleARN string) AWSCredentialsFn

type AliasOption added in v0.12.0 

type AliasOption func(*AliasOptions)

func WithAliasDescription added in v0.12.0 

func WithAliasDescription(name string) AliasOption

WithAliasDescription is used to optionally set the description for an alias.

type AliasOptions added in v0.12.0 

type AliasOptions struct {
	Description *string
}

type CSV 

type CSV func(*openapi.CsvParams)

func WithEncoding 

func WithEncoding(encoding string) CSV

func WithEscapeChar 

func WithEscapeChar(escape string) CSV

WithEscapeChar sets the CSV escape character. Defaults to \

func WithFirstLineAsColumnNames 

func WithFirstLineAsColumnNames() CSV

WithFirstLineAsColumnNames enables the use of the first row as the column names

func WithQuoteChar 

func WithQuoteChar(quote string) CSV

WithQuoteChar sets the CSV quote character. Defaults to "

func WithSeparator 

func WithSeparator(separator string) CSV

WithSeparator sets the CSV separator. Defaults to ,

type ClusterPrivileges added in v0.14.4 

type ClusterPrivileges func(*openapi.Privilege)

func WithAllCluster added in v0.14.4 

func WithAllCluster() ClusterPrivileges

WithAllCluster is used to specify all current and future clusters for a WithWorkspacePrivilege.

func WithCluster added in v0.14.3 

func WithCluster(name string) ClusterPrivileges

WithCluster is used to specify a cluster for a WithWorkspacePrivilege.

type CollectionOption 

type CollectionOption func(o *openapi.CreateCollectionRequest)

func WithCollectionClusteringKey 

func WithCollectionClusteringKey(fieldName, fieldType string, keys []string) CollectionOption

WithCollectionClusteringKey adds a clustering key. Can be specified multiple times. Deprecated: use WithFieldMappingQuery() instead and with a CLUSTER BY clause.

func WithCollectionDescription added in v0.15.0 

func WithCollectionDescription(d string) CollectionOption

WithCollectionDescription sets the description for the collection.

func WithCollectionFieldMapping 

func WithCollectionFieldMapping(name string, dropAll bool, outputField OutputFieldFn,
	inputFields ...InputFieldFn) CollectionOption

WithCollectionFieldMapping adds a field mapping to the collection. If dropAll is true, the input and output fields are not set.

func WithCollectionRequest added in v0.15.0 

func WithCollectionRequest(request openapi.CreateCollectionRequest) CollectionOption

WithCollectionRequest is used to pass a openapi.CreateCollectionRequest to a CreateCollection() call.

func WithCollectionRetention 

func WithCollectionRetention(d time.Duration) CollectionOption

WithCollectionRetention sets the retention in seconds for documents.

func WithCollectionRetentionSeconds added in v0.15.0 

func WithCollectionRetentionSeconds(s int64) CollectionOption

WithCollectionRetentionSeconds sets the retention in seconds for documents.

func WithDynamoDBMaxRCU added in v0.12.0 

func WithDynamoDBMaxRCU(maxRCU int64) CollectionOption

WithDynamoDBMaxRCU sets the max RCU for a DynamoDB collection.

func WithEventTimeInfo added in v0.15.0 

func WithEventTimeInfo(field, timeZone string, format EventTimeInfoFormat) CollectionOption

func WithFieldMappingQuery added in v0.13.0 

func WithFieldMappingQuery(sql string) CollectionOption

WithFieldMappingQuery sets the field mapping query. Deprecated: use WithIngestTransformation instead.

func WithIngestTransformation added in v0.16.1 

func WithIngestTransformation(sql string) CollectionOption

WithIngestTransformation lets you run a SQL query over the data from your source and only persists the output of that query to the collection. This gives you the power of SQL to drop, rename, or combine fields, filter out incoming rows, and even aggregate incoming documents in real-time with rollups.

func WithKafkaSource added in v0.15.0 

func WithKafkaSource(IntegrationName, topic string, startingOffset KafkaStartingOffset, fmt Format,
	options ...KafkaSourceOption) CollectionOption

func WithS3Source added in v0.15.0 

func WithS3Source(IntegrationName, bucket string, fmt Format, options ...S3SourceOption) CollectionOption

func WithSampleDataset added in v0.15.1 

func WithSampleDataset(ds dataset.Sample) CollectionOption

WithSampleDataset creates a new collection from the Rockset public datasets.

func WithSampleDatasetPattern added in v0.15.1 

func WithSampleDatasetPattern(pattern string) CollectionOption

WithSampleDatasetPattern creates a new collection from the Rockset public datasets, using pattern to select which file(s) to include in the collection.

func WithStorageCompressionType added in v0.18.0 

func WithStorageCompressionType(compressionType StorageCompressionType) CollectionOption

WithStorageCompressionType sets the RocksDB storage compression type.

type CollectionStatus added in v0.22.4 

type CollectionStatus string
const (
	CollectionStatusCreated     CollectionStatus = "CREATED"
	CollectionStatusInitialized CollectionStatus = "INITIALIZED"
	CollectionStatusReady       CollectionStatus = "READY"
)

func (CollectionStatus) String added in v0.22.4 

func (c CollectionStatus) String() string

type ColumnType added in v0.15.0 

type ColumnType int
const (
	ColumnTypeUnknown   ColumnType = iota
	ColumnTypeBoolean   ColumnType = iota
	ColumnTypeInteger   ColumnType = iota
	ColumnTypeFloat     ColumnType = iota
	ColumnTypeString    ColumnType = iota
	ColumnTypeTime      ColumnType = iota
	ColumnTypeDate      ColumnType = iota
	ColumnTypeDatetime  ColumnType = iota
	ColumnTypeTimestamp ColumnType = iota
	ColumnTypeBool      ColumnType = iota
	ColumnTypeInt       ColumnType = iota
)

func (ColumnType) String added in v0.15.0 

func (c ColumnType) String() string

String returns the string representation of the ColumnType

type CreateQueryLambdaOption added in v0.12.4 

type CreateQueryLambdaOption func(request *CreateQueryLambdaOptions)

func WithDefaultParameter added in v0.12.4 

func WithDefaultParameter(name, paramType, value string) CreateQueryLambdaOption

func WithQueryLambdaDescription added in v0.12.4 

func WithQueryLambdaDescription(desc string) CreateQueryLambdaOption

type CreateQueryLambdaOptions added in v0.12.4 

type CreateQueryLambdaOptions struct {
	Description     *string
	QueryParameters []openapi.QueryParameter
}

type DynamoDBIntegration 

type DynamoDBIntegration struct {
	openapi.DynamodbIntegration
	Description *string
}

type DynamoDBIntegrationOption 

type DynamoDBIntegrationOption func(request *DynamoDBIntegration)

func WithDynamoDBIntegrationDescription 

func WithDynamoDBIntegrationDescription(desc string) DynamoDBIntegrationOption

type EventTimeInfoFormat 

type EventTimeInfoFormat string
const (
	MillisecondsSinceEpoch EventTimeInfoFormat = "milliseconds_since_epoch"
	SecondsSinceEpoch      EventTimeInfoFormat = "seconds_since_epoch"
)

type ExecuteQueryLambdaRequest 

type ExecuteQueryLambdaRequest struct {
	openapi.ExecuteQueryLambdaRequest
	Tag     string
	Version string
}

type FieldMissingAction 

type FieldMissingAction string
const (
	FieldMissingSkip FieldMissingAction = "SKIP"
	FieldMissingPass FieldMissingAction = "PASS"
)

func (FieldMissingAction) String 

func (f FieldMissingAction) String() string

type Format added in v0.15.0 

type Format func(params *openapi.FormatParams)

func WithAutoFormat added in v0.15.0 

func WithAutoFormat() Format

WithAutoFormat sets the format to auto-detect JSON, Parquet, XLS or PDF.

func WithCSVFormat added in v0.15.0 

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

WithCSVFormat is used by the create collection calls, to set the format to CSV. The columnNames and columnTypes must be of equal length, and it takes a list of optional option.CSV options. 

WithCSVFormat(
  []string{"foo", "bar"},
  []ColumnType{ColumnTypeBoolean, ColumnTypeString},
  option.WithSeparator(";")
)

func WithJSONFormat added in v0.15.0 

func WithJSONFormat() Format

WithJSONFormat sets the format to JSON.

func WithXMLFormat added in v0.15.0 

func WithXMLFormat(xml openapi.XmlParams) Format

WithXMLFormat sets the format XML.

type GCSIntegration 

type GCSIntegration struct {
	Description *string
}

type GCSIntegrationOption 

type GCSIntegrationOption func(request *GCSIntegration)

func WithGCSIntegrationDescription 

func WithGCSIntegrationDescription(desc string) GCSIntegrationOption

type GlobalAction added in v0.14.3 

type GlobalAction int

GlobalAction is the type for RBAC actions that operate on global resources. 

const (
	UnknownGlobalAction GlobalAction = iota
	AllGlobalActions
	GetOrgGlobal
	GetCurrentUserGlobal
	InviteUserGlobal
	DeleteUserGlobal
	ListUsersGlobal
	GetBillingGlobal
	UpdateBillingGlobal
	UpdateSettingsGlobal
	GetMetricsGlobal
	UpdateViGlobal
	ListViGlobal
	CreateWsGlobal
	ListWsGlobal
	CreateIntegrationGlobal
	DeleteIntegrationGlobal
	ListIntegrationsGlobal
	UpdateResourceOwnerGlobal
	CreateAPIKeyGlobal
	CreateRoleGlobal
	UpdateRoleGlobal
	DeleteRoleGlobal
	ListRolesGlobal
	GrantRevokeRoleGlobal
	CreateVirtualInstanceGlobal
	CreateQueryLogsCollectionGlobal
)

func GetGlobalAction added in v0.14.4 

func GetGlobalAction(action string) GlobalAction

GetGlobalAction returns the corresponding GlobalAction

func (GlobalAction) String added in v0.14.3 

func (a GlobalAction) String() string

String returns the string representation used for the REST API call

type IPAllowlistOption added in v0.12.0 

type IPAllowlistOption func(*IPAllowlistOptions)

func WithIPAllowlistDescription added in v0.12.0 

func WithIPAllowlistDescription(desc string) IPAllowlistOption

WithIPAllowlistDescription is used to optionally set the IP allowlist description.

type IPAllowlistOptions added in v0.12.0 

type IPAllowlistOptions struct {
	Description *string
}

type InputFieldFn 

type InputFieldFn func(field *openapi.InputField)

func InputField 

func InputField(fieldName string, ifMissing FieldMissingAction, drop bool, parameterName string) InputFieldFn

type IntegrationAction added in v0.14.3 

type IntegrationAction int

IntegrationAction is the type for actions that operate on integrations. 

const (
	UnknownIntegrationAction IntegrationAction = iota
	AllIntegrationActions
	CreateCollectionIntegration
)

func GetIntegrationAction added in v0.14.4 

func GetIntegrationAction(action string) IntegrationAction

GetIntegrationAction returns the corresponding IntegrationAction

func (IntegrationAction) String added in v0.14.3 

func (a IntegrationAction) String() string

String returns the string representation used for the REST API call

type KafkaFormat added in v0.15.0 

type KafkaFormat string

KafkaFormat is the definition of the Kafka format 

const (
	// KafkaFormatJSON is the JSON format for Kafka.
	KafkaFormatJSON KafkaFormat = "JSON"
	// KafkaFormatAVRO is the AVRO format for Kafka. If used, the option.WithKafkaSchemaRegistryConfig()
	// must be used when creating the integration.
	KafkaFormatAVRO KafkaFormat = "AVRO"
)

func (KafkaFormat) String added in v0.15.0 

func (f KafkaFormat) String() string

String returns the string representation of the Kafka format

type KafkaIntegration added in v0.12.0 

type KafkaIntegration struct {
	Description *string
	Config      openapi.KafkaIntegration
}

type KafkaIntegrationOption added in v0.12.0 

type KafkaIntegrationOption func(request *KafkaIntegration)

func WithKafkaBootstrapServers added in v0.15.0 

func WithKafkaBootstrapServers(servers string) KafkaIntegrationOption

func WithKafkaConnectionString added in v0.15.0 

func WithKafkaConnectionString(s string) KafkaIntegrationOption

func WithKafkaDataFormat added in v0.15.0 

func WithKafkaDataFormat(format KafkaFormat) KafkaIntegrationOption

func WithKafkaIntegrationConfig added in v0.15.0 

func WithKafkaIntegrationConfig(config openapi.KafkaIntegration) KafkaIntegrationOption

func WithKafkaIntegrationDescription added in v0.12.0 

func WithKafkaIntegrationDescription(desc string) KafkaIntegrationOption

func WithKafkaIntegrationTopic added in v0.15.0 

func WithKafkaIntegrationTopic(topic string) KafkaIntegrationOption

WithKafkaIntegrationTopic adds a topic name to the integration. Can be specified multiple times.

func WithKafkaSchemaRegistryConfig added in v0.15.0 

func WithKafkaSchemaRegistryConfig(url, apiKey, secret string) KafkaIntegrationOption

WithKafkaSchemaRegistryConfig is required when the Kafka format is rockset.KafkaFormatJSON. A Kafka integration without schema registry configured can only be used to ingest from topics serving JSON messages.

func WithKafkaSecurityConfig added in v0.15.0 

func WithKafkaSecurityConfig(apiKey, secret string) KafkaIntegrationOption

func WithKafkaStatusByTopic added in v0.15.0 

func WithKafkaStatusByTopic(topic string, status openapi.StatusKafka) KafkaIntegrationOption

func WithKafkaV3 added in v0.15.0 

func WithKafkaV3() KafkaIntegrationOption

type KafkaIntegrationTopicState added in v0.15.0 

type KafkaIntegrationTopicState string

KafkaIntegrationTopicState is the definition of topic states for a Kafka integration. 

const (
	KafkaIntegrationActive    KafkaIntegrationTopicState = "ACTIVE"
	KafkaIntegrationNoDocsYet KafkaIntegrationTopicState = "NO_DOCS_YET"
	KafkaIntegrationDormant   KafkaIntegrationTopicState = "DORMANT"
)

type KafkaSourceOption added in v0.15.0 

type KafkaSourceOption func(o *openapi.SourceKafka)

func WithKafkaConsumerGroupID added in v0.15.0 

func WithKafkaConsumerGroupID(id string) KafkaSourceOption

func WithKafkaSourceV3 added in v0.15.0 

func WithKafkaSourceV3() KafkaSourceOption

type KafkaStartingOffset added in v0.15.0 

type KafkaStartingOffset string
const (
	KafkaStartingOffsetEarliest KafkaStartingOffset = "EARLIEST"
	KafkaStartingOffsetLatest   KafkaStartingOffset = "LATEST"
)

type KeyState added in v0.15.0 

type KeyState string
const (
	KeyActive    KeyState = "ACTIVE"
	KeySuspended KeyState = "SUSPENDED"
)

func (KeyState) String added in v0.22.5 

func (k KeyState) String() string

type KinesisIntegration 

type KinesisIntegration struct {
	openapi.KinesisIntegration
	Description *string
}

type KinesisIntegrationOption 

type KinesisIntegrationOption func(request *KinesisIntegration)

func WithKinesisIntegrationDescription 

func WithKinesisIntegrationDescription(desc string) KinesisIntegrationOption

type ListAliasesOption added in v0.12.0 

type ListAliasesOption func(*ListAliasesOptions)

func WithAliasWorkspace added in v0.12.0 

func WithAliasWorkspace(name string) ListAliasesOption

WithAliasWorkspace is used to scope a listing of aliases to a workspace.

type ListAliasesOptions added in v0.12.0 

type ListAliasesOptions struct {
	Workspace string
}

type ListCollectionOption added in v0.12.3 

type ListCollectionOption func(o *ListCollectionOptions)

type ListCollectionOptions added in v0.12.3 

type ListCollectionOptions struct {
	Workspace *string
}

type ListQueryLambdaOption added in v0.12.3 

type ListQueryLambdaOption func(request *ListQueryLambdaOptions)

func WithQueryLambdaWorkspace added in v0.12.3 

func WithQueryLambdaWorkspace(name string) ListQueryLambdaOption

type ListQueryLambdaOptions added in v0.12.3 

type ListQueryLambdaOptions struct {
	Workspace *string
}

type ListViewOption added in v0.14.1 

type ListViewOption func(o *ListViewOptions)

func WithViewWorkspace added in v0.14.1 

func WithViewWorkspace(ws string) ListViewOption

WithViewWorkspace limits ListViews to the specified workspace

type ListViewOptions added in v0.14.1 

type ListViewOptions struct {
	Workspace string
}

type MongoDBIntegration added in v0.12.0 

type MongoDBIntegration struct {
	Description *string
}

type MongoDBIntegrationOption added in v0.12.0 

type MongoDBIntegrationOption func(request *MongoDBIntegration)

func WithMongoDBIntegrationDescription added in v0.12.0 

func WithMongoDBIntegrationDescription(desc string) MongoDBIntegrationOption

type MountState added in v0.22.4 

type MountState string

func (MountState) String added in v0.22.4 

func (m MountState) String() string

type OnError 

type OnError string
const (
	OnErrorSkip OnError = "SKIP"
	OnErrorFail OnError = "FAIL"
)

func (OnError) String 

func (e OnError) String() string

type OutputFieldFn 

type OutputFieldFn func(field *openapi.OutputField)

func OutputField 

func OutputField(fieldName string, sql string, onError OnError) OutputFieldFn

type QueryLambdaOption 

type QueryLambdaOption func(request *ExecuteQueryLambdaRequest)

func WithQueryLambdaParameter added in v0.18.0 

func WithQueryLambdaParameter(name, valueType, value string) QueryLambdaOption

WithQueryLambdaParameter sets a query lambda parameter.

func WithQueryLambdaRequest added in v0.23.0 

func WithQueryLambdaRequest(r openapi.ExecuteQueryLambdaRequest) QueryLambdaOption

WithQueryLambdaRequest sets the query lambda request.

func WithQueryLambdaRowLimit added in v0.18.0 

func WithQueryLambdaRowLimit(limit int32) QueryLambdaOption

WithQueryLambdaRowLimit sets the maximum number of rows to retrieve.

func WithTag 

func WithTag(tag string) QueryLambdaOption

func WithVersion 

func WithVersion(version string) QueryLambdaOption

type QueryLambdaState added in v0.22.4 

type QueryLambdaState string
const (
	QueryLambdaActive     QueryLambdaState = "ACTIVE"
	QueryLambdaInvalidSQL QueryLambdaState = "INVALID_SQL"
)

func (QueryLambdaState) String added in v0.22.4 

func (q QueryLambdaState) String() string

type QueryOption 

type QueryOption func(request *QueryOptions)

func WithAsync added in v0.20.0 

func WithAsync() QueryOption

WithAsync means that the query will run asynchronously for up to 30 minutes. The query request will immediately return with a query id that can be used to retrieve the query status and results. If not specified, the query will return with results once completed or timeout after 2 minutes. (To return results directly for shorter queries while still allowing a timeout of up to 30 minutes, use WithAsyncClientTimeout())

func WithAsyncClientTimeout added in v0.15.0 

func WithAsyncClientTimeout(timeout time.Duration) QueryOption

WithAsyncClientTimeout is maximum amount of time that the client is willing to wait for the query to complete. If the query is not complete by this timeout, a response will be returned with a query_id that can be used to check the status of the query and retrieve results once the query has completed.

func WithAsyncMaxInitialResults added in v0.15.0 

func WithAsyncMaxInitialResults(count int64) QueryOption

WithAsyncMaxInitialResults maximum number of results you will receive as a client. If the query exceeds this limit, the remaining results can be requested using a returned pagination cursor. In addition, there is a maximum response size of 100MiB so fewer than max_results may be returned. Deprecated: this option has no effect

func WithAsyncTimeout added in v0.15.0 

func WithAsyncTimeout(timeout time.Duration) QueryOption

WithAsyncTimeout maximum amount of time that Rockset will attempt to complete query execution before aborting the query and returning an error. Deprecated: this option has no effect

func WithDebugThreshold added in v0.22.4 

func WithDebugThreshold(timeout time.Duration) QueryOption

WithDebugThreshold enables the option to log debug information if query execution takes longer than the duration. If the query text includes the DEBUG hint and this parameter is also provided, only this value will be used and the DEBUG hint will be ignored.

func WithDefaultRowLimit added in v0.21.2 

func WithDefaultRowLimit(limit int32) QueryOption

WithDefaultRowLimit sets the row limit to use. Limits specified in the query text will override this default.

func WithMaxInitialResults added in v0.20.0 

func WithMaxInitialResults(maxInitialResults int64) QueryOption

WithMaxInitialResults is the maximum number of results you will receive as a client. If the query exceeds this limit, the remaining results can be requested using a returned pagination cursor.

func WithParameter 

func WithParameter(name, valueType, value string) QueryOption

WithParameter adds a query parameter. The type field is deprecated, and type is inferred from the JSON object value of the field if Type isn't set. Literal value of the field if Type is set.

func WithRowLimit 

func WithRowLimit(limit int32) QueryOption

WithRowLimit sets the row limit to use. Limits specified in the query text will override this default. Deprecated, use WithDefaultRowLimit instead.

func WithTimeout added in v0.20.0 

func WithTimeout(timeout time.Duration) QueryOption

WithTimeout is the maximum amount of time that Rockset will attempt to complete query execution before aborting the query and returning an error. The query timeout defaults to a maximum of 2 minutes. If WithAsync is set, the query timeout defaults to a maximum of 30 minutes.

func WithVirtualInstance added in v0.22.6 

func WithVirtualInstance(id string) QueryOption

WithVirtualInstance makes the query execute on a specific virtual instance, instead of the default (main).

type QueryOptions added in v0.22.6 

type QueryOptions struct {
	*openapi.QueryRequest
	VirtualInstance *string
}

type QueryResultOption added in v0.22.4 

type QueryResultOption func(request *QueryResultOptions)

func WithQueryResultCursor added in v0.22.4 

func WithQueryResultCursor(cursor string) QueryResultOption

WithQueryResultCursor sets the cursor to use to fetch next page of the query results. If not set, will default to the first page

func WithQueryResultDocs added in v0.22.4 

func WithQueryResultDocs(count int32) QueryResultOption

WithQueryResultDocs sets the max number of documents to fetch.

func WithQueryResultOffset added in v0.22.4 

func WithQueryResultOffset(offset int32) QueryResultOption

WithQueryResultOffset sets the offset from the cursor of the first document to be returned.

type QueryResultOptions added in v0.22.4 

type QueryResultOptions struct {
	Cursor *string
	Docs   *int32
	Offset *int32
}

type QueryState added in v0.22.0 

type QueryState string
const (
	QueryQueued    QueryState = "QUEUED"
	QueryRunning   QueryState = "RUNNING"
	QueryError     QueryState = "ERROR"
	QueryCompleted QueryState = "COMPLETED"
	QueryCancelled QueryState = "CANCELLED"
)

func (QueryState) String added in v0.22.4 

func (q QueryState) String() string

type RoleOption added in v0.14.3 

type RoleOption func(p *RoleOptions)

func WithGlobalPrivilege added in v0.14.3 

func WithGlobalPrivilege(action GlobalAction) RoleOption

WithGlobalPrivilege is used to add a global action to a role.

func WithIntegrationPrivilege added in v0.14.3 

func WithIntegrationPrivilege(action IntegrationAction, integration string) RoleOption

WithIntegrationPrivilege is used to add an integration action to a role.

func WithRoleDescription added in v0.14.3 

func WithRoleDescription(desc string) RoleOption

WithRoleDescription is used to optionally set a role description.

func WithVirtualInstancePrivilege added in v0.22.2 

func WithVirtualInstancePrivilege(action VirtualInstanceAction, vID string, options ...ClusterPrivileges) RoleOption

WithVirtualInstancePrivilege is used to add a virtual instance action to a role. If WithCluster isn't specified, the privilege applied to all clusters. Only the last WithCluster is what is used.

func WithWorkspacePrivilege added in v0.14.3 

func WithWorkspacePrivilege(action WorkspaceAction, workspace string, options ...ClusterPrivileges) RoleOption

WithWorkspacePrivilege is used to add a workspace action to a role. If WithCluster isn't specified, the privilege applied to all clusters. Only the last WithCluster is what is used.

type RoleOptions added in v0.14.3 

type RoleOptions struct {
	// Description of the role
	Description *string
	Privileges  []openapi.Privilege
}

RoleOptions is used to hold optional role settings

type S3Integration 

type S3Integration struct {
	openapi.S3Integration
	Description *string
}

type S3IntegrationOption 

type S3IntegrationOption func(request *S3Integration)

func WithS3IntegrationDescription 

func WithS3IntegrationDescription(desc string) S3IntegrationOption

type S3SourceOption added in v0.15.0 

type S3SourceOption func(o *openapi.SourceS3)

func WithS3Pattern added in v0.15.0 

func WithS3Pattern(pattern string) S3SourceOption

WithS3Pattern is used to pick the S3 pattern to ingest objects from. Can't be used together with WithS3Prefix()

func WithS3Prefix added in v0.15.0 

func WithS3Prefix(prefix string) S3SourceOption

WithS3Prefix is used to pick the S3 prefix to ingest objects from. Can't be used together with WithS3Pattern()

func WithS3Region added in v0.15.0 

func WithS3Region(region string) S3SourceOption

type SegmentIntegration added in v0.12.0 

type SegmentIntegration struct {
	Description *string
}

type SegmentIntegrationOption added in v0.12.0 

type SegmentIntegrationOption func(request *SegmentIntegration)

func WithSegmentIntegrationDescription added in v0.12.0 

func WithSegmentIntegrationDescription(desc string) SegmentIntegrationOption

type StorageCompressionType added in v0.18.0 

type StorageCompressionType string

StorageCompressionType defined the RocksDB storage compression types.

func (StorageCompressionType) String added in v0.18.0 

func (s StorageCompressionType) String() string

type UserOption added in v0.15.1 

type UserOption func(*UserOptions)

func WithUserFirstName added in v0.15.1 

func WithUserFirstName(firstName string) UserOption

WithUserFirstName is used to optionally set a first name for the user.

func WithUserLastName added in v0.15.1 

func WithUserLastName(lastName string) UserOption

WithUserLastName is used to optionally set a last name for the user.

type UserOptions added in v0.15.1 

type UserOptions struct {
	openapi.User
	FirstName *string
	LastName  *string
	Roles     []openapi.Role
}

UserOptions is used to hold optional user settings

type ViewOption added in v0.14.1 

type ViewOption func(p *ViewOptions)

func WithViewDescription added in v0.14.1 

func WithViewDescription(desc string) ViewOption

WithViewDescription is used to optionally set a view description.

type ViewOptions added in v0.14.1 

type ViewOptions struct {
	// Description of the view
	Description *string
}

ViewOptions is used to hold optional view settings

type VirtualInstanceAction added in v0.15.0 

type VirtualInstanceAction int

VirtualInstanceAction is the type for actions that operate on virtual instances. 

const (
	UnknownVirtualInstanceAction VirtualInstanceAction = iota
	AllVirtualInstanceAction
	QueryVirtualInstanceAction
	UpdateVirtualInstanceAction
	SuspendResumeVirtualInstanceAction
	DeleteVirtualInstanceAction
)

func GetVirtualInstanceAction added in v0.15.0 

func GetVirtualInstanceAction(action string) VirtualInstanceAction

GetVirtualInstanceAction returns the corresponding VirtualInstanceAction

func (VirtualInstanceAction) String added in v0.15.0 

func (a VirtualInstanceAction) String() string

String returns the string representation used for the REST API call

type VirtualInstanceOption added in v0.12.0 

type VirtualInstanceOption func(*VirtualInstanceOptions)

func WithAutoSuspend added in v0.18.0 

func WithAutoSuspend(d time.Duration) VirtualInstanceOption

WithAutoSuspend duration without queries after which the virtual instance is suspended. Minimum time is 15 minutes.

func WithRemountOnResume added in v0.22.0 

func WithRemountOnResume(remount bool) VirtualInstanceOption

WithRemountOnResume sets remount on Virtual Instance resume.

func WithVirtualInstanceAutoScalingPolicy added in v0.23.0 

func WithVirtualInstanceAutoScalingPolicy(policy openapi.AutoScalingPolicy) VirtualInstanceOption

WithVirtualInstanceAutoScalingPolicy sets the auto-scaling policy for the virtual instance.

func WithVirtualInstanceDescription added in v0.21.2 

func WithVirtualInstanceDescription(desc string) VirtualInstanceOption

WithVirtualInstanceDescription is used to set a description for the virtual instance.

func WithVirtualInstanceName added in v0.21.2 

func WithVirtualInstanceName(name string) VirtualInstanceOption

WithVirtualInstanceName is used to set a new name for the virtual instance.

func WithVirtualInstanceSize added in v0.18.0 

func WithVirtualInstanceSize(size VirtualInstanceSize) VirtualInstanceOption

WithVirtualInstanceSize is used to optionally set the virtual instance size.

type VirtualInstanceOptions added in v0.12.0 

type VirtualInstanceOptions struct {
	Description           *string
	Size                  *string
	AutoSuspend           *time.Duration
	EnableRemountOnResume *bool
	Name                  *string
	AutoScalingPolicy     *openapi.AutoScalingPolicy
}

VirtualInstanceOptions contains the optional settings for a virtual instance.

type VirtualInstanceSize added in v0.12.0 

type VirtualInstanceSize string
const (
	SizeFree     VirtualInstanceSize = "FREE"
	SizeNano     VirtualInstanceSize = "NANO"
	SizeShared   VirtualInstanceSize = "SHARED"
	SizeMilli    VirtualInstanceSize = "MILLI"
	SizeXSmall   VirtualInstanceSize = "XSMALL"
	SizeSmall    VirtualInstanceSize = "SMALL"
	SizeMedium   VirtualInstanceSize = "MEDIUM"
	SizeLarge    VirtualInstanceSize = "LARGE"
	SizeXLarge   VirtualInstanceSize = "XLARGE"
	SizeXLarge2  VirtualInstanceSize = "XLARGE2"
	SizeXLarge4  VirtualInstanceSize = "XLARGE4"
	SizeXLarge8  VirtualInstanceSize = "XLARGE8"
	SizeXLarge16 VirtualInstanceSize = "XLARGE16"
)

func (VirtualInstanceSize) String added in v0.12.0 

func (t VirtualInstanceSize) String() string

type VirtualInstanceState added in v0.22.4 

type VirtualInstanceState string

func (VirtualInstanceState) String added in v0.22.4 

func (v VirtualInstanceState) String() string

type WorkspaceAction added in v0.14.3 

type WorkspaceAction int

WorkspaceAction is the type for actions that operate on workspaces. 

const (
	UnknownWorkspaceAction WorkspaceAction = iota
	AllWorkspaceActions
	DeleteWs
	QueryDataWs
	WriteDataWs
	CreateCollectionWs
	DeleteCollectionWs
	CreateAliasWs
	DeleteAliasWs
	ListResourcesWs
	CreateQueryLambdaWs
	DeleteQueryLambdaWs
	ExecuteQueryLambdaWs
	CreateViewWs
	DeleteViewWs
	CreateSnapshotWs
	CreateScheduledLambdaWs
	DeleteScheduledLambdaWs
	CreateSimilarityIndexWs
	DeleteSimilarityIndexWs
)

func GetWorkspaceAction added in v0.14.4 

func GetWorkspaceAction(action string) WorkspaceAction

GetWorkspaceAction returns the corresponding WorkspaceAction

func (WorkspaceAction) String added in v0.14.3 

func (a WorkspaceAction) String() string

String returns the string representation used for the REST API call

type WorkspaceOption added in v0.12.0 

type WorkspaceOption func(p *WorkspaceOptions)

func WithWorkspaceDescription added in v0.12.0 

func WithWorkspaceDescription(desc string) WorkspaceOption

WithWorkspaceDescription is used to optionally set a workspace description.

type WorkspaceOptions added in v0.12.0 

type WorkspaceOptions struct {
	// Description of the workspace
	Description *string
}

WorkspaceOptions is used to hold optional workspace settings

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.