options

package
v3.42.6-rc0 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2023 License: Apache-2.0 Imports: 9 Imported by: 24

Documentation

Index

Constants

View Source
const (
	FeatureEnabled  = feature.Enabled
	FeatureDisabled = feature.Disabled
)
View Source
const (
	ExecuteScanQueryStatsTypeNone = iota
	ExecuteScanQueryStatsTypeBasic
	ExecuteScanQueryStatsTypeFull
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AlterTableDesc

type AlterTableDesc Ydb_Table.AlterTableRequest

type AlterTableOption

type AlterTableOption interface {
	ApplyAlterTableOption(*AlterTableDesc, *allocator.Allocator)
}

func WithAddAttribute added in v3.40.0

func WithAddAttribute(key, value string) AlterTableOption

WithAddAttribute adds attribute to table in AlterTable request

func WithAddColumn

func WithAddColumn(name string, typ types.Type) AlterTableOption

WithAddColumn adds column in AlterTable request

func WithAddColumnFamilies

func WithAddColumnFamilies(cf ...ColumnFamily) AlterTableOption

func WithAddColumnMeta

func WithAddColumnMeta(column Column) AlterTableOption

func WithAddIndex added in v3.40.0

func WithAddIndex(name string, opts ...IndexOption) AlterTableOption

func WithAlterAttribute

func WithAlterAttribute(key, value string) AlterTableOption

WithAlterAttribute changes attribute in AlterTable request

func WithAlterColumnFamilies

func WithAlterColumnFamilies(cf ...ColumnFamily) AlterTableOption

func WithAlterKeyBloomFilter

func WithAlterKeyBloomFilter(f FeatureFlag) AlterTableOption

func WithAlterPartitionSettingsObject

func WithAlterPartitionSettingsObject(ps PartitioningSettings) AlterTableOption

func WithAlterReadReplicasSettings

func WithAlterReadReplicasSettings(rr ReadReplicasSettings) AlterTableOption

func WithAlterStorageSettings

func WithAlterStorageSettings(ss StorageSettings) AlterTableOption

func WithDropAttribute added in v3.40.0

func WithDropAttribute(key string) AlterTableOption

WithDropAttribute drops attribute from table in AlterTable request

func WithDropColumn

func WithDropColumn(name string) AlterTableOption

func WithDropIndex added in v3.40.0

func WithDropIndex(name string) AlterTableOption

func WithDropTimeToLive

func WithDropTimeToLive() AlterTableOption

WithDropTimeToLive drops TTL settings in AlterTable request

func WithSetTimeToLiveSettings

func WithSetTimeToLiveSettings(settings TimeToLiveSettings) AlterTableOption

WithSetTimeToLiveSettings appends TTL settings in AlterTable request

type CachingPolicyDescription

type CachingPolicyDescription struct {
	Name   string
	Labels map[string]string
}

type CachingPolicyOption

type CachingPolicyOption func(*cachingPolicy)

func WithCachingPolicyPreset

func WithCachingPolicyPreset(name string) CachingPolicyOption

type ChangefeedDescription added in v3.38.2

type ChangefeedDescription struct {
	Name   string
	Mode   ChangefeedMode
	Format ChangefeedFormat
	State  ChangefeedState
}

func NewChangefeedDescription added in v3.38.2

func NewChangefeedDescription(proto *Ydb_Table.ChangefeedDescription) ChangefeedDescription

type ChangefeedFormat added in v3.38.2

type ChangefeedFormat int

type ChangefeedMode added in v3.38.2

type ChangefeedMode int

type ChangefeedState added in v3.38.2

type ChangefeedState int

type Column

type Column struct {
	Name   string
	Type   types.Type
	Family string
}

func NewTableColumn

func NewTableColumn(name string, typ types.Type, family string) Column

type ColumnFamily

type ColumnFamily struct {
	Name         string
	Data         StoragePool
	Compression  ColumnFamilyCompression
	KeepInMemory FeatureFlag
}

func NewColumnFamily

func NewColumnFamily(c *Ydb_Table.ColumnFamily) ColumnFamily

type ColumnFamilyCompression

type ColumnFamilyCompression byte
const (
	ColumnFamilyCompressionUnknown ColumnFamilyCompression = iota
	ColumnFamilyCompressionNone
	ColumnFamilyCompressionLZ4
)

func (ColumnFamilyCompression) String

func (c ColumnFamilyCompression) String() string

type CommitTransactionOption

type CommitTransactionOption func(*CommitTransactionDesc)

func WithCommitCollectStatsModeBasic

func WithCommitCollectStatsModeBasic() CommitTransactionOption

func WithCommitCollectStatsModeNone

func WithCommitCollectStatsModeNone() CommitTransactionOption

type CompactionPolicyDescription

type CompactionPolicyDescription struct {
	Name   string
	Labels map[string]string
}

type CompactionPolicyOption

type CompactionPolicyOption func(*compactionPolicy)

func WithCompactionPolicyPreset

func WithCompactionPolicyPreset(name string) CompactionPolicyOption

type CopyTableDesc

type CopyTableDesc Ydb_Table.CopyTableRequest

type CopyTableOption

type CopyTableOption func(*CopyTableDesc)

type CreateTableDesc

type CreateTableDesc Ydb_Table.CreateTableRequest

type CreateTableOption

type CreateTableOption interface {
	ApplyCreateTableOption(d *CreateTableDesc, a *allocator.Allocator)
}

func WithAttribute

func WithAttribute(key, value string) CreateTableOption

func WithColumn

func WithColumn(name string, typ types.Type) CreateTableOption

func WithColumnFamilies

func WithColumnFamilies(cf ...ColumnFamily) CreateTableOption

func WithColumnMeta

func WithColumnMeta(column Column) CreateTableOption

func WithIndex

func WithIndex(name string, opts ...IndexOption) CreateTableOption

func WithKeyBloomFilter

func WithKeyBloomFilter(f FeatureFlag) CreateTableOption

func WithPartitioningSettings added in v3.3.2

func WithPartitioningSettings(opts ...PartitioningSettingsOption) CreateTableOption

func WithPartitioningSettingsObject

func WithPartitioningSettingsObject(ps PartitioningSettings) CreateTableOption

func WithPrimaryKeyColumn

func WithPrimaryKeyColumn(columns ...string) CreateTableOption

func WithProfile

func WithProfile(opts ...ProfileOption) CreateTableOption

func WithReadReplicasSettings

func WithReadReplicasSettings(rr ReadReplicasSettings) CreateTableOption

func WithStorageSettings

func WithStorageSettings(ss StorageSettings) CreateTableOption

func WithTimeToLiveSettings

func WithTimeToLiveSettings(settings TimeToLiveSettings) CreateTableOption

WithTimeToLiveSettings defines TTL settings in CreateTable request

type DescribeTableDesc

type DescribeTableDesc Ydb_Table.DescribeTableRequest

type DescribeTableOption

type DescribeTableOption func(d *DescribeTableDesc)

func WithPartitionStats

func WithPartitionStats() DescribeTableOption

func WithShardKeyBounds

func WithShardKeyBounds() DescribeTableOption

func WithTableStats

func WithTableStats() DescribeTableOption

type Description

type Description struct {
	Name                 string
	Columns              []Column
	PrimaryKey           []string
	KeyRanges            []KeyRange
	Stats                *TableStats
	ColumnFamilies       []ColumnFamily
	Attributes           map[string]string
	ReadReplicaSettings  ReadReplicasSettings
	StorageSettings      StorageSettings
	KeyBloomFilter       FeatureFlag
	PartitioningSettings PartitioningSettings
	Indexes              []IndexDescription
	TimeToLiveSettings   *TimeToLiveSettings
	Changefeeds          []ChangefeedDescription
}

type DropTableDesc

type DropTableDesc Ydb_Table.DropTableRequest

type DropTableOption

type DropTableOption interface {
	ApplyDropTableOption(*DropTableDesc)
}

type ExecuteDataQueryDesc

type ExecuteDataQueryDesc Ydb_Table.ExecuteDataQueryRequest

type ExecuteDataQueryOption

type ExecuteDataQueryOption func(*ExecuteDataQueryDesc, *allocator.Allocator)

func WithCollectStatsModeBasic

func WithCollectStatsModeBasic() ExecuteDataQueryOption

func WithCollectStatsModeNone

func WithCollectStatsModeNone() ExecuteDataQueryOption

func WithCommit added in v3.42.0

func WithCommit() ExecuteDataQueryOption

WithCommit appends flag of commit transaction with executing query

func WithKeepInCache added in v3.25.0

func WithKeepInCache(keepInCache bool) ExecuteDataQueryOption

WithKeepInCache manages keep-in-cache flag in query cache policy

By default all data queries executes with keep-in-cache policy

func WithQueryCachePolicy deprecated

func WithQueryCachePolicy(opts ...QueryCachePolicyOption) ExecuteDataQueryOption

WithQueryCachePolicy manages query cache policy

Deprecated: use WithKeepInCache for disabling keep-in-cache policy

type ExecuteScanQueryDesc

type ExecuteScanQueryDesc Ydb_Table.ExecuteScanQueryRequest

type ExecuteScanQueryOption

type ExecuteScanQueryOption func(*ExecuteScanQueryDesc)

func WithExecuteScanQueryMode

func WithExecuteScanQueryMode(m ExecuteScanQueryRequestMode) ExecuteScanQueryOption

WithExecuteScanQueryMode defines scan query mode: execute or explain

func WithExecuteScanQueryStats added in v3.27.0

func WithExecuteScanQueryStats(stats ExecuteScanQueryStatsType) ExecuteScanQueryOption

WithExecuteScanQueryStats defines query statistics mode

type ExecuteScanQueryRequestMode

type ExecuteScanQueryRequestMode byte
const (
	ExecuteScanQueryRequestModeExec ExecuteScanQueryRequestMode = iota
	ExecuteScanQueryRequestModeExplain
)

type ExecuteScanQueryStatsType added in v3.27.0

type ExecuteScanQueryStatsType uint32

ExecuteScanQueryStatsType specified scan query mode

type ExecuteSchemeQueryOption

type ExecuteSchemeQueryOption func(*ExecuteSchemeQueryDesc)

type ExecutionPolicyDescription

type ExecutionPolicyDescription struct {
	Name   string
	Labels map[string]string
}

type ExecutionPolicyOption

type ExecutionPolicyOption func(*executionPolicy)

func WithExecutionPolicyPreset

func WithExecutionPolicyPreset(name string) ExecutionPolicyOption

type FeatureFlag

type FeatureFlag = feature.Flag

type IndexDescription

type IndexDescription struct {
	Name         string
	IndexColumns []string
	DataColumns  []string
	Status       Ydb_Table.TableIndexDescription_Status
}

type IndexOption

type IndexOption interface {
	ApplyIndexOption(d *indexDesc)
}

func WithDataColumns added in v3.39.0

func WithDataColumns(columns ...string) IndexOption

func WithIndexColumns

func WithIndexColumns(columns ...string) IndexOption

func WithIndexType

func WithIndexType(t IndexType) IndexOption

type IndexType

type IndexType interface {
	// contains filtered or unexported methods
}

func GlobalAsyncIndex

func GlobalAsyncIndex() IndexType

func GlobalIndex

func GlobalIndex() IndexType

type KeyRange

type KeyRange struct {
	From types.Value
	To   types.Value
}

func (KeyRange) String added in v3.7.0

func (kr KeyRange) String() string

type PartitionStats

type PartitionStats struct {
	RowsEstimate uint64
	StoreSize    uint64
}

type PartitioningMode

type PartitioningMode byte
const (
	PartitioningUnknown PartitioningMode = iota
	PartitioningDisabled
	PartitioningAutoSplit
	PartitioningAutoSplitMerge
)

type PartitioningPolicyDescription

type PartitioningPolicyDescription struct {
	Name   string
	Labels map[string]string
}

type PartitioningPolicyOption

type PartitioningPolicyOption func(*partitioningPolicy, *allocator.Allocator)

func WithPartitioningPolicyExplicitPartitions

func WithPartitioningPolicyExplicitPartitions(splitPoints ...types.Value) PartitioningPolicyOption

func WithPartitioningPolicyMode

func WithPartitioningPolicyMode(mode PartitioningMode) PartitioningPolicyOption

func WithPartitioningPolicyPreset

func WithPartitioningPolicyPreset(name string) PartitioningPolicyOption

func WithPartitioningPolicyUniformPartitions

func WithPartitioningPolicyUniformPartitions(n uint64) PartitioningPolicyOption

type PartitioningSettings

type PartitioningSettings struct {
	PartitioningBySize FeatureFlag
	PartitionSizeMb    uint64
	PartitioningByLoad FeatureFlag
	MinPartitionsCount uint64
	MaxPartitionsCount uint64
}

type PartitioningSettingsOption

type PartitioningSettingsOption interface {
	ApplyPartitioningSettingsOption(settings *ydbPartitioningSettings)
}

func WithMaxPartitionsCount

func WithMaxPartitionsCount(maxPartitionsCount uint64) PartitioningSettingsOption

func WithMinPartitionsCount

func WithMinPartitionsCount(minPartitionsCount uint64) PartitioningSettingsOption

func WithPartitionSizeMb

func WithPartitionSizeMb(partitionSizeMb uint64) PartitioningSettingsOption

func WithPartitioningBy added in v3.41.0

func WithPartitioningBy(columns []string) PartitioningSettingsOption

func WithPartitioningByLoad

func WithPartitioningByLoad(flag FeatureFlag) PartitioningSettingsOption

func WithPartitioningBySize

func WithPartitioningBySize(flag FeatureFlag) PartitioningSettingsOption

type ProfileOption

type ProfileOption interface {
	ApplyProfileOption(p *profile, a *allocator.Allocator)
}

func WithCachingPolicy

func WithCachingPolicy(opts ...CachingPolicyOption) ProfileOption

func WithCompactionPolicy

func WithCompactionPolicy(opts ...CompactionPolicyOption) ProfileOption

func WithExecutionPolicy

func WithExecutionPolicy(opts ...ExecutionPolicyOption) ProfileOption

func WithPartitioningPolicy

func WithPartitioningPolicy(opts ...PartitioningPolicyOption) ProfileOption

func WithProfilePreset

func WithProfilePreset(name string) ProfileOption

func WithReplicationPolicy

func WithReplicationPolicy(opts ...ReplicationPolicyOption) ProfileOption

func WithStoragePolicy

func WithStoragePolicy(opts ...StoragePolicyOption) ProfileOption

type QueryCachePolicyOption

type QueryCachePolicyOption func(*queryCachePolicy, *allocator.Allocator)

func WithQueryCachePolicyKeepInCache deprecated

func WithQueryCachePolicyKeepInCache() QueryCachePolicyOption

WithQueryCachePolicyKeepInCache manages keep-in-cache policy

Deprecated: data queries always executes with enabled keep-in-cache policy. Use WithKeepInCache for disabling keep-in-cache policy

type ReadReplicasSettings

type ReadReplicasSettings struct {
	Type  ReadReplicasType
	Count uint64
}

func (ReadReplicasSettings) ToYDB

type ReadReplicasType

type ReadReplicasType byte
const (
	ReadReplicasPerAzReadReplicas ReadReplicasType = iota
	ReadReplicasAnyAzReadReplicas
)

type ReadTableDesc

type ReadTableDesc Ydb_Table.ReadTableRequest

Read table options

type ReadTableOption

type ReadTableOption func(*ReadTableDesc, *allocator.Allocator)

Read table options

func ReadColumn

func ReadColumn(name string) ReadTableOption

func ReadGreater

func ReadGreater(x types.Value) ReadTableOption

func ReadGreaterOrEqual

func ReadGreaterOrEqual(x types.Value) ReadTableOption

func ReadKeyRange

func ReadKeyRange(x KeyRange) ReadTableOption

ReadKeyRange returns ReadTableOption which makes ReadTable read values in range [x.From, x.To).

Both x.From and x.To may be nil.

func ReadLess

func ReadLess(x types.Value) ReadTableOption

func ReadLessOrEqual

func ReadLessOrEqual(x types.Value) ReadTableOption

func ReadOrdered

func ReadOrdered() ReadTableOption

func ReadRowLimit

func ReadRowLimit(n uint64) ReadTableOption

type ReplicationPolicyDescription

type ReplicationPolicyDescription struct {
	Name   string
	Labels map[string]string
}

type ReplicationPolicyOption

type ReplicationPolicyOption func(*replicationPolicy)

func WithReplicationPolicyAllowPromotion

func WithReplicationPolicyAllowPromotion(flag FeatureFlag) ReplicationPolicyOption

func WithReplicationPolicyCreatePerAZ

func WithReplicationPolicyCreatePerAZ(flag FeatureFlag) ReplicationPolicyOption

func WithReplicationPolicyPreset

func WithReplicationPolicyPreset(name string) ReplicationPolicyOption

func WithReplicationPolicyReplicasCount

func WithReplicationPolicyReplicasCount(n uint32) ReplicationPolicyOption

type StoragePolicyDescription

type StoragePolicyDescription struct {
	Name   string
	Labels map[string]string
}

type StoragePolicyOption

type StoragePolicyOption func(*storagePolicy)

func WithStoragePolicyData

func WithStoragePolicyData(kind string) StoragePolicyOption

func WithStoragePolicyExternal

func WithStoragePolicyExternal(kind string) StoragePolicyOption

func WithStoragePolicyKeepInMemory

func WithStoragePolicyKeepInMemory(flag FeatureFlag) StoragePolicyOption

func WithStoragePolicyLog

func WithStoragePolicyLog(kind string) StoragePolicyOption

func WithStoragePolicyPreset

func WithStoragePolicyPreset(name string) StoragePolicyOption

func WithStoragePolicySyslog

func WithStoragePolicySyslog(kind string) StoragePolicyOption

type StoragePool

type StoragePool struct {
	Media string
}

type StorageSettings

type StorageSettings struct {
	TableCommitLog0    StoragePool
	TableCommitLog1    StoragePool
	External           StoragePool
	StoreExternalBlobs FeatureFlag
}

func NewStorageSettings

func NewStorageSettings(ss *Ydb_Table.StorageSettings) StorageSettings

func (StorageSettings) ToYDB

type TTLSettings deprecated

type TTLSettings struct {
	DateTimeColumn string
	TTLSeconds     uint32
}

Deprecated: use TimeToLiveSettings instead. Will be removed after Jan 2022.

type TableOptionsDescription

type TableOptionsDescription struct {
	TableProfilePresets       []TableProfileDescription
	StoragePolicyPresets      []StoragePolicyDescription
	CompactionPolicyPresets   []CompactionPolicyDescription
	PartitioningPolicyPresets []PartitioningPolicyDescription
	ExecutionPolicyPresets    []ExecutionPolicyDescription
	ReplicationPolicyPresets  []ReplicationPolicyDescription
	CachingPolicyPresets      []CachingPolicyDescription
}

type TableProfileDescription

type TableProfileDescription struct {
	Name   string
	Labels map[string]string

	DefaultStoragePolicy      string
	DefaultCompactionPolicy   string
	DefaultPartitioningPolicy string
	DefaultExecutionPolicy    string
	DefaultReplicationPolicy  string
	DefaultCachingPolicy      string

	AllowedStoragePolicies      []string
	AllowedCompactionPolicies   []string
	AllowedPartitioningPolicies []string
	AllowedExecutionPolicies    []string
	AllowedReplicationPolicies  []string
	AllowedCachingPolicies      []string
}

type TableStats

type TableStats struct {
	PartitionStats   []PartitionStats
	RowsEstimate     uint64
	StoreSize        uint64
	Partitions       uint64
	CreationTime     time.Time
	ModificationTime time.Time
}

type TimeToLiveMode

type TimeToLiveMode byte
const (
	TimeToLiveModeDateType TimeToLiveMode = iota
	TimeToLiveModeValueSinceUnixEpoch
)

type TimeToLiveSettings

type TimeToLiveSettings struct {
	ColumnName string

	// Mode specified mode
	Mode TimeToLiveMode

	// ExpireAfterSeconds specified expiration in seconds
	ExpireAfterSeconds uint32

	// ColumnUnit valid with Mode = TimeToLiveModeValueSinceUnixEpoch
	ColumnUnit *TimeToLiveUnit
}

func NewTTLSettings added in v3.40.1

func NewTTLSettings() TimeToLiveSettings

func (TimeToLiveSettings) ColumnDateType added in v3.40.1

func (ttl TimeToLiveSettings) ColumnDateType(columnName string) TimeToLiveSettings

func (TimeToLiveSettings) ColumnMicroseconds added in v3.40.1

func (ttl TimeToLiveSettings) ColumnMicroseconds(columnName string) TimeToLiveSettings

func (TimeToLiveSettings) ColumnMilliseconds added in v3.40.1

func (ttl TimeToLiveSettings) ColumnMilliseconds(columnName string) TimeToLiveSettings

func (TimeToLiveSettings) ColumnNanoseconds added in v3.40.1

func (ttl TimeToLiveSettings) ColumnNanoseconds(columnName string) TimeToLiveSettings

func (TimeToLiveSettings) ColumnSeconds added in v3.40.1

func (ttl TimeToLiveSettings) ColumnSeconds(columnName string) TimeToLiveSettings

func (TimeToLiveSettings) ExpireAfter added in v3.40.1

func (ttl TimeToLiveSettings) ExpireAfter(expireAfter time.Duration) TimeToLiveSettings

func (*TimeToLiveSettings) ToYDB

type TimeToLiveUnit

type TimeToLiveUnit int32
const (
	TimeToLiveUnitUnspecified TimeToLiveUnit = iota
	TimeToLiveUnitSeconds
	TimeToLiveUnitMilliseconds
	TimeToLiveUnitMicroseconds
	TimeToLiveUnitNanoseconds
)

func (*TimeToLiveUnit) ToYDB

Jump to

Keyboard shortcuts

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