storage

Documentation

Index

• Variables
• func NewBucketClient(storageConfig Config) (chunk.BucketClient, error)
• func NewIndexClient(name string, cfg Config, schemaCfg chunk.SchemaConfig) (chunk.IndexClient, error)
• func NewObjectClient(name string, cfg Config, schemaCfg chunk.SchemaConfig) (chunk.ObjectClient, error)
• func NewStore(cfg Config, storeCfg chunk.StoreConfig, schemaCfg chunk.SchemaConfig, ...) (chunk.Store, error)
• func NewTableClient(name string, cfg Config) (chunk.TableClient, error)
• type Bytes
  • func (bs *Bytes) Compare(other Bytes) int
  • func (bs *Bytes) Equal(other Bytes) bool
  • func (bs *Bytes) Marshal() ([]byte, error)
  • func (bs *Bytes) MarshalTo(data []byte) (n int, err error)
  • func (bs *Bytes) Size() int
  • func (bs *Bytes) Unmarshal(data []byte) error
• type Config
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
• type Entry
  • func (*Entry) Descriptor() ([]byte, []int)
  • func (this *Entry) Equal(that interface{}) bool
  • func (this *Entry) GoString() string
  • func (m *Entry) Marshal() (dAtA []byte, err error)
  • func (m *Entry) MarshalTo(dAtA []byte) (int, error)
  • func (*Entry) ProtoMessage()
  • func (m *Entry) Reset()
  • func (m *Entry) Size() (n int)
  • func (this *Entry) String() string
  • func (m *Entry) Unmarshal(dAtA []byte) error
  • func (m *Entry) XXX_DiscardUnknown()
  • func (m *Entry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Entry) XXX_Merge(src proto.Message)
  • func (m *Entry) XXX_Size() int
  • func (m *Entry) XXX_Unmarshal(b []byte) error
• type ReadBatch
  • func (*ReadBatch) Descriptor() ([]byte, []int)
  • func (this *ReadBatch) Equal(that interface{}) bool
  • func (m *ReadBatch) GetCardinality() int32
  • func (m *ReadBatch) GetEntries() []Entry
  • func (m *ReadBatch) GetExpiry() int64
  • func (m *ReadBatch) GetKey() string
  • func (this *ReadBatch) GoString() string
  • func (b ReadBatch) Iterator() chunk.ReadBatchIterator
  • func (m *ReadBatch) Marshal() (dAtA []byte, err error)
  • func (m *ReadBatch) MarshalTo(dAtA []byte) (int, error)
  • func (*ReadBatch) ProtoMessage()
  • func (m *ReadBatch) Reset()
  • func (m *ReadBatch) Size() (n int)
  • func (this *ReadBatch) String() string
  • func (m *ReadBatch) Unmarshal(dAtA []byte) error
  • func (m *ReadBatch) XXX_DiscardUnknown()
  • func (m *ReadBatch) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *ReadBatch) XXX_Merge(src proto.Message)
  • func (m *ReadBatch) XXX_Size() int
  • func (m *ReadBatch) XXX_Unmarshal(b []byte) error
• type StoreLimits

Variables

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

var Fixtures = []testutils.Fixture{
	fixture{gcp.Fixtures[0]},
}

Fixtures for unit testing the caching storage.

Functions

func NewBucketClient

func NewBucketClient(storageConfig Config) (chunk.BucketClient, error)

NewBucketClient makes a new bucket client based on the configuration.

func NewIndexClient

func NewIndexClient(name string, cfg Config, schemaCfg chunk.SchemaConfig) (chunk.IndexClient, error)

NewIndexClient makes a new index client of the desired type.

func NewObjectClient

func NewObjectClient(name string, cfg Config, schemaCfg chunk.SchemaConfig) (chunk.ObjectClient, error)

NewObjectClient makes a new ObjectClient of the desired types.

func NewStore

func NewStore(cfg Config, storeCfg chunk.StoreConfig, schemaCfg chunk.SchemaConfig, limits StoreLimits) (chunk.Store, error)

NewStore makes the storage clients based on the configuration.

func NewTableClient

func NewTableClient(name string, cfg Config) (chunk.TableClient, error)

NewTableClient makes a new table client based on the configuration.

Types

type Bytes

type Bytes []byte

Bytes exists to stop proto copying the byte array

func (*Bytes) Compare

func (bs *Bytes) Compare(other Bytes) int

Compare Bytes to other

func (*Bytes) Equal

func (bs *Bytes) Equal(other Bytes) bool

Equal returns true if other equals Bytes

func (*Bytes) Marshal

func (bs *Bytes) Marshal() ([]byte, error)

Marshal just returns bs

func (*Bytes) MarshalTo

func (bs *Bytes) MarshalTo(data []byte) (n int, err error)

MarshalTo copies Bytes to data

func (*Bytes) Size

func (bs *Bytes) Size() int

Size returns the length of Bytes

func (*Bytes) Unmarshal

func (bs *Bytes) Unmarshal(data []byte) error

Unmarshal updates Bytes to be data, without a copy

type Config

type Config struct {
	AWSStorageConfig       aws.StorageConfig  `yaml:"aws"`
	GCPStorageConfig       gcp.Config         `yaml:"bigtable"`
	GCSConfig              gcp.GCSConfig      `yaml:"gcs"`
	CassandraStorageConfig cassandra.Config   `yaml:"cassandra"`
	BoltDBConfig           local.BoltDBConfig `yaml:"boltdb"`
	FSConfig               local.FSConfig     `yaml:"filesystem"`

	IndexCacheValidity time.Duration

	IndexQueriesCacheConfig cache.Config `yaml:"index_queries_cache_config,omitempty"`
}

Config chooses which storage client to use.

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags adds the flags required to configure this flag set.

type Entry

type Entry struct {
	Column Bytes `protobuf:"bytes,1,opt,name=Column,json=column,proto3,customtype=Bytes" json:"Column"`
	Value  Bytes `protobuf:"bytes,2,opt,name=Value,json=value,proto3,customtype=Bytes" json:"Value"`
}

func (*Entry) Descriptor

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

func (*Entry) Equal

func (this *Entry) Equal(that interface{}) bool

func (*Entry) GoString

func (this *Entry) GoString() string

func (*Entry) Marshal

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

func (*Entry) MarshalTo

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

func (*Entry) ProtoMessage

func (*Entry) ProtoMessage()

func (*Entry) Reset

func (m *Entry) Reset()

func (*Entry) Size

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

func (*Entry) String

func (this *Entry) String() string

func (*Entry) Unmarshal

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

func (*Entry) XXX_DiscardUnknown

func (m *Entry) XXX_DiscardUnknown()

func (*Entry) XXX_Marshal

func (m *Entry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Entry) XXX_Merge

func (m *Entry) XXX_Merge(src proto.Message)

func (*Entry) XXX_Size

func (m *Entry) XXX_Size() int

func (*Entry) XXX_Unmarshal

func (m *Entry) XXX_Unmarshal(b []byte) error

type ReadBatch

type ReadBatch struct {
	Entries []Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries"`
	Key     string  `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// The time at which the key expires.
	Expiry int64 `protobuf:"varint,3,opt,name=expiry,proto3" json:"expiry,omitempty"`
	// The number of entries; used for cardinality limiting.
	// entries will be empty when this is set.
	Cardinality int32 `protobuf:"varint,4,opt,name=cardinality,proto3" json:"cardinality,omitempty"`
}

func (*ReadBatch) Descriptor

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

func (*ReadBatch) Equal

func (this *ReadBatch) Equal(that interface{}) bool

func (*ReadBatch) GetCardinality

func (m *ReadBatch) GetCardinality() int32

func (*ReadBatch) GetEntries

func (m *ReadBatch) GetEntries() []Entry

func (*ReadBatch) GetExpiry

func (m *ReadBatch) GetExpiry() int64

func (*ReadBatch) GetKey

func (m *ReadBatch) GetKey() string

func (*ReadBatch) GoString

func (this *ReadBatch) GoString() string

func (ReadBatch) Iterator

func (b ReadBatch) Iterator() chunk.ReadBatchIterator

Iterator implements chunk.ReadBatch.

func (*ReadBatch) Marshal

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

func (*ReadBatch) MarshalTo

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

func (*ReadBatch) ProtoMessage

func (*ReadBatch) ProtoMessage()

func (*ReadBatch) Reset

func (m *ReadBatch) Reset()

func (*ReadBatch) Size

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

func (*ReadBatch) String

func (this *ReadBatch) String() string

func (*ReadBatch) Unmarshal

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

func (*ReadBatch) XXX_DiscardUnknown

func (m *ReadBatch) XXX_DiscardUnknown()

func (*ReadBatch) XXX_Marshal

func (m *ReadBatch) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ReadBatch) XXX_Merge

func (m *ReadBatch) XXX_Merge(src proto.Message)

func (*ReadBatch) XXX_Size

func (m *ReadBatch) XXX_Size() int

func (*ReadBatch) XXX_Unmarshal

func (m *ReadBatch) XXX_Unmarshal(b []byte) error

type StoreLimits

type StoreLimits interface {
	CardinalityLimit(userID string) int
	MaxChunksPerQuery(userID string) int
	MaxQueryLength(userID string) time.Duration
}

StoreLimits helps get Limits specific to Queries for Stores