stream

Documentation

Overview

Package stream implements a time-series-based storage which is consists of a sequence of element. Each element drops in a arbitrary interval. They are immutable, can not be updated or overwritten.

Index

• Variables
• type Query
• type SchemaService
  • func NewPortableRepository(metadata metadata.Repo, l *logger.Logger, metrics *resourceSchema.Metrics) SchemaService
• type Service
  • func NewService(_ context.Context, metadata metadata.Repo, pipeline queue.Server, ...) (Service, error)
• type Stream

Variables

var (

	// ErrStreamNotExist denotes a stream doesn't exist in the metadata repo.
	ErrStreamNotExist = errors.New("stream doesn't exist")
)

Types

type Query

type Query interface {
	LoadGroup(name string) (schema.Group, bool)
	Stream(stream *commonv1.Metadata) (Stream, error)
}

Query allow to retrieve elements in a series of streams.

type SchemaService

type SchemaService interface {
	Query
	Close()
}

SchemaService allows querying schema information.

func NewPortableRepository

func NewPortableRepository(metadata metadata.Repo, l *logger.Logger, metrics *resourceSchema.Metrics) SchemaService

NewPortableRepository creates a new portable repository.

type Service

type Service interface {
	run.PreRunner
	run.Config
	run.Service
	Query
}

Service allows inspecting the stream elements.

func NewService

func NewService(_ context.Context, metadata metadata.Repo, pipeline queue.Server, omr observability.MetricsRegistry) (Service, error)

NewService returns a new service.

type Stream

type Stream interface {
	io.Closer
	GetSchema() *databasev1.Stream
	GetIndexRules() []*databasev1.IndexRule
	Query(ctx context.Context, opts model.StreamQueryOptions) (model.StreamQueryResult, error)
}

Stream allows inspecting elements' details.