datamodel

Documentation

Index

• Constants
• func DatamodelType(DM *Datamodel) string
• func DiffValue(orig, next cue.Value) (cue.Value, error)
• func HistoryBaseDir() (string, error)
• type Datamodel
  • func (dm *Datamodel) CalcDiffs() error
  • func (dm *Datamodel) EnrichValue() error
  • func (dm *Datamodel) FindMaxLabelLen(dflags flags.DatamodelPflagpole) int
  • func (dm *Datamodel) GetSnapshotList() map[string][]*Snapshot
  • func (dm *Datamodel) HasDiff() bool
  • func (dm *Datamodel) HasHistory() (bool, error)
  • func (dm *Datamodel) LoadHistory() error
  • func (dm *Datamodel) MakeSnapshot(timestamp string, dflags flags.DatamodelPflagpole, ...) error
  • func (dm *Datamodel) PrintDiff(out io.Writer, dflags flags.DatamodelPflagpole) error
  • func (dm *Datamodel) PrintLog(out io.Writer, max int, ts string, dflags flags.DatamodelPflagpole, ...) error
  • func (dm *Datamodel) PrintLogByValue(out io.Writer, max int, dflags flags.DatamodelPflagpole, ...) error
  • func (dm *Datamodel) PrintTree(out io.Writer, max int, dflags flags.DatamodelPflagpole) error
  • func (dm *Datamodel) Status() string
• type Lense
• type Snapshot
• type Value
  • func (V *Value) Diff() cue.Value
  • func (V *Value) HasHistory() (bool, error)
  • func (V *Value) History() []*Snapshot
  • func (V *Value) HistoryDir() (string, error)
  • func (V *Value) LatestSnapshot() *Snapshot
  • func (V *Value) Status() string

Constants

const CheckpointTimeFmt = "20060102150405"

YYYYMMDDHHMMSS in Golang

Functions

func DatamodelType

func DatamodelType(DM *Datamodel) string

func DiffValue

func DiffValue(orig, next cue.Value) (cue.Value, error)

func HistoryBaseDir

func HistoryBaseDir() (string, error)

Types

type Datamodel

type Datamodel struct {
	*hof.Node[Value]
}

this is basically the same as a Value except that it reporesents a conceptual root and we want specific functions on it that are different from general Nodes' handling and recursion type Datamodel *hof.Node[Value]

func (*Datamodel) CalcDiffs

func (dm *Datamodel) CalcDiffs() error

func (*Datamodel) EnrichValue

func (dm *Datamodel) EnrichValue() error

func (*Datamodel) FindMaxLabelLen

func (dm *Datamodel) FindMaxLabelLen(dflags flags.DatamodelPflagpole) int

func (*Datamodel) GetSnapshotList

func (dm *Datamodel) GetSnapshotList() map[string][]*Snapshot

GetSnapshotList finds all snapshots from top-level @history() values. It returns a map where the key is the path to the @history and the value is a list of all snapshots at that value. The top most parent will contain all snapshots for any nested values, due to the way diffs propagate up the hof node tree You should not modify the returned snapshots

func (*Datamodel) HasDiff

func (dm *Datamodel) HasDiff() bool

func (*Datamodel) HasHistory

func (dm *Datamodel) HasHistory() (bool, error)

check for any history

func (*Datamodel) LoadHistory

func (dm *Datamodel) LoadHistory() error

LoadHistory loads the full datamodel history

func (*Datamodel) MakeSnapshot

func (dm *Datamodel) MakeSnapshot(timestamp string, dflags flags.DatamodelPflagpole, cflags flags.Datamodel__CheckpointFlagpole) error

MakeSnapshot creates a new snapshot for each history annotation in the Datamodel tree

func (*Datamodel) PrintDiff

func (dm *Datamodel) PrintDiff(out io.Writer, dflags flags.DatamodelPflagpole) error

func (*Datamodel) PrintLog

func (dm *Datamodel) PrintLog(out io.Writer, max int, ts string, dflags flags.DatamodelPflagpole, cflags flags.Datamodel__LogFlagpole) error

func (*Datamodel) PrintLogByValue

func (dm *Datamodel) PrintLogByValue(out io.Writer, max int, dflags flags.DatamodelPflagpole, cflags flags.Datamodel__LogFlagpole) error

func (*Datamodel) PrintTree

func (dm *Datamodel) PrintTree(out io.Writer, max int, dflags flags.DatamodelPflagpole) error

func (*Datamodel) Status

func (dm *Datamodel) Status() string

type Lense

type Lense struct {
	// Explination for the snapshot or changes therein
	Description string

	CurrVersion string
	PrevVersion string

	// calculated by hof
	CurrDiff cue.Value // prev -> this
	PrevDiff cue.Value // this -> prev

	// user defined transform to cover the gaps
	// make use of structural to support @st(...)
	CurrUser cue.Value // prev -> this
	PrevUser cue.Value // this -> prev

	// the full transformation or migration to implement the lens
	// calculated as NextDiff & NextUser => NextMig
	CurrMig cue.Value // prev -> this
	PrevMig cue.Value // this -> prev

}

type Snapshot

type Snapshot struct {
	// The current value at this snapshot
	Value cue.Value
	Data  any

	// Position in history
	Pos int

	// Point it was snapshotted
	Timestamp string

	// crypto hash of (snapshot data?)
	Hash string

	// Explination for the snapshot or changes therein
	Message string

	// Lenses between neighboring snapshots
	Lense Lense
}

Snapshot represents a Value at a point in time

type Value

type Value struct {
	*hof.Node[Value]

	// curr & lineage
	Snapshot *Snapshot
	// contains filtered or unexported fields
}

func (*Value) Diff

func (V *Value) Diff() cue.Value

func (*Value) HasHistory

func (V *Value) HasHistory() (bool, error)

check for any history

func (*Value) History

func (V *Value) History() []*Snapshot

History returns the full history for a Value

func (*Value) HistoryDir

func (V *Value) HistoryDir() (string, error)

func (*Value) LatestSnapshot

func (V *Value) LatestSnapshot() *Snapshot

func (*Value) Status

func (V *Value) Status() string