Version: v0.12.5 Latest Latest

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

Go to latest
Published: Aug 12, 2021 License: Apache-2.0 Imports: 2 Imported by: 0



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



This section is empty.


This section is empty.


func WithWorkspace added in v0.12.3

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


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.

type APIKeyOptions added in v0.12.0

type APIKeyOptions struct {
	User *string

type AWSCredentials

type AWSCredentials struct {

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 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.

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 WithCollectionFieldSchema

func WithCollectionFieldSchema(fieldName string, options ...FieldOption) CollectionOption

func WithCollectionRetention

func WithCollectionRetention(d time.Duration) CollectionOption

WithCollectionRetention 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.

type ColumnIndexMode

type ColumnIndexMode string
const (
	ColumnIndexModeStore   ColumnIndexMode = "store"
	ColumnIndexModeNoStore ColumnIndexMode = "no_store"

func (ColumnIndexMode) String

func (c ColumnIndexMode) String() string

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 {
	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 {
	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 FieldOption

type FieldOption func(*openapi.FieldOptions)

func WithColumnIndexMode

func WithColumnIndexMode(mode ColumnIndexMode) FieldOption

func WithIndexMode

func WithIndexMode(mode IndexMode) FieldOption

func WithRangeIndexMode

func WithRangeIndexMode(mode RangeIndexMode) FieldOption

func WithTypeIndexMode

func WithTypeIndexMode(mode TypeIndexMode) FieldOption

type GCSIntegration

type GCSIntegration struct {
	Description *string

type GCSIntegrationOption

type GCSIntegrationOption func(request *GCSIntegration)

func WithGCSIntegrationDescription

func WithGCSIntegrationDescription(desc string) GCSIntegrationOption

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 IndexMode

type IndexMode string
const (
	IndexModeIndex   IndexMode = "index"
	IndexModeNoIndex IndexMode = "no_index"

func (IndexMode) String

func (i IndexMode) String() string

type InputFieldFn

type InputFieldFn func(field *openapi.InputField)

func InputField

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

type KafkaIntegration added in v0.12.0

type KafkaIntegration struct {
	Description *string

type KafkaIntegrationOption added in v0.12.0

type KafkaIntegrationOption func(request *KafkaIntegration)

func WithKafkaIntegrationDescription added in v0.12.0

func WithKafkaIntegrationDescription(desc string) KafkaIntegrationOption

type KinesisIntegration

type KinesisIntegration struct {
	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 ListQueryLambdaTagsOption added in v0.12.3

type ListQueryLambdaTagsOption func(request *ListQueryLambdaTagsOptions)

func WithQueryLambda added in v0.12.3

func WithQueryLambda(workspace, name string) ListQueryLambdaTagsOption

type ListQueryLambdaTagsOptions added in v0.12.3

type ListQueryLambdaTagsOptions struct {
	Workspace   *string
	QueryLambda *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 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 WithParameter2

func WithParameter2(name, valueType, value string) QueryLambdaOption

func WithRowLimit2

func WithRowLimit2(limit int32) QueryLambdaOption

func WithTag

func WithTag(tag string) QueryLambdaOption

func WithVersion

func WithVersion(version string) QueryLambdaOption

func WithWarnings2

func WithWarnings2() QueryLambdaOption

type QueryOption

type QueryOption func(request *openapi.QueryRequestSql)

func WithParameter

func WithParameter(name, valueType, value string) QueryOption

func WithProfiling

func WithProfiling() QueryOption

func WithRowLimit

func WithRowLimit(limit int32) QueryOption

func WithWarnings

func WithWarnings() QueryOption

type RangeIndexMode

type RangeIndexMode string
const (
	RangeIndexModeV1Index RangeIndexMode = "v1_index"
	RangeIndexModeNoIndex RangeIndexMode = "no_index"

func (RangeIndexMode) String

func (r RangeIndexMode) String() string

type RedshiftIntegration added in v0.12.0

type RedshiftIntegration struct {
	Description *string

type RedshiftIntegrationOption added in v0.12.0

type RedshiftIntegrationOption func(request *RedshiftIntegration)

func WithRedshiftIntegrationConfig added in v0.12.0

func WithRedshiftIntegrationConfig(s3BucketPath, username, password, host string,
	port int32) RedshiftIntegrationOption

func WithRedshiftIntegrationDescription added in v0.12.0

func WithRedshiftIntegrationDescription(desc string) RedshiftIntegrationOption

type S3Integration

type S3Integration struct {
	Description *string

type S3IntegrationOption

type S3IntegrationOption func(request *S3Integration)

func WithS3IntegrationDescription

func WithS3IntegrationDescription(desc string) S3IntegrationOption

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 TypeIndexMode

type TypeIndexMode string
const (
	TypeIndexModeIndex   TypeIndexMode = "index"
	TypeIndexModeNoIndex TypeIndexMode = "no_index"

func (TypeIndexMode) String

func (t TypeIndexMode) String() string

type VirtualInstanceOption added in v0.12.0

type VirtualInstanceOption func(*VirtualInstanceOptions)

func WithVIMonitoring added in v0.12.0

func WithVIMonitoring(enabled bool) VirtualInstanceOption

WithVIMonitoring is used to optionally set the virtual instance monitoring.

func WithVISize added in v0.12.0

WithVISize is used to optionally set the virtual instance size.

func WithVIType added in v0.12.0

WithVIType is used to optionally set the virtual instance type.

type VirtualInstanceOptions added in v0.12.0

type VirtualInstanceOptions struct {
	MonitoringEnabled *bool
	Type              *string
	Size              *string

VirtualInstanceOptions contains the optional settings for a virtual instance.

type VirtualInstanceSize added in v0.12.0

type VirtualInstanceSize string
const (
	FreeSize     VirtualInstanceSize = "FREE"
	SharedSize   VirtualInstanceSize = "SHARED"
	SmallSize    VirtualInstanceSize = "SMALL"
	MediumSize   VirtualInstanceSize = "MEDIUM"
	LargeSize    VirtualInstanceSize = "LARGE"
	XLargeSize   VirtualInstanceSize = "XLARGE"
	XLarge2Size  VirtualInstanceSize = "XLARGE2"
	XLarge4Size  VirtualInstanceSize = "XLARGE4"
	XLarge8Size  VirtualInstanceSize = "XLARGE8"
	XLarge16Size VirtualInstanceSize = "XLARGE16"

func (VirtualInstanceSize) String added in v0.12.0

func (t VirtualInstanceSize) String() string

type VirtualInstanceType added in v0.12.0

type VirtualInstanceType string
const (
	FreeType     VirtualInstanceType = "FREE"
	SharedType   VirtualInstanceType = "SHARED"
	SmallType    VirtualInstanceType = "SMALL"
	MediumType   VirtualInstanceType = "MEDIUM"
	LargeType    VirtualInstanceType = "LARGE"
	XLargeType   VirtualInstanceType = "XLARGE"
	XLarge2Type  VirtualInstanceType = "XLARGE2"
	XLarge4Type  VirtualInstanceType = "XLARGE4"
	XLarge8Type  VirtualInstanceType = "XLARGE8"
	XLarge16Type VirtualInstanceType = "XLARGE16"

func (VirtualInstanceType) String added in v0.12.0

func (t VirtualInstanceType) String() string

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL