verify-index
Prev | Directory Server Tools | Next

## Name

verify-index — check index for consistency or errors

## Synopsis

`verify-index`

## Description

This utility can be used to ensure that index data is consistent within an indexed backend database.

## Options

The verify-index command takes the following options:

Command options:

`-b | --baseDN {baseDN}`

  Base DN of a backend supporting indexing. Verification is performed on indexes within the scope of the given base DN.

`-c | --clean`

  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.

  Default: false

`--countErrors`

  Count the number of errors found during the verification and return that value as the exit code (values > 255 will be reduced to 255 due to exit code restrictions).

  Default: false

`-i | --index {index}`

  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.

General options:

`-V | --version`

  Display Directory Server version information.

  Default: false

`-H | --help`

  Display this usage information.

  Default: false

## Exit Codes

0

  The command completed successfully.

1

  The command was run in non-interactive mode, but could not complete because confirmation was required to run a long or critical task.

  See the error message or the log for details.

0-255

  The number of errors in the index, as indicated for the `--countErrors` option.

## Examples

The following example shows how to verify the `sn` (surname) index for completeness and for errors. The messages shown are for a backend of type `pdb`. The output is similar for other backend types:

    $ verify-index -b dc=example,dc=com -i sn --clean --countErrors
    [20/05/2015:14:24:18 +0200] category=...PDBStorage seq=0 severity=INFO
     msg=The PDB storage for backend 'userRoot' initialized
     to use 57528 buffers of 16384 bytes (total 920448kb)
    [20/05/2015:14:24:18 +0200] category=...pluggable.VerifyJob seq=1 severity=INFO
     msg=Checked 478 records and found 0 error(s) in 0 seconds
     (average rate 3594.0/sec)
    [20/05/2015:14:24:18 +0200] category=...pluggable.VerifyJob seq=2 severity=FINE
     msg=Number of records referencing more than one entry: 224
    [20/05/2015:14:24:18 +0200] category=...pluggable.VerifyJob seq=3 severity=FINE
     msg=Number of records that exceed the entry limit: 0
    [20/05/2015:14:24:18 +0200] category=...pluggable.VerifyJob seq=4 severity=FINE
     msg=Average number of entries referenced is 2.00/record
    [20/05/2015:14:24:18 +0200] category=...pluggable.VerifyJob seq=5 severity=FINE
     msg=Maximum number of entries referenced by any record is 32

Prev | Up | Next
upgrade | Home | windows-service