LogoRobo.js
Framework

IntegrityChecker

Class: IntegrityChecker

Integrity Checker.

Validates derived index structures against authoritative data.

Constructors

new IntegrityChecker()

new IntegrityChecker(adapter): IntegrityChecker

Parameters

ParameterType
adapterFlashcoreAdapter<string, unknown>

Returns

IntegrityChecker

Methods

checkAll()

checkAll(
   modelName, 
   catalog, 
options?): Promise<IntegrityReport>

Check all integrity aspects of a model.

Parameters

ParameterType
modelNamestring
catalogCatalog
options?IntegrityCheckOptions & { filter: CuckooFilter; namespace: string; sortedIndexes: Map<string, SortedIndex>; uniqueFields: string[]; }

Returns

Promise<IntegrityReport>


checkFilter()

checkFilter(
   catalog, 
   filter, 
options?): Promise<FilterIntegrityResult>

Check filter integrity against catalog.

Parameters

ParameterType
catalogCatalog
filterCuckooFilter
options?{ sampleSize: number; }
options.sampleSize?number

Returns

Promise<FilterIntegrityResult>


checkSortedIndex()

checkSortedIndex(
   modelName, 
   catalog, 
   field, 
   index, 
namespace?): Promise<IndexIntegrityResult>

Check sorted index integrity against records.

Parameters

ParameterType
modelNamestring
catalogCatalog
fieldstring
indexSortedIndex
namespace?string

Returns

Promise<IndexIntegrityResult>


checkUniqueIndexes()

checkUniqueIndexes(
   modelName, 
   uniqueFields, 
namespace?): Promise<UniqueIntegrityResult>

Check unique index integrity.

Parameters

ParameterType
modelNamestring
uniqueFieldsstring[]
namespace?string

Returns

Promise<UniqueIntegrityResult>


quickCheck()

quickCheck(
   modelName, 
   catalog, 
   filter?, 
   namespace?): Promise<{
  healthy: boolean;
  issues: string[];
}>

Quick health check (samples only).

Parameters

ParameterType
modelNamestring
catalogCatalog
filter?CuckooFilter
namespace?string

Returns

Promise<{ healthy: boolean; issues: string[]; }>

On this page