commit

Documentation

Overview

commit package provides commit logs for storing mutations, as they arrive at the server. Mutations also get stored in memory within posting.List. So, commit logs are useful to handle machine crashes, and re-init of a posting list. This package provides functionality to write to a rotating log, and a way to quickly filter relevant entries corresponding to an attribute.

Index

• Variables
• func FillCache(c *Cache, path string) error
• type ByTimestamp
  • func (b ByTimestamp) Len() int
  • func (b ByTimestamp) Less(i, j int) bool
  • func (b ByTimestamp) Swap(i, j int)
• type Cache
  • func (c *Cache) LastAccessedInSeconds() int64
  • func (c *Cache) Present(hash uint32) bool
  • func (c *Cache) ReadAt(pos int, p []byte) (n int, err error)
  • func (c *Cache) Write(hash uint32, p []byte) (n int, err error)
• type CurFile
  • func (c *CurFile) Size() int64
• type Header
• type LogIterator
• type Logger
  • func NewLogger(dir string, fileprefix string, maxSize int64) *Logger
  • func (l *Logger) AddLog(hash uint32, value []byte) (int64, error)
  • func (l *Logger) Close()
  • func (l *Logger) DeleteCacheOlderThan(v time.Duration)
  • func (l *Logger) Init()
  • func (l *Logger) StreamEntries(afterTs int64, hash uint32, iter LogIterator) error
• type Reader
  • func NewReader(c *Cache) *Reader
  • func (r *Reader) Discard(n int)
  • func (r *Reader) Read(p []byte) (n int, err error)

Variables

var E_READ = errors.New("Unable to read")

var E_WRITE = errors.New("Unable to write")

Functions

func FillCache

func FillCache(c *Cache, path string) error

Types

type ByTimestamp

type ByTimestamp []*logFile

func (ByTimestamp) Len

func (b ByTimestamp) Len() int

func (ByTimestamp) Less

func (b ByTimestamp) Less(i, j int) bool

func (ByTimestamp) Swap

func (b ByTimestamp) Swap(i, j int)

type Cache

type Cache struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*Cache) LastAccessedInSeconds

func (c *Cache) LastAccessedInSeconds() int64

func (*Cache) Present

func (c *Cache) Present(hash uint32) bool

func (*Cache) ReadAt

func (c *Cache) ReadAt(pos int, p []byte) (n int, err error)

func (*Cache) Write

func (c *Cache) Write(hash uint32, p []byte) (n int, err error)

type CurFile

type CurFile struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*CurFile) Size

func (c *CurFile) Size() int64

type Header

type Header struct {
	// contains filtered or unexported fields
}

type LogIterator

type LogIterator func(hdr Header, record []byte)

type Logger

type Logger struct {

	// Sync every N logs. A value of zero or less would mean
	// sync every append to file.
	SyncEvery int

	// Sync every d duration.
	SyncDur time.Duration

	sync.RWMutex
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(dir string, fileprefix string, maxSize int64) *Logger

func (*Logger) AddLog

func (l *Logger) AddLog(hash uint32, value []byte) (int64, error)

func (*Logger) Close

func (l *Logger) Close()

func (*Logger) DeleteCacheOlderThan

func (l *Logger) DeleteCacheOlderThan(v time.Duration)

func (*Logger) Init

func (l *Logger) Init()

func (*Logger) StreamEntries

func (l *Logger) StreamEntries(afterTs int64, hash uint32,
	iter LogIterator) error

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

Reader isn't thread-safe. But multiple readers can be used to read the same cache.

func NewReader

func NewReader(c *Cache) *Reader

func (*Reader) Discard

func (r *Reader) Discard(n int)

func (*Reader) Read

func (r *Reader) Read(p []byte) (n int, err error)