store

README

store

DB

Yugabyte

CREATE KEYSPACE IF NOT EXISTS argus;
CREATE TABLE argus.gifnoc (
    bucket VARCHAR,
    id VARCHAR,
    data blob,
    PRIMARY KEY (bucket, id))
    WITH default_time_to_live = 300
    AND transactions = {'enabled': 'false'};

Documentation

Index

• Constants
• Variables
• func FilterOwner(value map[string]OwnableItem, owner string) map[string]OwnableItem
• type BadRequestErr
  • func (bre BadRequestErr) Error() string
  • func (bre BadRequestErr) StatusCode() int
• type Handler
• type InternalError
  • func (ie InternalError) Error() string
  • func (ie InternalError) StatusCode() int
• type ItemTTL
• type KeyItemPairRequest
• type KeyNotFoundError
  • func (knfe KeyNotFoundError) Error() string
  • func (knfe KeyNotFoundError) StatusCode() int
• type OwnableItem
• type S
• type StoreIn
• type StoreOut
  • func Provide(unmarshaller config.Unmarshaller, in StoreIn) StoreOut

Constants

const (
	// TypeLabel is for labeling metrics; if there is a single metric for
	// successful queries, the typeLabel and corresponding type can be used
	// when incrementing the metric.
	TypeLabel  = "type"
	InsertType = "insert"
	DeleteType = "delete"
	ReadType   = "read"
	PingType   = "ping"
)

const (
	ItemOwnerHeaderKey  = "X-Midt-Owner"
	XmidtErrorHeaderKey = "X-Midt-Error"
)

Request and Response Headers

const DefaultTTL = 60 * 5

5 minutes

const YearTTL = 60 * 24 * 365

1 year

Variables

var ErrCasting = errors.New("casting error due to middleware wiring mistake")

ErrCasting indicates there was a middleware wiring mistake with the go-kit style encoders.

Functions

func FilterOwner

func FilterOwner(value map[string]OwnableItem, owner string) map[string]OwnableItem

Types

type BadRequestErr

type BadRequestErr struct {
	Message string
}

func (BadRequestErr) Error

func (bre BadRequestErr) Error() string

func (BadRequestErr) StatusCode

func (bre BadRequestErr) StatusCode() int

type Handler

type Handler http.Handler

type InternalError

type InternalError struct {
	Reason    interface{}
	Retryable bool
}

func (InternalError) Error

func (ie InternalError) Error() string

func (InternalError) StatusCode

func (ie InternalError) StatusCode() int

type ItemTTL

type ItemTTL struct {
	DefaultTTL time.Duration
	MaxTTL     time.Duration
}

type KeyItemPairRequest

type KeyItemPairRequest struct {
	model.Key
	OwnableItem
	Method string
}

type KeyNotFoundError

type KeyNotFoundError struct {
	Key model.Key
}

func (KeyNotFoundError) Error

func (knfe KeyNotFoundError) Error() string

func (KeyNotFoundError) StatusCode

func (knfe KeyNotFoundError) StatusCode() int

type OwnableItem

type OwnableItem struct {
	model.Item
	Owner string `json:"owner"`
}

type S

type S interface {
	Push(key model.Key, item OwnableItem) error
	Get(key model.Key) (OwnableItem, error)
	Delete(key model.Key) (OwnableItem, error)
	GetAll(bucket string) (map[string]OwnableItem, error)
}

type StoreIn

type StoreIn struct {
	fx.In

	Store S
}

StoreIn is the set of dependencies for this package's components

type StoreOut

type StoreOut struct {
	fx.Out

	// PushItemHandler is the http.Handler to add a new item to the store.
	PushItemHandler Handler `name:"pushHandler"`

	// SetItemHandler is the http.Handler to update an item in the store.
	UpdateItemHandler Handler `name:"updateHandler"`

	// SetKeyHandler is the http.Handler to fetch an individual item from the store.
	GetItemHandler Handler `name:"getHandler"`

	// GetAllItems is the http.Handler to fetch all items from the store for a given bucket.
	GetAllItemsHandler Handler `name:"getAllHandler"`

	// DeletItems is the http.Handler to delete a certain item.
	DeleteKeyHandler Handler `name:"deleteHandler"`
}

StoreOut is the set of components emitted by this package

func Provide

func Provide(unmarshaller config.Unmarshaller, in StoreIn) StoreOut

Provide is an uber/fx style provider for this package's components