Directory Server Documentation Index
Command-Line Tool Reference Home

verify-index

↓Description
↓Examples
↓Arguments

Description

Verify that indexes in a backend using the Berkeley DB Java Edition are consistent with the entry data contained in the database.

The backend containing the provided base DN must be a local DB backend. The types of indexes that can be verified include system indexes, attribute indexes and vlv indexes. Any errors found during verification are written to the output. The verification process is exhaustive and can take a long time.

Examples

Verify that all indexes within the scope of the base DN 'dc=example,dc=com' are complete: 
verify-index --baseDN dc=example,dc=com


Verify that specified indexes within the scope of the base DN 'dc=example,dc=com' are complete. The system indexes are verified together with the 'sn' attribute index and a vlv index named 'example'. The number of errors found is returned as the exit code of the tool, which is useful if the command is run in a script: 
verify-index --baseDN dc=example,dc=com --countErrors --index dn2id \
     --index id2children --index id2subtree --index sn --index vlv.example


Verify that the 'sn' attribute index is clean (does not reference any entries it should not): 
verify-index --baseDN dc=example,dc=com --clean --index sn

Arguments

-V
--version

Description Display Directory Server version information

-H
--help

Description Display general usage information

--help-debug

Description Display help for using debug options
Advanced Yes

-b {baseDN}
--baseDN {baseDN}

Description Base DN of a backend supporting indexing. Verification is performed on indexes within the scope of the given base DN
Required Yes
Multi-Valued No

-i {index}
--index {index}

Description Name of an index to be verified. For an attribute index this is simply an attribute name. Multiple indexes may be verified for completeness, or all indexes, if no indexes are specified. An index is complete if each index value references all entries containing that value
Required No
Multi-Valued Yes

-c
--clean

Description Specifies that a single index should be verified to ensure it is clean. An index is clean if each index value references only entries containing that value. Only one index at a time may be verified in this way

--countErrors

Description Counts the number of errors found during the verification and returns that value as the exit code (values greater than 255 will be reduced to 255 due to exit code restrictions)

-t {numThreads}
--numThreads {numThreads}

Description The number of concurrent threads to use for parallel processing. If this is not specified, then the number of threads will be automatically determined based on the number of available CPUs. This will be ignored if the '--clean' argument is provided
Lower Bound 0
Default Value 0
Required No
Multi-Valued No

--logFilePath {logFilePath}

Description Echo the console output to the specified log file, instead of the default '/logs/tools/ds-tool.log' file
Required No
Multi-Valued No