datastore

Documentation

Index

• Variables
• func InitBuckets(p string) error
• func IsBucket(name BucketType) bool
• type Bucket
  • func GetBucket(name BucketType) *Bucket
  • func GetBuckets() []*Bucket
  • func NewBucket(path string, name string, compressionLevel int, cache bool, persistent bool, ...) (*Bucket, error)
  • func (b *Bucket) Evictable() bool
  • func (b *Bucket) FileList() ([]fs.DirEntry, error)
  • func (b *Bucket) Init() error
  • func (b *Bucket) LogValue() slog.Value
  • func (b *Bucket) ReadSeeker(name string) (io.ReadSeekCloser, error)
  • func (b *Bucket) Reader(name string) (io.ReadCloser, error)
  • func (b *Bucket) RemoveFile(name string) error
  • func (b *Bucket) ResetCache() error
  • func (b *Bucket) RunEvictionPolicy(logger *slog.Logger) (int, error)
  • func (b *Bucket) Stat(name string) (fs.FileInfo, error)
  • func (b *Bucket) Statistics(refresh bool) *BucketStats
  • func (b *Bucket) WriteFile(name string, r io.Reader, mode fs.FileMode) error
• type BucketStats
• type BucketType
  • func (t BucketType) Valid() bool

Variables

var (
	NoCompression      = gzip.NoCompression
	DefaultCompression = gzip.DefaultCompression
)

Functions

func InitBuckets

func InitBuckets(p string) error

func IsBucket

func IsBucket(name BucketType) bool

Types

type Bucket

type Bucket struct {
	RootPath string
	Name     string

	// Persistent is a sanity check flag for important buckets such as the tests bucket
	// Such that eviction or cleaning is never performed
	Persistent bool

	// Cache is true only if the bucket should act like a cache
	// That is, it can be fully purged using the Reset() method
	// It's a safeguard against accidentally removing real data
	Cache bool

	MaxSize int64         // Maximum size in bytes. Values < 1024 mean system is off
	MaxTTL  time.Duration // Maximum duration before emptying

	// 0 = flate.NoCompression
	// -1 = flate.DefaultCompression
	CompressionLevel int
	// contains filtered or unexported fields
}

func GetBucket

func GetBucket(name BucketType) *Bucket

GetBucket panics if there is no bucket with that name

func GetBuckets

func GetBuckets() []*Bucket

func NewBucket

func NewBucket(path string, name string, compressionLevel int, cache bool, persistent bool, maxSize int64, maxTTL time.Duration) (*Bucket, error)

func (*Bucket) Evictable

func (b *Bucket) Evictable() bool

func (*Bucket) FileList

func (b *Bucket) FileList() ([]fs.DirEntry, error)

func (*Bucket) Init

func (b *Bucket) Init() error

func (*Bucket) LogValue

func (b *Bucket) LogValue() slog.Value

func (*Bucket) ReadSeeker

func (b *Bucket) ReadSeeker(name string) (io.ReadSeekCloser, error)

ReadSeeker tries to open the given file using the normal reader function. If the output implements ReadSeekCloser, then it is used directly. Otherwise, we decompress on the fly into a temp file and return that instead (it will be deleted on Close()). TODO: Better caching, maybe some kind of sub-bucket concept?

func (*Bucket) Reader

func (b *Bucket) Reader(name string) (io.ReadCloser, error)

func (*Bucket) RemoveFile

func (b *Bucket) RemoveFile(name string) error

func (*Bucket) ResetCache

func (b *Bucket) ResetCache() error

func (*Bucket) RunEvictionPolicy

func (b *Bucket) RunEvictionPolicy(logger *slog.Logger) (int, error)

func (*Bucket) Stat

func (b *Bucket) Stat(name string) (fs.FileInfo, error)

func (*Bucket) Statistics

func (b *Bucket) Statistics(refresh bool) *BucketStats

func (*Bucket) WriteFile

func (b *Bucket) WriteFile(name string, r io.Reader, mode fs.FileMode) error

type BucketStats

type BucketStats struct {
	// Copied from bucket
	Name       string
	Persistent bool
	Cache      bool
	MaxSize    int64         // Maximum size in bytes.
	MaxTTL     time.Duration // Maximum duration before cleaning up object

	CreatedAt time.Time

	// Actual statistics
	NumItems   int
	OnDiskSize int64
}

type BucketType

type BucketType string

const (
	BucketTypeNone        BucketType = ""
	BucketTypeTests       BucketType = "tests"
	BucketTypeSubtests    BucketType = "subtests"
	BucketTypeAttachments BucketType = "attachments"
	BucketTypeAvatars     BucketType = "avatars"
	BucketTypeCheckers    BucketType = "checkers"
	BucketTypeCompiles    BucketType = "compiles"
	BucketTypeArtifacts   BucketType = "artifacts"
)

func (BucketType) Valid

func (t BucketType) Valid() bool