Package com.sleepycat.je.util

Class DbVerify

java.lang.Object

com.sleepycat.je.util.DbVerify

Direct Known Subclasses:

DbStat

public class DbVerify
extends java.lang.Object

Verifies the internal structures of a database.

When using this utility as a command line program, and the application uses custom key comparators, be sure to add the jars or classes to the classpath that contain the application's comparator classes.

To verify a database and write the errors to stream:

    DbVerify verifier = new DbVerify(env, dbName, quiet);
    verifier.verify();
 

Constructor Summary

Constructors

Constructor	Description
DbVerify(Environment env, java.lang.String dbName, boolean quiet)	Deprecated. as of 7.5, use Environment.verify(com.sleepycat.je.VerifyConfig, java.io.PrintStream) or Database.verify(com.sleepycat.je.VerifyConfig) instead.

Method Summary

Modifier and Type	Method	Description
static void	main(java.lang.String[] argv)	The main used by the DbVerify utility.
boolean	verify(java.io.PrintStream out)	Deprecated. as of 7.5, use Environment.verify(com.sleepycat.je.VerifyConfig, java.io.PrintStream) or Database.verify(com.sleepycat.je.VerifyConfig) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbVerify

public DbVerify(Environment env,
                java.lang.String dbName,
                boolean quiet)

Deprecated.

as of 7.5, use Environment.verify(com.sleepycat.je.VerifyConfig, java.io.PrintStream) or Database.verify(com.sleepycat.je.VerifyConfig) instead. These methods allow specifying all VerifyConfig properties.

Creates a DbVerify object for a specific environment and database.

Parameters:

env - The Environment containing the database to verify.

dbName - The name of the database to verify.

quiet - true if the verification should not produce errors to the output stream

Method Detail

main

public static void main(java.lang.String[] argv)
                 throws DatabaseException

The main used by the DbVerify utility.

Parameters:

argv - The arguments accepted by the DbVerify utility.

 usage: java { com.sleepycat.je.util.DbVerify | -jar
 je-<version>.jar DbVerify }
             [-q] [-V] -s database -h dbEnvHome [-v progressInterval]
             [-bs batchSize] [-d delayMs] [-vdr]
 

-V - show the version of the JE library.
-s - specify the database to verify
-h - specify the environment directory
-q - work quietly and don't display errors
-v - report intermediate statistics every progressInterval Leaf Nodes
-bs - specify how many records to check each batch
-d - specify the delay in ms between batches
-vdr - verify data records (read LNs)
-vor - verify obsolete records (cleaner metadata)

Note that the DbVerify command line cannot be used to verify the integrity of secondary databases, because this feature requires the secondary databases to have been opened by the application. To verify secondary database integrity, use Environment.verify(com.sleepycat.je.VerifyConfig, java.io.PrintStream) or Database.verify(com.sleepycat.je.VerifyConfig) instead, from within the application.

Throws:

EnvironmentFailureException - if an unexpected, internal or environment-wide failure occurs.

DatabaseException

verify

public boolean verify(java.io.PrintStream out)
               throws DatabaseException

Deprecated.

as of 7.5, use Environment.verify(com.sleepycat.je.VerifyConfig, java.io.PrintStream) or Database.verify(com.sleepycat.je.VerifyConfig) instead. These methods allow specifying all VerifyConfig properties.

Verifies a database and write errors found to a stream.

Parameters:

out - The stream to write errors to.

Returns:

true if the verification found no errors. Currently true is always returned when this method returns normally, i.e., when no exception is thrown.

Throws:

EnvironmentFailureException - if an environment corruption is detected, or if an unexpected, internal or environment-wide failure occurs. If a persistent corruption is detected, EnvironmentFailureException.isCorrupted() will return true.

CorruptSecondariesException - if an environment corruption is not detected, but one more more corrupt SecondaryDatabases is detected. The exception contains information about the corrupt databases. The Environment is not invalidated, but note that SecondaryIntegrityException will be thrown when attempting to access a corrupt SecondaryDatabase and it should be closed.

DatabaseException