KVLocal Diagnostic Utility

An application can invoke the following KVLocal APIs to catch KVLocal configuration errors. These APIs return important and meaningful information in JSON format, which you can use to identify or diagnose the problem.

Method Name	Description	Parameter	Returns
String verifyConfiguration(boolean verbose)	Verifies the store configuration by iterating over components and checking their state against the information maintained by the Admin service. This method checks if an embedded NoSQL database instance is running in a stable and healthy state. If there are any configuration errors, violations or warnings are generated in the output. Violations are issues that can cause problems and should be investigated.	verbose - specifies whether or not the output contains the verbose output. If false, the output contains violations and warnings only.	The verified configuration results in JSON format.
String verifyData()	Verifies store data integrity. This method is relatively time-consuming since it verifies the Log record integrity on disk and B-tree integrity in memory. If a KVLocal instance has a persistent B-tree or log corruption, the service shuts down and the JE environment is invalidated. JE then creates a file called 7fffffff.jdb, placing it wherever other .jdb files exist in your environment. Manual administration intervention is required to recover from persistent data corruption. For more information on see Recovering from Data Corruption. If a KVLocal instance has transient corruption, the service automatically exits. Transient corruption can occur due to memory corruption. Restarting an embedded NoSQL database instance is required to recover from transient corruption.		The verified data result in JSON format. If no transient corruption is found, the result shows "No Btree Corruptions" and "No Log File Corruptions".

Method Name

Description

Parameter

Returns

String verifyConfiguration(boolean verbose)

Verifies the store configuration by iterating over components and checking their state against the information maintained by the Admin service.

This method checks if an embedded NoSQL database instance is running in a stable and healthy state. If there are any configuration errors, violations or warnings are generated in the output. Violations are issues that can cause problems and should be investigated.

verbose - specifies whether or not the output contains the verbose output. If false, the output contains violations and warnings only.

The verified configuration results in JSON format.

String verifyData()

Verifies store data integrity. This method is relatively time-consuming since it verifies the Log record integrity on disk and B-tree integrity in memory.

If a KVLocal instance has a persistent B-tree or log corruption, the service shuts down and the JE environment is invalidated. JE then creates a file called 7fffffff.jdb, placing it wherever other .jdb files exist in your environment. Manual administration intervention is required to recover from persistent data corruption. For more information on see Recovering from Data Corruption.

If a KVLocal instance has transient corruption, the service automatically exits. Transient corruption can occur due to memory corruption. Restarting an embedded NoSQL database instance is required to recover from transient corruption.

The verified data result in JSON format. If no transient corruption is found, the result shows "No Btree Corruptions" and "No Log File Corruptions".