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.
verify-index --baseDN dc=example,dc=com
verify-index --baseDN dc=example,dc=com --countErrors --index dn2id \
--index id2children --index id2subtree --index sn --index vlv.example
verify-index --baseDN dc=example,dc=com --clean --index sn
-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 the tool should iterate through each key in an index to ensure that each of the entry IDs for that key references an entry that exists and that has at least one value that matches the associated key. This option may only be used to verify a single index, and the 'clean' verification process may require more expensive database access patterns that can cause it to proceed more slowly than when this option is not used |
--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 |
--listKeysExceedingIndexEntryLimit
| Description | Display the keys that have exceeded the index entry limit for each index |
--listKeysNearestIndexEntryLimit {count}
| Description | Display the specified number of index keys that are closest to (but have not yet exceeded) the index entry limit for each index. Note that this will require the tool to hold all keys from the selected indexes in memory, which may require increasing the heap size for the tool if you intend to use it with indexes that may have a very large number of keys |
| Lower Bound | 0 |
| Required | No |
| Multi-Valued | No |
--logFilePath {logFilePath}
| Description | Echo the console output to the specified log file, instead of the default ' |
| Required | No |
| Multi-Valued | No |