storage

Documentation

Index

• Variables
• type Log
• type Query
• type Result
• type Storage

Variables

var (
	ErrReadOnlyStorage = errors.New("error read only storage")
	ErrInsert          = errors.New("error inserting into the db")
	ErrConstructQuery  = errors.New("error forming db query from api query")
	ErrQuery           = errors.New("error querying from the database")
)

var (
	DefaultTimestampFormat = "2006-01-02T15:04:05.000Z07:00"
)

Types

type Log

type Log struct {
	JobID    uint64
	LogData  string
	Date     time.Time
	LogLevel string
}

Log defines the basic log info pushed by the server

type Query

type Query struct {
	JobID     *uint64
	Text      *string
	LogLevel  *string
	StartDate *time.Time
	EndDate   *time.Time
	PageSize  uint
	Page      uint
}

Query defines the different options to filter with

type Result

type Result struct {
	Logs     []Log
	Count    uint64
	Page     uint
	PageSize uint
}

Result defines the expected result returned from the db

type Storage

type Storage interface {
	StoreLog(ctx xcontext.Context, entry Log) error
	GetLogs(ctx xcontext.Context, query Query) (*Result, error)

	Close(ctx xcontext.Context) error
}