integrity

type CacheKey struct {
	Addr hash.Hash
	Desc uint64
}

type CorruptionError struct {
	Database string
	Branch   string
	// Commit is the hash of the corrupt commit, or empty if the corruption was found in the branch's
	// uncommitted working set.
	Commit string
	Table  string
	Stats  *Stats
}

type InternalKeyAnalysis struct {
	// OutOfBandValues is the number of adaptive-encoded values stored out-of-band in the node's keys.
	OutOfBandValues uint64
	// CorruptValues is the number of expected chunk address references missing from the node's
	// key_address_offsets field.
	CorruptValues uint64
	// UnexpectedOffsets is the number of recorded offsets that match no address in the node's keys.
	UnexpectedOffsets uint64
	// Corrupt is true when at least one expected offset is missing; such nodes must be rewritten to
	// be repaired.
	Corrupt bool
}

type LeafAnalysis struct {
	Stats Stats
	// Corrupt is true when at least one expected offset is missing from value_address_offsets or
	// key_address_offsets; such nodes must be rewritten to be repaired.
	Corrupt bool
	// ValueOOBAddrs are the chunk addresses referenced from value tuples (out-of-band adaptive values
	// and address-encoded fields).
	ValueOOBAddrs []hash.Hash
	// KeyOOBAddrs are the chunk addresses referenced by out-of-band adaptive values in key tuples.
	KeyOOBAddrs []hash.Hash
}

type Scanner struct {
	Cs chunks.ChunkStore

	// CacheHits counts subtree scans satisfied from the cache.
	CacheHits uint64
	// contains filtered or unexported fields
}

type Stats struct {
	// Chunks is the total number of tree node chunks in the subtree.
	Chunks uint64
	// LeafChunks is the number of leaf node chunks in the subtree.
	LeafChunks uint64
	// CorruptChunks is the number of chunks, leaf or internal, with at least one missing key or value
	// address offset.
	CorruptChunks uint64
	// Rows is the total number of rows in the subtree.
	Rows uint64
	// CorruptRows is the number of rows with at least one out-of-band value missing from the node's
	// recorded key or value address offsets.
	CorruptRows uint64
	// AdaptiveValues is the number of non-NULL adaptive-encoded values in value tuples.
	AdaptiveValues uint64
	// OutOfBandValues is the number of adaptive-encoded values stored out-of-band in value tuples.
	OutOfBandValues uint64
	// CorruptValues is the number of expected chunk address references (out-of-band adaptive values and
	// non-empty address-encoded fields) missing from the node's value_address_offsets field.
	CorruptValues uint64
	// UnexpectedOffsets is the number of recorded value_address_offsets entries that do not correspond to
	// any address in the node's value tuples. Always zero for both healthy and known-corrupt databases.
	UnexpectedOffsets uint64
	// KeyAdaptiveValues is the number of non-NULL adaptive-encoded values in key tuples.
	KeyAdaptiveValues uint64
	// KeyOutOfBandValues is the number of adaptive-encoded values stored out-of-band in key tuples.
	KeyOutOfBandValues uint64
	// KeyCorruptValues is the number of expected chunk address references missing from the node's
	// key_address_offsets field. Nodes written before that field existed record no key addresses at
	// all, so any out-of-band key value they hold counts here.
	KeyCorruptValues uint64
	// InternalKeyOutOfBandValues is the number of adaptive-encoded values stored out-of-band in the
	// key tuples of internal (non-leaf) nodes. Internal boundary keys are copies of leaf keys, so
	// these are duplicates of values counted in KeyOutOfBandValues.
	InternalKeyOutOfBandValues uint64
	// InternalKeyCorruptValues is the number of expected chunk address references missing from the
	// key_address_offsets field of internal (non-leaf) nodes.
	InternalKeyCorruptValues uint64
	// MissingChunks is the number of out-of-band values (key or value side) whose chunks are absent from
	// the chunk store. These values are already lost (e.g. to a previous GC) and cannot be repaired by
	// rewriting nodes.
	MissingChunks uint64
}

type TableInfo struct {
	Name    doltdb.TableName
	Tbl     *doltdb.Table
	Sch     schema.Schema
	KeyDesc *val.TupleDesc
	ValDesc *val.TupleDesc

	// AdaptiveValueCols are the names of value (non-PK) columns with an adaptive encoding.
	AdaptiveValueCols []string
	// AdaptiveKeyCols are the names of key (PK) columns with an adaptive encoding.
	AdaptiveKeyCols []string
}