series

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Aug 10, 2018 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Package series is a generated GoMock package.

Package series is a generated GoMock package.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrSeriesAllDatapointsExpired is returned on tick when all datapoints are expired
	ErrSeriesAllDatapointsExpired = errors.New("series datapoints are all expired")
)

Functions

func ValidateCachePolicy 

func ValidateCachePolicy(v CachePolicy) error

ValidateCachePolicy validates a cache policy.

Types

type BootstrapResult 

type BootstrapResult struct {
	NumBlocksMovedToBuffer int64
	NumBlocksMerged        int64
}

BootstrapResult contains information about the result of bootstrapping a series. It is returned from the series Bootstrap method primarily so the caller can aggregate and emit metrics instead of the series itself having to store additional fields (which would be costly because we have millions of them.)

type CachePolicy 

type CachePolicy uint

CachePolicy is the series cache policy. 

const (
	// CacheNone specifies that no series will be cached by default.
	CacheNone CachePolicy = iota
	// CacheAll specifies that all series must be cached at all times
	// which requires loading all into cache on bootstrap and never
	// expiring series from memory until expired from retention.
	CacheAll
	// CacheAllMetadata specifies that all series metadata but not the
	// data itself must be cached at all times and the metadata is never
	// expired from memory until expired from retention.
	// TODO: Remove this once recently read is production grade.
	CacheAllMetadata
	// CacheRecentlyRead specifies that series that are recently read
	// must be cached, configurable by the namespace block expiry after
	// not accessed period.
	CacheRecentlyRead
	// CacheLRU specifies that series that are read will be cached
	// using an LRU of fixed capacity. Series that are least recently
	// used will be evicted first.
	CacheLRU

	// DefaultCachePolicy is the default cache policy.
	DefaultCachePolicy = CacheRecentlyRead
)

func ParseCachePolicy 

func ParseCachePolicy(str string) (CachePolicy, error)

ParseCachePolicy parses a CachePolicy from a string.

func ValidCachePolicies 

func ValidCachePolicies() []CachePolicy

ValidCachePolicies returns the valid series cache policies.

func (CachePolicy) String 

func (p CachePolicy) String() string

func (*CachePolicy) UnmarshalYAML 

func (p *CachePolicy) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals an CachePolicy into a valid type from string.

type DatabaseSeries 

type DatabaseSeries interface {
	block.OnRetrieveBlock
	block.OnEvictedFromWiredList

	// ID returns the ID of the series
	ID() ident.ID

	// Tags return the tags of the series
	Tags() ident.Tags

	// Tick executes any updates to ensure buffer drains, blocks are flushed, etc
	Tick() (TickResult, error)

	// Write writes a new value
	Write(
		ctx context.Context,
		timestamp time.Time,
		value float64,
		unit xtime.Unit,
		annotation []byte,
	) error

	// ReadEncoded reads encoded blocks
	ReadEncoded(
		ctx context.Context,
		start, end time.Time,
	) ([][]xio.BlockReader, error)

	// FetchBlocks returns data blocks given a list of block start times
	FetchBlocks(
		ctx context.Context,
		starts []time.Time,
	) ([]block.FetchBlockResult, error)

	// FetchBlocksMetadata returns the blocks metadata
	FetchBlocksMetadata(
		ctx context.Context,
		start, end time.Time,
		opts FetchBlocksMetadataOptions,
	) (block.FetchBlocksMetadataResult, error)

	// IsEmpty returns whether series is empty
	IsEmpty() bool

	// NumActiveBlocks returns the number of active blocks the series currently holds
	NumActiveBlocks() int

	// IsBootstrapped returns whether the series is bootstrapped or not
	IsBootstrapped() bool

	// Bootstrap merges the raw series bootstrapped along with any buffered data
	Bootstrap(blocks block.DatabaseSeriesBlocks) (BootstrapResult, error)

	// Flush flushes the data blocks of this series for a given start time
	Flush(ctx context.Context, blockStart time.Time, persistFn persist.DataFn) (FlushOutcome, error)

	// Snapshot snapshots the buffer buckets of this series for any data that has
	// not been rotated into a block yet
	Snapshot(ctx context.Context, blockStart time.Time, persistFn persist.DataFn) error

	// Close will close the series and if pooled returned to the pool
	Close()

	// Reset resets the series for reuse
	Reset(
		id ident.ID,
		tags ident.Tags,
		blockRetriever QueryableBlockRetriever,
		onRetrieveBlock block.OnRetrieveBlock,
		onEvictedFromWiredList block.OnEvictedFromWiredList,
		opts Options,
	)
}

DatabaseSeries is a series in the database

func NewDatabaseSeries 

func NewDatabaseSeries(id ident.ID, tags ident.Tags, opts Options) DatabaseSeries

NewDatabaseSeries creates a new database series

type DatabaseSeriesAllocate 

type DatabaseSeriesAllocate func() DatabaseSeries

DatabaseSeriesAllocate allocates a database series for a pool

type DatabaseSeriesPool 

type DatabaseSeriesPool interface {
	// Get provides a database series from the pool
	Get() DatabaseSeries

	// Put returns a database series to the pool
	Put(block DatabaseSeries)
}

DatabaseSeriesPool provides a pool for database series

func NewDatabaseSeriesPool 

func NewDatabaseSeriesPool(opts pool.ObjectPoolOptions) DatabaseSeriesPool

NewDatabaseSeriesPool creates a new database series pool

type FetchBlocksMetadataOptions 

type FetchBlocksMetadataOptions struct {
	block.FetchBlocksMetadataOptions

	// IncludeCachedBlocks specifies whether to also include cached blocks
	// when returning series metadata.
	IncludeCachedBlocks bool
}

FetchBlocksMetadataOptions encapsulates block fetch metadata options and specifies a few series specific options too.

type FlushOutcome 

type FlushOutcome int

FlushOutcome is an enum that provides more context about the outcome of series.Flush() to the caller. 

const (
	// FlushOutcomeErr is just a default value that can be returned when we're also returning an error
	FlushOutcomeErr FlushOutcome = iota
	// FlushOutcomeBlockDoesNotExist indicates that the series did not have a block for the specified flush blockStart.
	FlushOutcomeBlockDoesNotExist
	// FlushOutcomeFlushedToDisk indicates that a block existed and was flushed to disk successfully.
	FlushOutcomeFlushedToDisk
)

type MockDatabaseSeries 

type MockDatabaseSeries struct {
	// contains filtered or unexported fields
}

MockDatabaseSeries is a mock of DatabaseSeries interface

func NewMockDatabaseSeries 

func NewMockDatabaseSeries(ctrl *gomock.Controller) *MockDatabaseSeries

NewMockDatabaseSeries creates a new mock instance

func (*MockDatabaseSeries) Bootstrap 

func (m *MockDatabaseSeries) Bootstrap(arg0 block.DatabaseSeriesBlocks) (BootstrapResult, error)

Bootstrap mocks base method

func (*MockDatabaseSeries) Close 

func (m *MockDatabaseSeries) Close()

Close mocks base method

func (*MockDatabaseSeries) EXPECT 

func (m *MockDatabaseSeries) EXPECT() *MockDatabaseSeriesMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockDatabaseSeries) FetchBlocks 

func (m *MockDatabaseSeries) FetchBlocks(arg0 context.Context, arg1 []time.Time) ([]block.FetchBlockResult, error)

FetchBlocks mocks base method

func (*MockDatabaseSeries) FetchBlocksMetadata 

func (m *MockDatabaseSeries) FetchBlocksMetadata(arg0 context.Context, arg1, arg2 time.Time, arg3 FetchBlocksMetadataOptions) (block.FetchBlocksMetadataResult, error)

FetchBlocksMetadata mocks base method

func (*MockDatabaseSeries) Flush 

func (m *MockDatabaseSeries) Flush(arg0 context.Context, arg1 time.Time, arg2 persist.DataFn) (FlushOutcome, error)

Flush mocks base method

func (*MockDatabaseSeries) ID 

func (m *MockDatabaseSeries) ID() ident.ID

ID mocks base method

func (*MockDatabaseSeries) IsBootstrapped 

func (m *MockDatabaseSeries) IsBootstrapped() bool

IsBootstrapped mocks base method

func (*MockDatabaseSeries) IsEmpty 

func (m *MockDatabaseSeries) IsEmpty() bool

IsEmpty mocks base method

func (*MockDatabaseSeries) NumActiveBlocks 

func (m *MockDatabaseSeries) NumActiveBlocks() int

NumActiveBlocks mocks base method

func (*MockDatabaseSeries) OnEvictedFromWiredList 

func (m *MockDatabaseSeries) OnEvictedFromWiredList(arg0 ident.ID, arg1 time.Time)

OnEvictedFromWiredList mocks base method

func (*MockDatabaseSeries) OnRetrieveBlock 

func (m *MockDatabaseSeries) OnRetrieveBlock(arg0 ident.ID, arg1 ident.TagIterator, arg2 time.Time, arg3 ts.Segment)

OnRetrieveBlock mocks base method

func (*MockDatabaseSeries) ReadEncoded 

func (m *MockDatabaseSeries) ReadEncoded(arg0 context.Context, arg1, arg2 time.Time) ([][]xio.BlockReader, error)

ReadEncoded mocks base method

func (*MockDatabaseSeries) Reset 

func (m *MockDatabaseSeries) Reset(arg0 ident.ID, arg1 ident.Tags, arg2 QueryableBlockRetriever, arg3 block.OnRetrieveBlock, arg4 block.OnEvictedFromWiredList, arg5 Options)

Reset mocks base method

func (*MockDatabaseSeries) Snapshot 

func (m *MockDatabaseSeries) Snapshot(arg0 context.Context, arg1 time.Time, arg2 persist.DataFn) error

Snapshot mocks base method

func (*MockDatabaseSeries) Tags 

func (m *MockDatabaseSeries) Tags() ident.Tags

Tags mocks base method

func (*MockDatabaseSeries) Tick 

func (m *MockDatabaseSeries) Tick() (TickResult, error)

Tick mocks base method

func (*MockDatabaseSeries) Write 

func (m *MockDatabaseSeries) Write(arg0 context.Context, arg1 time.Time, arg2 float64, arg3 time0.Unit, arg4 []byte) error

Write mocks base method

type MockDatabaseSeriesMockRecorder 

type MockDatabaseSeriesMockRecorder struct {
	// contains filtered or unexported fields
}

MockDatabaseSeriesMockRecorder is the mock recorder for MockDatabaseSeries

func (*MockDatabaseSeriesMockRecorder) Bootstrap 

func (mr *MockDatabaseSeriesMockRecorder) Bootstrap(arg0 interface{}) *gomock.Call

Bootstrap indicates an expected call of Bootstrap

func (*MockDatabaseSeriesMockRecorder) Close 

func (mr *MockDatabaseSeriesMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close

func (*MockDatabaseSeriesMockRecorder) FetchBlocks 

func (mr *MockDatabaseSeriesMockRecorder) FetchBlocks(arg0, arg1 interface{}) *gomock.Call

FetchBlocks indicates an expected call of FetchBlocks

func (*MockDatabaseSeriesMockRecorder) FetchBlocksMetadata 

func (mr *MockDatabaseSeriesMockRecorder) FetchBlocksMetadata(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

FetchBlocksMetadata indicates an expected call of FetchBlocksMetadata

func (*MockDatabaseSeriesMockRecorder) Flush 

func (mr *MockDatabaseSeriesMockRecorder) Flush(arg0, arg1, arg2 interface{}) *gomock.Call

Flush indicates an expected call of Flush

func (*MockDatabaseSeriesMockRecorder) ID 

func (mr *MockDatabaseSeriesMockRecorder) ID() *gomock.Call

ID indicates an expected call of ID

func (*MockDatabaseSeriesMockRecorder) IsBootstrapped 

func (mr *MockDatabaseSeriesMockRecorder) IsBootstrapped() *gomock.Call

IsBootstrapped indicates an expected call of IsBootstrapped

func (*MockDatabaseSeriesMockRecorder) IsEmpty 

func (mr *MockDatabaseSeriesMockRecorder) IsEmpty() *gomock.Call

IsEmpty indicates an expected call of IsEmpty

func (*MockDatabaseSeriesMockRecorder) NumActiveBlocks 

func (mr *MockDatabaseSeriesMockRecorder) NumActiveBlocks() *gomock.Call

NumActiveBlocks indicates an expected call of NumActiveBlocks

func (*MockDatabaseSeriesMockRecorder) OnEvictedFromWiredList 

func (mr *MockDatabaseSeriesMockRecorder) OnEvictedFromWiredList(arg0, arg1 interface{}) *gomock.Call

OnEvictedFromWiredList indicates an expected call of OnEvictedFromWiredList

func (*MockDatabaseSeriesMockRecorder) OnRetrieveBlock 

func (mr *MockDatabaseSeriesMockRecorder) OnRetrieveBlock(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

OnRetrieveBlock indicates an expected call of OnRetrieveBlock

func (*MockDatabaseSeriesMockRecorder) ReadEncoded 

func (mr *MockDatabaseSeriesMockRecorder) ReadEncoded(arg0, arg1, arg2 interface{}) *gomock.Call

ReadEncoded indicates an expected call of ReadEncoded

func (*MockDatabaseSeriesMockRecorder) Reset 

func (mr *MockDatabaseSeriesMockRecorder) Reset(arg0, arg1, arg2, arg3, arg4, arg5 interface{}) *gomock.Call

Reset indicates an expected call of Reset

func (*MockDatabaseSeriesMockRecorder) Snapshot 

func (mr *MockDatabaseSeriesMockRecorder) Snapshot(arg0, arg1, arg2 interface{}) *gomock.Call

Snapshot indicates an expected call of Snapshot

func (*MockDatabaseSeriesMockRecorder) Tags 

func (mr *MockDatabaseSeriesMockRecorder) Tags() *gomock.Call

Tags indicates an expected call of Tags

func (*MockDatabaseSeriesMockRecorder) Tick 

func (mr *MockDatabaseSeriesMockRecorder) Tick() *gomock.Call

Tick indicates an expected call of Tick

func (*MockDatabaseSeriesMockRecorder) Write 

func (mr *MockDatabaseSeriesMockRecorder) Write(arg0, arg1, arg2, arg3, arg4 interface{}) *gomock.Call

Write indicates an expected call of Write

type MockQueryableBlockRetriever 

type MockQueryableBlockRetriever struct {
	// contains filtered or unexported fields
}

MockQueryableBlockRetriever is a mock of QueryableBlockRetriever interface

func NewMockQueryableBlockRetriever 

func NewMockQueryableBlockRetriever(ctrl *gomock.Controller) *MockQueryableBlockRetriever

NewMockQueryableBlockRetriever creates a new mock instance

func (*MockQueryableBlockRetriever) EXPECT 

func (m *MockQueryableBlockRetriever) EXPECT() *MockQueryableBlockRetrieverMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockQueryableBlockRetriever) IsBlockRetrievable 

func (m *MockQueryableBlockRetriever) IsBlockRetrievable(arg0 time.Time) bool

IsBlockRetrievable mocks base method

func (*MockQueryableBlockRetriever) Stream 

func (m *MockQueryableBlockRetriever) Stream(arg0 context.Context, arg1 ident.ID, arg2 time.Time, arg3 block.OnRetrieveBlock) (xio.BlockReader, error)

Stream mocks base method

type MockQueryableBlockRetrieverMockRecorder 

type MockQueryableBlockRetrieverMockRecorder struct {
	// contains filtered or unexported fields
}

MockQueryableBlockRetrieverMockRecorder is the mock recorder for MockQueryableBlockRetriever

func (*MockQueryableBlockRetrieverMockRecorder) IsBlockRetrievable 

func (mr *MockQueryableBlockRetrieverMockRecorder) IsBlockRetrievable(arg0 interface{}) *gomock.Call

IsBlockRetrievable indicates an expected call of IsBlockRetrievable

func (*MockQueryableBlockRetrieverMockRecorder) Stream 

func (mr *MockQueryableBlockRetrieverMockRecorder) Stream(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

Stream indicates an expected call of Stream

type MockdatabaseBuffer 

type MockdatabaseBuffer struct {
	// contains filtered or unexported fields
}

MockdatabaseBuffer is a mock of databaseBuffer interface

func NewMockdatabaseBuffer 

func NewMockdatabaseBuffer(ctrl *gomock.Controller) *MockdatabaseBuffer

NewMockdatabaseBuffer creates a new mock instance

func (*MockdatabaseBuffer) Bootstrap 

func (m *MockdatabaseBuffer) Bootstrap(bl block.DatabaseBlock) error

Bootstrap mocks base method

func (*MockdatabaseBuffer) DrainAndReset 

func (m *MockdatabaseBuffer) DrainAndReset() drainAndResetResult

DrainAndReset mocks base method

func (*MockdatabaseBuffer) EXPECT 

func (m *MockdatabaseBuffer) EXPECT() *MockdatabaseBufferMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockdatabaseBuffer) FetchBlocks 

func (m *MockdatabaseBuffer) FetchBlocks(ctx context.Context, starts []time.Time) []block.FetchBlockResult

FetchBlocks mocks base method

func (*MockdatabaseBuffer) FetchBlocksMetadata 

func (m *MockdatabaseBuffer) FetchBlocksMetadata(ctx context.Context, start, end time.Time, opts FetchBlocksMetadataOptions) block.FetchBlockMetadataResults

FetchBlocksMetadata mocks base method

func (*MockdatabaseBuffer) IsEmpty 

func (m *MockdatabaseBuffer) IsEmpty() bool

IsEmpty mocks base method

func (*MockdatabaseBuffer) MinMax 

func (m *MockdatabaseBuffer) MinMax() (time.Time, time.Time, error)

MinMax mocks base method

func (*MockdatabaseBuffer) NeedsDrain 

func (m *MockdatabaseBuffer) NeedsDrain() bool

NeedsDrain mocks base method

func (*MockdatabaseBuffer) ReadEncoded 

func (m *MockdatabaseBuffer) ReadEncoded(ctx context.Context, start, end time.Time) [][]xio.BlockReader

ReadEncoded mocks base method

func (*MockdatabaseBuffer) Reset 

func (m *MockdatabaseBuffer) Reset(opts Options)

Reset mocks base method

func (*MockdatabaseBuffer) Snapshot 

func (m *MockdatabaseBuffer) Snapshot(ctx context.Context, blockStart time.Time) (xio.SegmentReader, error)

Snapshot mocks base method

func (*MockdatabaseBuffer) Stats 

func (m *MockdatabaseBuffer) Stats() bufferStats

Stats mocks base method

func (*MockdatabaseBuffer) Tick 

func (m *MockdatabaseBuffer) Tick() bufferTickResult

Tick mocks base method

func (*MockdatabaseBuffer) Write 

func (m *MockdatabaseBuffer) Write(ctx context.Context, timestamp time.Time, value float64, unit time0.Unit, annotation []byte) error

Write mocks base method

type MockdatabaseBufferMockRecorder 

type MockdatabaseBufferMockRecorder struct {
	// contains filtered or unexported fields
}

MockdatabaseBufferMockRecorder is the mock recorder for MockdatabaseBuffer

func (*MockdatabaseBufferMockRecorder) Bootstrap 

func (mr *MockdatabaseBufferMockRecorder) Bootstrap(bl interface{}) *gomock.Call

Bootstrap indicates an expected call of Bootstrap

func (*MockdatabaseBufferMockRecorder) DrainAndReset 

func (mr *MockdatabaseBufferMockRecorder) DrainAndReset() *gomock.Call

DrainAndReset indicates an expected call of DrainAndReset

func (*MockdatabaseBufferMockRecorder) FetchBlocks 

func (mr *MockdatabaseBufferMockRecorder) FetchBlocks(ctx, starts interface{}) *gomock.Call

FetchBlocks indicates an expected call of FetchBlocks

func (*MockdatabaseBufferMockRecorder) FetchBlocksMetadata 

func (mr *MockdatabaseBufferMockRecorder) FetchBlocksMetadata(ctx, start, end, opts interface{}) *gomock.Call

FetchBlocksMetadata indicates an expected call of FetchBlocksMetadata

func (*MockdatabaseBufferMockRecorder) IsEmpty 

func (mr *MockdatabaseBufferMockRecorder) IsEmpty() *gomock.Call

IsEmpty indicates an expected call of IsEmpty

func (*MockdatabaseBufferMockRecorder) MinMax 

func (mr *MockdatabaseBufferMockRecorder) MinMax() *gomock.Call

MinMax indicates an expected call of MinMax

func (*MockdatabaseBufferMockRecorder) NeedsDrain 

func (mr *MockdatabaseBufferMockRecorder) NeedsDrain() *gomock.Call

NeedsDrain indicates an expected call of NeedsDrain

func (*MockdatabaseBufferMockRecorder) ReadEncoded 

func (mr *MockdatabaseBufferMockRecorder) ReadEncoded(ctx, start, end interface{}) *gomock.Call

ReadEncoded indicates an expected call of ReadEncoded

func (*MockdatabaseBufferMockRecorder) Reset 

func (mr *MockdatabaseBufferMockRecorder) Reset(opts interface{}) *gomock.Call

Reset indicates an expected call of Reset

func (*MockdatabaseBufferMockRecorder) Snapshot 

func (mr *MockdatabaseBufferMockRecorder) Snapshot(ctx, blockStart interface{}) *gomock.Call

Snapshot indicates an expected call of Snapshot

func (*MockdatabaseBufferMockRecorder) Stats 

func (mr *MockdatabaseBufferMockRecorder) Stats() *gomock.Call

Stats indicates an expected call of Stats

func (*MockdatabaseBufferMockRecorder) Tick 

func (mr *MockdatabaseBufferMockRecorder) Tick() *gomock.Call

Tick indicates an expected call of Tick

func (*MockdatabaseBufferMockRecorder) Write 

func (mr *MockdatabaseBufferMockRecorder) Write(ctx, timestamp, value, unit, annotation interface{}) *gomock.Call

Write indicates an expected call of Write

type Options 

type Options interface {
	// Validate validates the options
	Validate() error

	// SetClockOptions sets the clock options
	SetClockOptions(value clock.Options) Options

	// ClockOptions returns the clock options
	ClockOptions() clock.Options

	// SetInstrumentOptions sets the instrumentation options
	SetInstrumentOptions(value instrument.Options) Options

	// InstrumentOptions returns the instrumentation options
	InstrumentOptions() instrument.Options

	// SetRetentionOptions sets the retention options
	SetRetentionOptions(value retention.Options) Options

	// RetentionOptions returns the retention options
	RetentionOptions() retention.Options

	// SetDatabaseBlockOptions sets the database block options
	SetDatabaseBlockOptions(value block.Options) Options

	// DatabaseBlockOptions returns the database block options
	DatabaseBlockOptions() block.Options

	// SetCachePolicy sets the series cache policy
	SetCachePolicy(value CachePolicy) Options

	// CachePolicy returns the series cache policy
	CachePolicy() CachePolicy

	// SetContextPool sets the contextPool
	SetContextPool(value context.Pool) Options

	// ContextPool returns the contextPool
	ContextPool() context.Pool

	// SetEncoderPool sets the contextPool
	SetEncoderPool(value encoding.EncoderPool) Options

	// EncoderPool returns the contextPool
	EncoderPool() encoding.EncoderPool

	// SetMultiReaderIteratorPool sets the multiReaderIteratorPool
	SetMultiReaderIteratorPool(value encoding.MultiReaderIteratorPool) Options

	// MultiReaderIteratorPool returns the multiReaderIteratorPool
	MultiReaderIteratorPool() encoding.MultiReaderIteratorPool

	// SetFetchBlockMetadataResultsPool sets the fetchBlockMetadataResultsPool
	SetFetchBlockMetadataResultsPool(value block.FetchBlockMetadataResultsPool) Options

	// FetchBlockMetadataResultsPool returns the fetchBlockMetadataResultsPool
	FetchBlockMetadataResultsPool() block.FetchBlockMetadataResultsPool

	// SetIdentifierPool sets the identifierPool
	SetIdentifierPool(value ident.Pool) Options

	// IdentifierPool returns the identifierPool
	IdentifierPool() ident.Pool

	// SetStats sets the configured Stats.
	SetStats(value Stats) Options

	// Stats returns the configured Stats.
	Stats() Stats
}

Options represents the options for series

func NewOptions 

func NewOptions() Options

NewOptions creates new database series options

type QueryableBlockRetriever 

type QueryableBlockRetriever interface {
	block.DatabaseShardBlockRetriever

	// IsBlockRetrievable returns whether a block is retrievable
	// for a given block start time
	IsBlockRetrievable(blockStart time.Time) bool
}

QueryableBlockRetriever is a block retriever that can tell if a block is retrievable or not for a given start time.

type Reader 

type Reader struct {
	// contains filtered or unexported fields
}

Reader reads results from a series, or a series block retriever or both. It is implemented as a struct so it can be allocated on the stack.

func NewReaderUsingRetriever 

func NewReaderUsingRetriever(
	id ident.ID,
	retriever QueryableBlockRetriever,
	onRetrieveBlock block.OnRetrieveBlock,
	onReadBlock block.OnReadBlock,
	opts Options,
) Reader

NewReaderUsingRetriever returns a reader for a series block retriever, it will use the block retriever as the source to read blocks from.

func (Reader) FetchBlocks 

func (r Reader) FetchBlocks(
	ctx context.Context,
	starts []time.Time,
) ([]block.FetchBlockResult, error)

FetchBlocks returns data blocks given a list of block start times using just a block retriever.

func (Reader) ReadEncoded 

func (r Reader) ReadEncoded(
	ctx context.Context,
	start, end time.Time,
) ([][]xio.BlockReader, error)

ReadEncoded reads encoded blocks using just a block retriever.

type Stats 

type Stats struct {
	// contains filtered or unexported fields
}

Stats is passed down from namespace/shard to avoid allocations per series.

func NewStats 

func NewStats(scope tally.Scope) Stats

NewStats returns a new Stats for the provided scope.

func (Stats) IncCreatedEncoders 

func (s Stats) IncCreatedEncoders()

IncCreatedEncoders incs the EncoderCreated stat.

type TickResult 

type TickResult struct {
	TickStatus
	// MadeExpiredBlocks is count of blocks just expired
	MadeExpiredBlocks int
	// MadeUnwiredBlocks is count of blocks just unwired from memory
	MadeUnwiredBlocks int
	// MergedOutOfOrderBlocks is count of blocks merged from out of order streams
	MergedOutOfOrderBlocks int
}

TickResult is a set of results from a tick

type TickStatus 

type TickStatus struct {
	// ActiveBlocks is the number of total active blocks
	ActiveBlocks int
	// OpenBlocks is the number of blocks actively mutable can be written to
	OpenBlocks int
	// WiredBlocks is the number of blocks wired in memory (all data kept)
	WiredBlocks int
	// UnwiredBlocks is the number of blocks unwired (data kept on disk)
	UnwiredBlocks int
	// PendingMergeBlocks is the number of blocks pending merges
	PendingMergeBlocks int
}

TickStatus is the status of a series for a given tick

Source Files

View all Source files

Directories

Path Synopsis

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.