storage

Documentation

Overview

Package storage is a generated protocol buffer package.

It is generated from these files:

source.proto

It has these top-level messages:

ReadSource

Index

• Variables
• func HasFieldKeyOrValue(expr influxql.Expr) (bool, bool)
• func HasSingleMeasurementNoOR(expr influxql.Expr) (string, bool)
• func NewContextWithReadOptions(ctx context.Context, opts *ReadOptions) context.Context
• func RewriteExprRemoveFieldKeyAndValue(expr influxql.Expr) influxql.Expr
• type MetaClient
• type ReadOptions
  • func ReadOptionsFromContext(ctx context.Context) *ReadOptions
• type ReadSource
  • func GetReadSource(req *datatypes.ReadRequest) (*ReadSource, error)
  • func (*ReadSource) Descriptor() ([]byte, []int)
  • func (m *ReadSource) Marshal() (dAtA []byte, err error)
  • func (m *ReadSource) MarshalTo(dAtA []byte) (int, error)
  • func (*ReadSource) ProtoMessage()
  • func (m *ReadSource) Reset()
  • func (m *ReadSource) Size() (n int)
  • func (m *ReadSource) String() string
  • func (m *ReadSource) Unmarshal(dAtA []byte) error
• type Store
  • func NewStore(store *tsdb.Store, metaClient MetaClient) *Store
  • func (s *Store) GetSource(rs storage.ReadSpec) (proto.Message, error)
  • func (s *Store) GroupRead(ctx context.Context, req *datatypes.ReadRequest) (reads.GroupResultSet, error)
  • func (s *Store) Read(ctx context.Context, req *datatypes.ReadRequest) (reads.ResultSet, error)
  • func (s *Store) WithLogger(log *zap.Logger)

Variables

var (
	ErrInvalidLengthSource = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowSource   = fmt.Errorf("proto: integer overflow")
)

var (
	ErrMissingReadSource = errors.New("missing ReadSource")
)

Functions

func HasFieldKeyOrValue

func HasFieldKeyOrValue(expr influxql.Expr) (bool, bool)

func HasSingleMeasurementNoOR

func HasSingleMeasurementNoOR(expr influxql.Expr) (string, bool)

HasSingleMeasurementNoOR determines if an index optimisation is available.

Typically the read service will use the query engine to retrieve all field keys for all measurements that match the expression, which can be very inefficient if it can be proved that only one measurement matches the expression.

This condition is determined when the following is true:

• there is only one occurrence of the tag key `_measurement`.
• there are no OR operators in the expression tree.
• the operator for the `_measurement` binary expression is ==.

func NewContextWithReadOptions

func NewContextWithReadOptions(ctx context.Context, opts *ReadOptions) context.Context

NewContextWithRequestOptions returns a new Context with nodeID added.

func RewriteExprRemoveFieldKeyAndValue

func RewriteExprRemoveFieldKeyAndValue(expr influxql.Expr) influxql.Expr

Types

type MetaClient

type MetaClient interface {
	Database(name string) *meta.DatabaseInfo
	ShardGroupsByTimeRange(database, policy string, min, max time.Time) (a []meta.ShardGroupInfo, err error)
}

type ReadOptions

type ReadOptions struct {
	NodeID uint64
}

ReadOptions are additional options that may be passed with context.Context to configure the behavior of a storage read request.

func ReadOptionsFromContext

func ReadOptionsFromContext(ctx context.Context) *ReadOptions

ReadOptionsFromContext returns the ReadOptions associated with the context or nil if no additional options have been specified.

type ReadSource

type ReadSource struct {
	// Database identifies which database to query.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// RetentionPolicy identifies which retention policy to query.
	RetentionPolicy string `protobuf:"bytes,2,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"`
}

func GetReadSource

func GetReadSource(req *datatypes.ReadRequest) (*ReadSource, error)

GetReadSource will attempt to unmarshal a ReadSource from the ReadRequest or return an error if no valid resource is present.

func (*ReadSource) Descriptor

func (*ReadSource) Descriptor() ([]byte, []int)

func (*ReadSource) Marshal

func (m *ReadSource) Marshal() (dAtA []byte, err error)

func (*ReadSource) MarshalTo

func (m *ReadSource) MarshalTo(dAtA []byte) (int, error)

func (*ReadSource) ProtoMessage

func (*ReadSource) ProtoMessage()

func (*ReadSource) Reset

func (m *ReadSource) Reset()

func (*ReadSource) Size

func (m *ReadSource) Size() (n int)

func (*ReadSource) String

func (m *ReadSource) String() string

func (*ReadSource) Unmarshal

func (m *ReadSource) Unmarshal(dAtA []byte) error

type Store

type Store struct {
	TSDBStore  *tsdb.Store
	MetaClient MetaClient
	Logger     *zap.Logger
}

func NewStore

func NewStore(store *tsdb.Store, metaClient MetaClient) *Store

func (*Store) GetSource

func (s *Store) GetSource(rs storage.ReadSpec) (proto.Message, error)

func (*Store) GroupRead

func (s *Store) GroupRead(ctx context.Context, req *datatypes.ReadRequest) (reads.GroupResultSet, error)

func (*Store) Read

func (s *Store) Read(ctx context.Context, req *datatypes.ReadRequest) (reads.ResultSet, error)

func (*Store) WithLogger

func (s *Store) WithLogger(log *zap.Logger)

WithLogger sets the logger for the service.