option

Apr 4, 2024

Changes in this version

+ type ScheduledLambdaOption func(p *ScheduledLambdaOptions)

+ func WithScheduledLambdaApikey(a string) ScheduledLambdaOption

+ func WithScheduledLambdaCreateRequest(r openapi.CreateScheduledLambdaRequest) ScheduledLambdaOption

+ func WithScheduledLambdaResumePermanentError(r bool) ScheduledLambdaOption

+ func WithScheduledLambdaTag(tag string) ScheduledLambdaOption

+ func WithScheduledLambdaTotalTimesToExecute(total int64) ScheduledLambdaOption

+ func WithScheduledLambdaUpdateRequest(r openapi.UpdateScheduledLambdaRequest) ScheduledLambdaOption

+ func WithScheduledLambdaVersion(version string) ScheduledLambdaOption

+ func WithScheduledLambdaWebhookAuthHeader(header string) ScheduledLambdaOption

+ func WithScheduledLambdaWebhookPayload(payload string) ScheduledLambdaOption

+ func WithScheduledLambdaWebhookURL(url string) ScheduledLambdaOption

+ type ScheduledLambdaOptions struct

+ CreateRequest openapi.CreateScheduledLambdaRequest

+ UpdateRequest openapi.UpdateScheduledLambdaRequest

Feb 7, 2024

Changes in this version

type QueryLambdaOption

+ func WithQueryLambdaRequest(r openapi.ExecuteQueryLambdaRequest) QueryLambdaOption

type VirtualInstanceOption

+ func WithVirtualInstanceAutoScalingPolicy(policy openapi.AutoScalingPolicy) VirtualInstanceOption

type VirtualInstanceOptions

+ AutoScalingPolicy *openapi.AutoScalingPolicy

type VirtualInstanceSize

+ const SizeXSmall

Jan 16, 2024

Changes in this version

type QueryOption

+ func WithVirtualInstance(id string) QueryOption

+ type QueryOptions struct

+ VirtualInstance *string

Nov 9, 2023

Changes in this version

type KeyState

+ func (k KeyState) String() string

type QueryLambdaState

+ const QueryLambdaInvalidSQL

Nov 2, 2023

Changes in this version

+ type CollectionStatus string

+ func (c CollectionStatus) String() string

+ type MountState string

+ func (m MountState) String() string

+ type QueryLambdaState string

+ const QueryLambdaActive

+ const QueryLambdaInvalid

+ func (q QueryLambdaState) String() string

type QueryOption

+ func WithDebugThreshold(timeout time.Duration) QueryOption

+ type QueryResultOption func(request *QueryResultOptions)

+ func WithQueryResultCursor(cursor string) QueryResultOption

+ func WithQueryResultDocs(count int32) QueryResultOption

+ func WithQueryResultOffset(offset int32) QueryResultOption

+ type QueryResultOptions struct

+ Cursor *string

+ Docs *int32

+ Offset *int32

type QueryState

+ func (q QueryState) String() string

+ type VirtualInstanceState string

+ func (v VirtualInstanceState) String() string

Oct 10, 2023

Changes in this version

type RoleOption

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

Oct 10, 2023

Changes in this version

type GlobalAction

+ const CreateQueryLogsCollectionGlobal

type WorkspaceAction

+ const CreateScheduledLambdaWs

+ const CreateSimilarityIndexWs

+ const CreateSnapshotWs

+ const DeleteScheduledLambdaWs

+ const DeleteSimilarityIndexWs

Oct 5, 2023

Changes in this version

+ const CollectionStatusCreated

+ const CollectionStatusInitialized

+ const CollectionStatusReady

+ const MountActive

+ const MountCreating

+ const MountDeleting

+ const MountExpired

+ const MountRefreshing

+ const MountSuspended

+ const MountSuspending

+ const MountSwitchingRefreshType

+ const VirtualInstanceActive

+ const VirtualInstanceDeleted

+ const VirtualInstanceInitializing

+ const VirtualInstanceProvisioningResources

+ const VirtualInstanceRebalancingCollections

+ const VirtualInstanceResuming

+ const VirtualInstanceSuspended

+ const VirtualInstanceSuspending

+ type QueryState string

+ const QueryCancelled

+ const QueryCompleted

+ const QueryError

+ const QueryQueued

+ const QueryRunning

type VirtualInstanceOption

+ func WithRemountOnResume(remount bool) VirtualInstanceOption

Sep 13, 2023

Changes in this version

type QueryOption

+ func WithDefaultRowLimit(limit int32) QueryOption

type VirtualInstanceOption

+ func WithVirtualInstanceDescription(desc string) VirtualInstanceOption

+ func WithVirtualInstanceName(name string) VirtualInstanceOption

type VirtualInstanceOptions

+ EnableRemountOnResume *bool

+ Name *string

Aug 14, 2023

Changes in this version

type QueryOption

+ func WithAsync() QueryOption

+ func WithMaxInitialResults(maxInitialResults int64) QueryOption

+ func WithTimeout(timeout int64) QueryOption

type VirtualInstanceOption

+ func WithNoMountRefresh() VirtualInstanceOption

May 1, 2023

Changes in this version

+ const StorageCompressionLZ4

+ const StorageCompressionZSTD

type CollectionOption

+ func WithStorageCompressionType(compressionType StorageCompressionType) CollectionOption

type QueryLambdaOption

+ func WithQueryLambdaParameter(name, valueType, value string) QueryLambdaOption

+ func WithQueryLambdaRowLimit(limit int32) QueryLambdaOption

+ func WithQueryLambdaWarnings() QueryLambdaOption

type QueryOption

+ func WithPaginationDocCount(limit int32) QueryOption

+ type StorageCompressionType string

+ func (s StorageCompressionType) String() string

type VirtualInstanceOption

+ func WithAutoSuspend(d time.Duration) VirtualInstanceOption

+ func WithContinuousMountRefresh() VirtualInstanceOption

+ func WithMountRefreshInterval(interval time.Duration) VirtualInstanceOption

+ func WithVirtualInstanceSize(size VirtualInstanceSize) VirtualInstanceOption

type VirtualInstanceOptions

+ AutoSuspend *time.Duration

+ Description *string

+ MountRefreshInterval *time.Duration

type VirtualInstanceSize

+ const SizeFree

+ const SizeLarge

+ const SizeMedium

+ const SizeMilli

+ const SizeNano

+ const SizeShared

+ const SizeSmall

+ const SizeXLarge

+ const SizeXLarge16

+ const SizeXLarge2

+ const SizeXLarge4

+ const SizeXLarge8

Apr 4, 2023

Changes in this version

type CollectionOption

+ func WithIngestTransformation(sql string) CollectionOption

Oct 27, 2022

Changes in this version

type CollectionOption

+ func WithSampleDataset(ds dataset.Sample) CollectionOption

+ func WithSampleDatasetPattern(pattern string) CollectionOption

+ type UserOption func(*UserOptions)

+ func WithUserFirstName(firstName string) UserOption

+ func WithUserLastName(lastName string) UserOption

+ type UserOptions struct

+ FirstName *string

+ LastName *string

+ Roles []openapi.Role

Oct 12, 2022

Changes in this version

+ func IsVirtualInstanceAction(action string) bool

type APIKeyOption

+ func RevealKey() APIKeyOption

+ func State(state KeyState) APIKeyOption

type APIKeyOptions

+ Reveal bool

+ State *KeyState

type CollectionOption

+ func WithCollectionDescription(d string) CollectionOption

+ func WithCollectionRequest(request openapi.CreateCollectionRequest) CollectionOption

+ func WithCollectionRetentionSeconds(s int64) CollectionOption

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

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

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

+ 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 WithAutoFormat() Format

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

+ func WithJSONFormat() Format

+ func WithXMLFormat(xml openapi.XmlParams) Format

type GlobalAction

+ const CreateVirtualInstanceGlobal

+ type KafkaFormat string

+ const KafkaFormatAVRO

+ const KafkaFormatJSON

+ func (f KafkaFormat) String() string

type KafkaIntegration

+ Config openapi.KafkaIntegration

type KafkaIntegrationOption

+ func WithKafkaBootstrapServers(servers string) KafkaIntegrationOption

+ func WithKafkaConnectionString(s string) KafkaIntegrationOption

+ func WithKafkaDataFormat(format KafkaFormat) KafkaIntegrationOption

+ func WithKafkaIntegrationConfig(config openapi.KafkaIntegration) KafkaIntegrationOption

+ func WithKafkaIntegrationTopic(topic string) KafkaIntegrationOption

+ func WithKafkaSchemaRegistryConfig(url, apiKey, secret string) KafkaIntegrationOption

+ func WithKafkaSecurityConfig(apiKey, secret string) KafkaIntegrationOption

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

+ func WithKafkaV3() KafkaIntegrationOption

+ type KafkaIntegrationTopicState string

+ const KafkaIntegrationActive

+ const KafkaIntegrationDormant

+ const KafkaIntegrationNoDocsYet

+ type KafkaSourceOption func(o *openapi.SourceKafka)

+ func WithKafkaConsumerGroupID(id string) KafkaSourceOption

+ func WithKafkaSourceV3() KafkaSourceOption

+ type KafkaStartingOffset string

+ const KafkaStartingOffsetEarliest

+ const KafkaStartingOffsetLatest

+ type KeyState string

+ const KeyActive

+ const KeySuspended

type QueryOption

+ func WithAsyncClientTimeout(timeout int64) QueryOption

+ func WithAsyncMaxInitialResults(timeout int64) QueryOption

+ func WithAsyncTimeout(timeout int64) QueryOption

+ type S3SourceOption func(o *openapi.SourceS3)

+ func WithS3Pattern(pattern string) S3SourceOption

+ func WithS3Prefix(prefix string) S3SourceOption

+ func WithS3Region(region string) S3SourceOption

+ type VirtualInstanceAction int

+ const AllVirtualInstanceAction

+ const DeleteVirtualInstanceAction

+ const QueryVirtualInstanceAction

+ const SuspendResumeVirtualInstanceAction

+ const UnknownVirtualInstanceAction

+ const UpdateVirtualInstanceAction

+ func GetVirtualInstanceAction(action string) VirtualInstanceAction

+ func (a VirtualInstanceAction) String() string

Apr 20, 2022

Changes in this version

type GlobalAction

+ const CreateAPIKeyGlobal

Apr 8, 2022

Changes in this version

+ const AllClusters

+ func IsGlobalAction(action string) bool

+ func IsIntegrationAction(action string) bool

+ func IsWorkspaceAction(action string) bool

+ type ClusterPrivileges func(*openapi.Privilege)

+ func WithAllCluster() ClusterPrivileges

type GlobalAction

+ const CreateApiKeyGlobal

+ const CreateIntegrationGlobal

+ const CreateRoleGlobal

+ const CreateWsGlobal

+ const DeleteIntegrationGlobal

+ const DeleteRoleGlobal

+ const DeleteUserGlobal

+ const GetBillingGlobal

+ const GetCurrentUserGlobal

+ const GetMetricsGlobal

+ const GetOrgGlobal

+ const GrantRevokeRoleGlobal

+ const InviteUserGlobal

+ const ListIntegrationsGlobal

+ const ListUsersGlobal

+ const ListViGlobal

+ const ListWsGlobal

+ const UnknownGlobalAction

+ const UpdateBillingGlobal

+ const UpdateResourceOwnerGlobal

+ const UpdateRoleGlobal

+ const UpdateSettingsGlobal

+ const UpdateViGlobal

+ func GetGlobalAction(action string) GlobalAction

type IntegrationAction

+ const UnknownIntegrationAction

+ func GetIntegrationAction(action string) IntegrationAction

type WorkspaceAction

+ const CreateAliasWs

+ const CreateCollectionWs

+ const CreateQueryLambdaWs

+ const CreateViewWs

+ const DeleteAliasWs

+ const DeleteCollectionWs

+ const DeleteQueryLambdaWs

+ const DeleteViewWs

+ const DeleteWs

+ const ExecuteQueryLambdaWs

+ const ListResourcesWs

+ const QueryDataWs

+ const UnknownWorkspaceAction

+ const WriteDataWs

+ func GetWorkspaceAction(action string) WorkspaceAction

Mar 31, 2022

Changes in this version

+ func WithCluster(name string) func(*openapi.Privilege)

+ type APIKeyRoleOption func(*APIKeyRoleOptions)

+ func WithRole(role string) APIKeyRoleOption

+ type APIKeyRoleOptions struct

+ Role *string

+ type GlobalAction int

+ const AllGlobalActions

+ const CreateApiKey

+ const CreateIntegration

+ const CreateRole

+ const CreateWs

+ const DeleteIntegration

+ const DeleteRole

+ const DeleteUser

+ const GetBilling

+ const GetCurrentUser

+ const GetMetrics

+ const GetOrg

+ const GrantRevokeRole

+ const InviteUser

+ const ListIntegrations

+ const ListRolesGlobal

+ const ListUsers

+ const ListVi

+ const ListWs

+ const UpdateBilling

+ const UpdateResourceOwner

+ const UpdateRole

+ const UpdateSettings

+ const UpdateVi

+ func (a GlobalAction) String() string

+ type IntegrationAction int

+ const AllIntegrationActions

+ const CreateCollectionIntegration

+ func (a IntegrationAction) String() string

+ type RoleOption func(p *RoleOptions)

+ func WithGlobalPrivilege(action GlobalAction) RoleOption

+ func WithIntegrationPrivilege(action IntegrationAction, integration string) RoleOption

+ func WithRoleDescription(desc string) RoleOption

+ func WithWorkspacePrivilege(action WorkspaceAction, workspace string, options ...func(*openapi.Privilege)) RoleOption

+ type RoleOptions struct

+ Description *string

+ Privileges []openapi.Privilege

+ type WorkspaceAction int

+ const AllWorkspaceActions

+ const CreateAlias

+ const CreateCollection

+ const CreateQueryLambda

+ const CreateView

+ const DeleteAlias

+ const DeleteCollection

+ const DeleteQueryLambda

+ const DeleteView

+ const DeleteWorkspace

+ const ExecuteQueryLambda

+ const ListResources

+ const QueryData

+ const WriteData

+ func (a WorkspaceAction) String() string

Mar 23, 2022

Changes in this version

type CollectionOption

+ func WithInsertOnly() CollectionOption

+ type ListViewOption func(o *ListViewOptions)

+ func WithViewWorkspace(ws string) ListViewOption

+ type ListViewOptions struct

+ Workspace string

+ type ViewOption func(p *ViewOptions)

+ func WithViewDescription(desc string) ViewOption

+ type ViewOptions struct

+ Description *string

Dec 8, 2021

Changes in this version

type CollectionOption

+ func WithFieldMappingQuery(sql string) CollectionOption

Jul 9, 2021

Changes in this version

+ type CreateQueryLambdaOption func(request *CreateQueryLambdaOptions)

+ func WithDefaultParameter(name, paramType, value string) CreateQueryLambdaOption

+ func WithQueryLambdaDescription(desc string) CreateQueryLambdaOption

+ type CreateQueryLambdaOptions struct

+ Description *string

+ QueryParameters []openapi.QueryParameter

Jul 6, 2021

Changes in this version

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

+ type ListCollectionOption func(o *ListCollectionOptions)

+ type ListCollectionOptions struct

+ Workspace *string

+ type ListQueryLambdaOption func(request *ListQueryLambdaOptions)

+ func WithQueryLambdaWorkspace(name string) ListQueryLambdaOption

+ type ListQueryLambdaOptions struct

+ Workspace *string

+ type ListQueryLambdaTagsOption func(request *ListQueryLambdaTagsOptions)

+ func WithQueryLambda(workspace, name string) ListQueryLambdaTagsOption

+ type ListQueryLambdaTagsOptions struct

+ QueryLambda *string

+ Workspace *string

Jun 25, 2021

Changes in this version

+ type APIKeyOption func(*APIKeyOptions)

+ func ForUser(username string) APIKeyOption

+ type APIKeyOptions struct

+ User *string

+ type AliasOption func(*AliasOptions)

+ func WithAliasDescription(name string) AliasOption

+ type AliasOptions struct

+ Description *string

type CollectionOption

+ func WithDynamoDBMaxRCU(maxRCU int64) CollectionOption

+ type IPAllowlistOption func(*IPAllowlistOptions)

+ func WithIPAllowlistDescription(desc string) IPAllowlistOption

+ type IPAllowlistOptions struct

+ Description *string

+ type KafkaIntegration struct

+ Description *string

+ type KafkaIntegrationOption func(request *KafkaIntegration)

+ func WithKafkaIntegrationDescription(desc string) KafkaIntegrationOption

+ type ListAliasesOption func(*ListAliasesOptions)

+ func WithAliasWorkspace(name string) ListAliasesOption

+ type ListAliasesOptions struct

+ Workspace string

+ type MongoDBIntegration struct

+ Description *string

+ type MongoDBIntegrationOption func(request *MongoDBIntegration)

+ func WithMongoDBIntegrationDescription(desc string) MongoDBIntegrationOption

+ type RedshiftIntegration struct

+ Description *string

+ type RedshiftIntegrationOption func(request *RedshiftIntegration)

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

+ func WithRedshiftIntegrationDescription(desc string) RedshiftIntegrationOption

+ type SegmentIntegration struct

+ Description *string

+ type SegmentIntegrationOption func(request *SegmentIntegration)

+ func WithSegmentIntegrationDescription(desc string) SegmentIntegrationOption

+ type VirtualInstanceOption func(*VirtualInstanceOptions)

+ func WithVIMonitoring(enabled bool) VirtualInstanceOption

+ func WithVISize(size VirtualInstanceSize) VirtualInstanceOption

+ func WithVIType(t VirtualInstanceType) VirtualInstanceOption

+ type VirtualInstanceOptions struct

+ MonitoringEnabled *bool

+ Size *string

+ Type *string

+ type VirtualInstanceSize string

+ const FreeSize

+ const LargeSize

+ const MediumSize

+ const SharedSize

+ const SmallSize

+ const XLarge16Size

+ const XLarge2Size

+ const XLarge4Size

+ const XLarge8Size

+ const XLargeSize

+ func (t VirtualInstanceSize) String() string

+ type VirtualInstanceType string

+ const FreeType

+ const LargeType

+ const MediumType

+ const SharedType

+ const SmallType

+ const XLarge16Type

+ const XLarge2Type

+ const XLarge4Type

+ const XLarge8Type

+ const XLargeType

+ func (t VirtualInstanceType) String() string

+ type WorkspaceOption func(p *WorkspaceOptions)

+ func WithWorkspaceDescription(desc string) WorkspaceOption

+ type WorkspaceOptions struct

+ Description *string

May 14, 2021

Changes in this version

+ type AWSCredentials struct

+ type AWSCredentialsFn func(o *AWSCredentials)

+ func AWSKeys(accessKey, secretKey string) AWSCredentialsFn

+ func AWSRole(roleARN string) AWSCredentialsFn

+ type CSV func(*openapi.CsvParams)

+ func WithEncoding(encoding string) CSV

+ func WithEscapeChar(escape string) CSV

+ func WithFirstLineAsColumnNames() CSV

+ func WithQuoteChar(quote string) CSV

+ func WithSeparator(separator string) CSV

+ type CollectionOption func(o *openapi.CreateCollectionRequest)

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

+ func WithCollectionEventTimeInfo(fieldName, tz string, format EventTimeInfoFormat) CollectionOption

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

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

+ func WithCollectionRetention(d time.Duration) CollectionOption

+ type ColumnIndexMode string

+ const ColumnIndexModeNoStore

+ const ColumnIndexModeStore

+ func (c ColumnIndexMode) String() string

+ type DynamoDBIntegration struct

+ Description *string

+ type DynamoDBIntegrationOption func(request *DynamoDBIntegration)

+ func WithDynamoDBIntegrationDescription(desc string) DynamoDBIntegrationOption

+ type EventTimeInfoFormat string

+ const MillisecondsSinceEpoch

+ const SecondsSinceEpoch

+ type ExecuteQueryLambdaRequest struct

+ Tag string

+ Version string

+ type FieldMissingAction string

+ const FieldMissingPass

+ const FieldMissingSkip

+ func (f FieldMissingAction) String() string

+ type FieldOption func(*openapi.FieldOptions)

+ func WithColumnIndexMode(mode ColumnIndexMode) FieldOption

+ func WithIndexMode(mode IndexMode) FieldOption

+ func WithRangeIndexMode(mode RangeIndexMode) FieldOption

+ func WithTypeIndexMode(mode TypeIndexMode) FieldOption

+ type GCSCredentialsFn func(*openapi.GcpServiceAccount)

+ func GCSServiceAccount(json string) GCSCredentialsFn

+ type GCSIntegration struct

+ Description *string

+ type GCSIntegrationOption func(request *GCSIntegration)

+ func WithGCSIntegrationDescription(desc string) GCSIntegrationOption

+ type IndexMode string

+ const IndexModeIndex

+ const IndexModeNoIndex

+ func (i IndexMode) String() string

+ type InputFieldFn func(field *openapi.InputField)

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

+ type KinesisIntegration struct

+ Description *string

+ type KinesisIntegrationOption func(request *KinesisIntegration)

+ func WithKinesisIntegrationDescription(desc string) KinesisIntegrationOption

+ type OnError string

+ const OnErrorFail

+ const OnErrorSkip

+ func (e OnError) String() string

+ type OutputFieldFn func(field *openapi.OutputField)

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

+ type QueryLambdaOption func(request *ExecuteQueryLambdaRequest)

+ func WithParameter2(name, valueType, value string) QueryLambdaOption

+ func WithRowLimit2(limit int32) QueryLambdaOption

+ func WithTag(tag string) QueryLambdaOption

+ func WithVersion(version string) QueryLambdaOption

+ func WithWarnings2() QueryLambdaOption

+ type QueryOption func(request *openapi.QueryRequestSql)

+ func WithParameter(name, valueType, value string) QueryOption

+ func WithProfiling() QueryOption

+ func WithRowLimit(limit int32) QueryOption

+ func WithWarnings() QueryOption

+ type RangeIndexMode string

+ const RangeIndexModeNoIndex

+ const RangeIndexModeV1Index

+ func (r RangeIndexMode) String() string

+ type S3Integration struct

+ Description *string

+ type S3IntegrationOption func(request *S3Integration)

+ func WithS3IntegrationDescription(desc string) S3IntegrationOption

+ type TypeIndexMode string

+ const TypeIndexModeIndex

+ const TypeIndexModeNoIndex

+ func (t TypeIndexMode) String() string