io.permazen.jsck

Class JsckConfig

java.lang.Object

io.permazen.jsck.JsckConfig

public class JsckConfig
extends Object

Configuration for a Jsck key/value database consistency inspection.

Constructor Summary

Constructors

Constructor and Description
JsckConfig()

Method Summary

Modifier and Type	Method and Description
FieldTypeRegistry	getFieldTypeRegistry() Get the FieldTypeRegistry used to interpret field type names in recorded schemas.
int	getForceFormatVersion() Configure a database format version to forcibly apply.
Map<Integer,SchemaModel>	getForceSchemaVersions() Configure schema versions to forcibly apply.
JsckLogger	getJsckLogger() Configure a destination for log messages emitted during the scan.
KeyRanges	getKeysToInspect() Get the restricted ranges of keys that should be inspected, if any.
long	getMaxIssues() Configure a maximum number of issues to generate.
boolean	isGarbageCollectSchemas() Determine whether to garbage collect unused schema versions.
boolean	isRepair() Determine whether to repair any database inconsistencies found.
void	setFieldTypeRegistry(FieldTypeRegistry fieldTypeRegistry)
void	setForceFormatVersion(int forceFormatVersion)
void	setForceSchemaVersions(Map<Integer,SchemaModel> forceSchemaVersions)
void	setGarbageCollectSchemas(boolean garbageCollectSchemas)
void	setJsckLogger(JsckLogger logger)
void	setKeysToInspect(KeyRanges keysToInspect)
void	setMaxIssues(long maxIssues)
void	setRepair(boolean repair)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsckConfig

public JsckConfig()

Method Detail

getKeysToInspect

public KeyRanges getKeysToInspect()

Get the restricted ranges of keys that should be inspected, if any.

This property allows limiting inspection to specific objects, object types, or indexes. Note: recorded schema information is always fully checked.

Default is null, i.e., no restriction.

TODO: this is not implemented yet

Returns:

ranges of keys to inspect, or null for no restriction

setKeysToInspect

public void setKeysToInspect(KeyRanges keysToInspect)

getFieldTypeRegistry

public FieldTypeRegistry getFieldTypeRegistry()

Get the FieldTypeRegistry used to interpret field type names in recorded schemas.

Any custom field types used to encode fields in the database must be included in a configured FieldTypeRegistry.

Default is new FieldTypeRegistry().

Returns:

registry of field types

setFieldTypeRegistry

public void setFieldTypeRegistry(FieldTypeRegistry fieldTypeRegistry)

isGarbageCollectSchemas

public boolean isGarbageCollectSchemas()

Determine whether to garbage collect unused schema versions.

If set, at the end of inspection any unused schema versions will be deleted. Note this occurs even if isRepair() returns false.

Default false.

Returns:

true to garbage collect unused schema versions, otherwise false

setGarbageCollectSchemas

public void setGarbageCollectSchemas(boolean garbageCollectSchemas)

getJsckLogger

public JsckLogger getJsckLogger()

Configure a destination for log messages emitted during the scan.

By default, messages are logged via this class' Logger via JsckLogger.wrap().

Returns:

true to repair inconsistencies, otherwise false

setJsckLogger

public void setJsckLogger(JsckLogger logger)

isRepair

public boolean isRepair()

Determine whether to repair any database inconsistencies found.

Without this flag being set, no changes will be made to the key/value store, with the exception of garbage collecting schema versions.

Default false.

Returns:

true to repair inconsistencies, otherwise false

setRepair

public void setRepair(boolean repair)

getForceSchemaVersions

public Map<Integer,SchemaModel> getForceSchemaVersions()

Configure schema versions to forcibly apply.

Entries in the configured Map will be forcibly written to the database, causing any existing schema versions recorded under the same version number to be overridden. Otherwise, if a valid recorded schema does not have a corresponding entry in this map, it is assumed by Jsck to be accurate.

Entries with null values will forcibly delete the corresponding schema version and all objects having that schema version from the database.

Warning: use of this property is dangerous, because it affects how Jsck interprets the key/value data of objects with the corresponding version(s) in the database. This property should only be used if:

• It is known that the corresponding schema entries recorded in the key/value database have been somehow corrupted or deleted; and
• The actual schema version(s) are known and configured here.

Default is an empty map (i.e., disabled).

Returns:

map from schema version number to schema model (to add/override schema version) or null (to remove schema version)

setForceSchemaVersions

public void setForceSchemaVersions(Map<Integer,SchemaModel> forceSchemaVersions)

getForceFormatVersion

public int getForceFormatVersion()

Configure a database format version to forcibly apply.

Using this property will cause any existing database format version number to be overridden with the configured value.

Warning: use of this property is dangerous, because it affects how Jsck interprets all other key/value data in the database. This property should only be used if:

• This Jsck utility is at least as current as the any version of Permazen that has written to the database
• It is known that the format version key/value entry has been somehow corrupted or deleted; and
• The actual format version is known and configured here.

In other words, "only use this if you know what you are doing".

Default zero (i.e., disabled).

Returns:

enforced format version, or zero if disabled

setForceFormatVersion

public void setForceFormatVersion(int forceFormatVersion)

getMaxIssues

public long getMaxIssues()

Configure a maximum number of issues to generate.

Default is Long.MAX_VALUE.

Returns:

maximum number of issues

setMaxIssues

public void setMaxIssues(long maxIssues)