Framework
IntegrityChecker
Class: IntegrityChecker
Integrity Checker.
Validates derived index structures against authoritative data.
Constructors
new IntegrityChecker()
new IntegrityChecker(adapter): IntegrityCheckerParameters
| Parameter | Type |
|---|---|
adapter | FlashcoreAdapter<string, unknown> |
Returns
Methods
checkAll()
checkAll(
modelName,
catalog,
options?): Promise<IntegrityReport>Check all integrity aspects of a model.
Parameters
| Parameter | Type |
|---|---|
modelName | string |
catalog | Catalog |
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
| Parameter | Type |
|---|---|
catalog | Catalog |
filter | CuckooFilter |
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
| Parameter | Type |
|---|---|
modelName | string |
catalog | Catalog |
field | string |
index | SortedIndex |
namespace? | string |
Returns
Promise<IndexIntegrityResult>
checkUniqueIndexes()
checkUniqueIndexes(
modelName,
uniqueFields,
namespace?): Promise<UniqueIntegrityResult>Check unique index integrity.
Parameters
| Parameter | Type |
|---|---|
modelName | string |
uniqueFields | string[] |
namespace? | string |
Returns
Promise<UniqueIntegrityResult>
quickCheck()
quickCheck(
modelName,
catalog,
filter?,
namespace?): Promise<{
healthy: boolean;
issues: string[];
}>Quick health check (samples only).
Parameters
| Parameter | Type |
|---|---|
modelName | string |
catalog | Catalog |
filter? | CuckooFilter |
namespace? | string |
Returns
Promise<{
healthy: boolean;
issues: string[];
}>
