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
• func ProvideHandlers() fx.Option
• func Sha256HexDigest(message string) string
• type BadRequestErr
  • func (bre BadRequestErr) Error() string
  • func (bre BadRequestErr) StatusCode() int
• type ForbiddenRequestErr
  • func (f ForbiddenRequestErr) Error() string
  • func (f ForbiddenRequestErr) StatusCode() int
• type Handler
• type InternalError
  • func (ie InternalError) Error() string
  • func (ie InternalError) StatusCode() int
• type KeyItemPairRequest
• type KeyNotFoundError
  • func (knfe KeyNotFoundError) Error() string
  • func (knfe KeyNotFoundError) StatusCode() int
• type OwnableItem
• type S

Constants

const (
	BucketFormatRegexSource = "^[0-9a-z][0-9a-z-]{1,61}[0-9a-z]$"
	OwnerFormatRegexSource  = "^.{10,60}$"
)

default input field validation regular expressions. Note: these values are configurable so please check the argus.yaml file if you're interested.

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 ElevatedAccessLevel = 1

ElevatedAccessLevel is the bascule attribute value found in requests that should be granted priviledged access to operations.

const IDFormatRegexSource = "^[0-9a-f]{64}$"

IDFormatRegexSource helps validate the ID on incoming requests.

Variables

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

ErrCasting indicates there was (most likely) a middleware wiring mistake with the go-kit style encoders/decoders.

Functions

func FilterOwner

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

func ProvideHandlers

func ProvideHandlers() fx.Option

ProvideHandlers fetches all dependencies and builds the four main handlers for this store.

func Sha256HexDigest

func Sha256HexDigest(message string) string

Sha256HexDigest returns the SHA-256 hex digest of the given input.

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 ForbiddenRequestErr

type ForbiddenRequestErr struct {
	Message string
}

func (ForbiddenRequestErr) Error

func (f ForbiddenRequestErr) Error() string

func (ForbiddenRequestErr) StatusCode

func (f ForbiddenRequestErr) 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 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)
}