Package io.permazen.jsck

Class Jsck

java.lang.Object

io.permazen.jsck.Jsck

public class Jsck
extends Object

Applies consistency checks to, and optionally repairs corruption of, a Permazen key/value database.

Constructor Summary

Constructors

Constructor	Description
Jsck(JsckConfig config)

Method Summary

Modifier and Type	Method	Description
long	check(KVStore kv, Consumer<? super Issue> consumer)	Perform check.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsck

public Jsck(JsckConfig config)

Method Details

check

public long check(KVStore kv,
 Consumer<? super Issue> consumer)

Perform check.

Parameters:

kv - key/value database

consumer - recipient of any issues found; or null for none

Returns:

the number of issues encountered

Throws:

IllegalArgumentException - if database is not a Permazen database (i.e., no format version key)

IllegalArgumentException - if an override schema is invalid

SchemaMismatchException - if the database's recorded schemas are mutually inconsistent (due to schema overrides)