store

Documentation

Overview

Service store provides a key-value store to the sarif network.

Index

• Variables
• func Register(name string, d Driver)
• type BatchCommand
• type Config
• type Cursor
• type Dependencies
• type DocsPayload
• type Document
  • func (doc Document) String() string
• type Driver
  • func GetDriver(name string) (Driver, bool)
• type Service
  • func NewService(deps *Dependencies) *Service
  • func (s *Service) Disable() error
  • func (s *Service) Enable() (err error)
• type Store

Variables

var (
	ErrNoResult = errors.New("No result found.")
)

var Module = &services.Module{
	Name:        "store",
	Version:     "1.0",
	NewInstance: NewService,
}

Functions

func Register

func Register(name string, d Driver)

Types

type BatchCommand

type BatchCommand struct {
	Type  string          `json:"type"`
	Key   string          `json:"key"`
	Value json.RawMessage `json:"value,omitempty"`
}

type Config

type Config struct {
	Driver string
	Path   string
}

type Cursor

type Cursor interface {
	Next() *Document
	Close() error
}

type Dependencies

type Dependencies struct {
	Config services.Config
	Client sarif.Client
}

type DocsPayload

type DocsPayload struct {
	Keys   []string           `json:"keys"`
	Values []*json.RawMessage `json:"values"`
}

type Document

type Document struct {
	Collection string `json:"collection"`
	Key        string `json:"key"`
	Value      []byte `json:"value,omitempty"`
}

func (Document) String

func (doc Document) String() string

type Driver

type Driver interface {
	Open(name string) (Store, error)
}

func GetDriver

func GetDriver(name string) (Driver, bool)

type Service

type Service struct {
	Config services.Config
	Cfg    Config
	Store  Store
	sarif.Client
}

func NewService

func NewService(deps *Dependencies) *Service

func (*Service) Disable

func (s *Service) Disable() error

func (*Service) Enable

func (s *Service) Enable() (err error)

type Store

type Store interface {
	Put(*Document) (*Document, error)
	Get(collection, key string) (*Document, error)
	Del(collection, key string) error
	Scan(collection, min, max string, reverse bool) (Cursor, error)
}