7321N/A<?
xml version="1.0" encoding="UTF-8"?>
7321N/A ! This work is licensed under the Creative Commons 7321N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 7321N/A ! To view a copy of this license, visit 7321N/A ! or send a letter to Creative Commons, 444 Castro Street, 7321N/A ! Suite 900, Mountain View, California, 94041, USA. 7321N/A ! You can also obtain a copy of the license at 7321N/A ! See the License for the specific language governing permissions 7321N/A ! and limitations under the License. 7321N/A ! If applicable, add the following below this CCPL HEADER, with the fields 7321N/A ! enclosed by brackets "[]" replaced with your own identifying information: 7321N/A ! Portions Copyright [yyyy] [name of copyright owner] 7321N/A ! Copyright 2011-2014 ForgeRock AS 7321N/A<
refentry xml:
id='verify-index-1' 7321N/A version='5.0' xml:
lang='en' 7321N/A <
info><
copyright><
year>2011-2014</
year><
holder>ForgeRock AS</
holder></
copyright></
info>
7321N/A <
refentrytitle>verify-index</
refentrytitle><
manvolnum>1</
manvolnum>
7321N/A <
refmiscinfo class="software">OpenDJ</
refmiscinfo>
7321N/A <
refmiscinfo class="version"><?
eval ${
docTargetVersion}?></
refmiscinfo>
7321N/A <
refname>verify-index</
refname>
7321N/A <
refpurpose>check index for consistency or errors</
refpurpose>
7321N/A <
command>verify-index</
command>
7321N/A <
arg choice="req">options</
arg>
7321N/A <
para>This utility can be used to ensure that index data is consistent
7321N/A within a backend based on the Berkeley DB Java Edition.</
para>
7321N/A <
para>The following options are supported.</
para>
7321N/A <
term><
option>-b, --baseDN {baseDN}</
option></
term>
7321N/A <
para>Base DN of a backend supporting indexing. Verification is
7321N/A performed on indexes within the scope of the given base DN.</
para>
7321N/A <
term><
option>-c, --clean</
option></
term>
7321N/A <
para>Specifies that a single index should be verified to ensure it is
7321N/A clean. An index is clean if each index value references only entries
7321N/A containing that value. Only one index at a time may be verified in this
7321N/A <
term><
option>--countErrors</
option></
term>
7321N/A <
para>Count the number of errors found during the verification and return
7321N/A that value as the exit code (values > 255 will be reduced to 255 due to
7321N/A exit code restrictions).</
para>
7321N/A <
term><
option>-i, --index {index}</
option></
term>
7321N/A <
para>Name of an index to be verified. For an attribute index this is
7321N/A simply an attribute name. Multiple indexes may be verified for
7321N/A completeness, or all indexes if no indexes are specified. An index is
7321N/A complete if each index value references all entries containing that
7321N/A <
title>General Options</
title>
7321N/A <
term><
option>-V, --version</
option></
term>
7321N/A <
para>Display version information</
para>
7321N/A <
term><
option>-?, -H, --help</
option></
term>
7321N/A <
para>Display usage information</
para>
7321N/A <
para>The command completed successfully.</
para>
7321N/A <
para>An error occurred while parsing the command-line arguments.</
para>
7321N/A <
para>The number of errors in the index, as indicated for the
7321N/A <
option>--countErrors</
option> option.</
para>
7321N/A <
para>The following example verifies the <
literal>cn</
literal> (common
7321N/A name) index for completeness and for errors.</
para>
7321N/A$ <
userinput>verify-index -b dc=example,dc=com -i cn --clean --countErrors</
userinput>
7321N/A<
computeroutput>[
07/
Jun/
2011:16:06:50 +0200] category=BACKEND severity=INFORMATION
7321N/A msgID=9437595 msg=Local DB backend userRoot does not specify the number of
7321N/A lock tables: defaulting to 97
7321N/A msgID=9437594 msg=Local DB backend userRoot does not specify the number of
7321N/A cleaner threads: defaulting to 24 threads
7321N/A msg=Checked 1316 records and found 0 error(s) in 0 seconds
7321N/A msgID=8388710 msg=Number of records referencing more than one entry: 315
7321N/A msgID=8388711 msg=Number of records that exceed the entry limit: 0
7321N/A msgID=8388713 msg=Maximum number of entries referenced by any
7321N/A record is 32</
computeroutput>