silo

Documentation

Index

• Variables
• type Backend
• type BackendInMemory
  • func NewBackendInMemory() *BackendInMemory
  • func (b *BackendInMemory) Close() error
  • func (b *BackendInMemory) Next() (DataNode, bool, error)
  • func (b *BackendInMemory) PullAll(node DataNode) ([]DataNode, error)
  • func (b *BackendInMemory) Snapshot() Snapshot
  • func (b *BackendInMemory) Store(key DataNode, value DataNode) error
• type ConfigScanAliasIsNotIncludedError
  • func (e *ConfigScanAliasIsNotIncludedError) Error() string
• type DataLink
• type DataNode
  • func DecodeDataNode(data []byte) (DataNode, error)
  • func (n DataNode) Binary() ([]byte, error)
  • func (n DataNode) String() string
• type DataRow
• type DataRowReader
• type DataRowReaderInMemory
  • func NewDataRowReaderInMemory(rows []DataRow) *DataRowReaderInMemory
  • func (r *DataRowReaderInMemory) Close() error
  • func (r *DataRowReaderInMemory) ReadDataRow() (DataRow, error)
• type Driver
  • func NewDriver(backend Backend, writer DumpWriter, options ...Option) *Driver
  • func (d *Driver) Dump(observers ...DumpObserver) error
  • func (d *Driver) Scan(input DataRowReader, observers ...ScanObserver) error
• type DumpObserver
• type DumpToStdout
  • func NewDumpToStdout() *DumpToStdout
  • func (d *DumpToStdout) Close() error
  • func (d *DumpToStdout) Write(node DataNode, uuid string) error
• type DumpWriter
• type Entity
  • func NewEntity(include []string, nodes ...DataNode) Entity
  • func (s Entity) Append(node DataNode) bool
  • func (s Entity) Finalize() (Status, map[string]int)
  • func (s Entity) UUID() string
• type Option
  • func Alias(key, alias string) Option
  • func Include(key string) Option
  • func WithAliases(aliases map[string]string) Option
  • func WithKeys(keys []string) Option
• type ScanObserver
• type Snapshot
• type Status

Variables

var (
	ErrReadingNextInput     = errors.New("error while reading next input")
	ErrPersistingData       = errors.New("error while persisting data")
	ErrReadingPersistedData = errors.New("error while reading persisted data")
)

Types

type Backend

type Backend interface {
	Store(key DataNode, value DataNode) error
	Snapshot() Snapshot
	Close() error
}

type BackendInMemory

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

func NewBackendInMemory

func NewBackendInMemory() *BackendInMemory

func (*BackendInMemory) Close

func (b *BackendInMemory) Close() error

func (*BackendInMemory) Next

func (b *BackendInMemory) Next() (DataNode, bool, error)

func (*BackendInMemory) PullAll

func (b *BackendInMemory) PullAll(node DataNode) ([]DataNode, error)

func (*BackendInMemory) Snapshot

func (b *BackendInMemory) Snapshot() Snapshot

func (*BackendInMemory) Store

func (b *BackendInMemory) Store(key DataNode, value DataNode) error

type ConfigScanAliasIsNotIncludedError

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

func (*ConfigScanAliasIsNotIncludedError) Error

func (e *ConfigScanAliasIsNotIncludedError) Error() string

type DataLink

type DataLink struct {
	E1 DataNode
	E2 DataNode
}

type DataNode

type DataNode struct {
	Key  string
	Data any
}

func DecodeDataNode

func DecodeDataNode(data []byte) (DataNode, error)

func (DataNode) Binary

func (n DataNode) Binary() ([]byte, error)

func (DataNode) String

func (n DataNode) String() string

type DataRow

type DataRow map[string]any

type DataRowReader

type DataRowReader interface {
	ReadDataRow() (DataRow, error)
	Close() error
}

type DataRowReaderInMemory

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

func NewDataRowReaderInMemory

func NewDataRowReaderInMemory(rows []DataRow) *DataRowReaderInMemory

func (*DataRowReaderInMemory) Close

func (r *DataRowReaderInMemory) Close() error

func (*DataRowReaderInMemory) ReadDataRow

func (r *DataRowReaderInMemory) ReadDataRow() (DataRow, error)

type Driver

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

func NewDriver

func NewDriver(backend Backend, writer DumpWriter, options ...Option) *Driver

func (*Driver) Dump

func (d *Driver) Dump(observers ...DumpObserver) error

func (*Driver) Scan

func (d *Driver) Scan(input DataRowReader, observers ...ScanObserver) error

type DumpObserver

type DumpObserver interface {
	Entity(status Status, counts map[string]int)
}

type DumpToStdout

type DumpToStdout struct{}

func NewDumpToStdout

func NewDumpToStdout() *DumpToStdout

func (*DumpToStdout) Close

func (d *DumpToStdout) Close() error

func (*DumpToStdout) Write

func (d *DumpToStdout) Write(node DataNode, uuid string) error

type DumpWriter

type DumpWriter interface {
	Write(node DataNode, uuid string) error
	Close() error
}

type Entity

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

func NewEntity

func NewEntity(include []string, nodes ...DataNode) Entity

func (Entity) Append

func (s Entity) Append(node DataNode) bool

func (Entity) Finalize

func (s Entity) Finalize() (Status, map[string]int)

func (Entity) UUID

func (s Entity) UUID() string

type Option

type Option interface {
	// contains filtered or unexported methods
}

func Alias

func Alias(key, alias string) Option

func Include

func Include(key string) Option

func WithAliases

func WithAliases(aliases map[string]string) Option

func WithKeys

func WithKeys(keys []string) Option

type ScanObserver

type ScanObserver interface {
	IngestedRow(row DataRow)
	IngestedLink(link DataLink)
}

type Snapshot

type Snapshot interface {
	Next() (DataNode, bool, error)
	PullAll(node DataNode) ([]DataNode, error)
	Close() error
}

type Status

type Status string

const (
	StatusEntityComplete     Status = "complete"
	StatusEntityConsistent   Status = "consistent"
	StatusEntityInconsistent Status = "inconsistent"
	StatusEntityEmpty        Status = "empty"
)