0N/A<?
xml version="1.0" encoding="UTF-8"?>
0N/A ! This work is licensed under the Creative Commons 0N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 0N/A ! To view a copy of this license, visit 0N/A ! or send a letter to Creative Commons, 444 Castro Street, 0N/A ! Suite 900, Mountain View, California, 94041, USA. 0N/A ! You can also obtain a copy of the license at 0N/A ! See the License for the specific language governing permissions 0N/A ! and limitations under the License. 0N/A ! If applicable, add the following below this CCPL HEADER, with the fields 873N/A ! enclosed by brackets "[]" replaced with your own identifying information: 0N/A ! Portions Copyright [yyyy] [name of copyright owner] 0N/A ! Copyright 2011-2012 ForgeRock AS 3233N/A ! Portions Copyright 2013 Jens Elkner 0N/A version="5.0" xml:
lang="en" 0N/A <
xi:
include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
0N/A <
refentrytitle><
application>verify-index</
application></
refentrytitle>
0N/A <
xi:
include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
0N/A <
refname><
application>verify-index</
application></
refname>
0N/A <
refpurpose>check index for consistency or errors</
refpurpose>
2814N/A <
command>verify-index</
command>
0N/A <
arg>-b <
replaceable class="parameter">baseDN</
replaceable></
arg>
0N/A <
arg rep="repeat">-i <
replaceable class="parameter">index</
replaceable></
arg>
0N/A <
arg>--countErrors</
arg>
0N/A <
title>Description</
title>
0N/AThis utility can be used to ensure that index data is consistent within a
0N/Abackend based on the Berkeley DB Java Edition.
0N/A <
refsection xml:
id="verify-index-1-options">
0N/A <
title>Options</
title>
0N/AThe following options are supported.
0N/A <
term><
option>-b, --baseDN</
option> <
replaceable class="parameter" 0N/A >baseDN</
replaceable></
term>
0N/ABase DN of a backend supporting indexing. Verification is performed on indexes
0N/Awithin the scope of the given base DN.
0N/A <
term><
option>-c, --clean</
option></
term>
2814N/ASpecifies that a single index should be verified to ensure it is clean. An index
0N/Ais clean if each index value references only entries containing that value. Only
0N/Aone index at a time may be verified in this way.
0N/A <
term><
option>--countErrors</
option></
term>
0N/ACount the number of errors found during the verification and return that value
0N/Aas the exit code (values > 255 will be reduced to 255 due to exit code
0N/A <
term><
option>-i, --index</
option> <
replaceable class="parameter" 0N/A >index</
replaceable></
term>
0N/AName of an index to be verified. For an attribute index this is simply an
0N/Aattribute name. Multiple indexes may be verified for completeness, or all
0N/Aindexes if no indexes are specified. An index is complete if each index value
0N/Areferences all entries containing that value.
0N/A <
title>General Options</
title>
0N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
0N/A <
title>Examples</
title>
0N/AThe following example verifies the <
literal>cn</
literal> (common name) index for
0N/Acompleteness and for errors.
0N/A>$ </
prompt><
command>verify-index -b dc=example,dc=com -i cn --clean --countErrors</
command></
literallayout>
0N/A[
07/
Jun/
2011:16:06:50 +0200] category=BACKEND severity=INFORMATION msgID=9437595 msg=Local DB backend userRoot does not specify the number of lock tables: defaulting to 97
0N/A[
07/
Jun/
2011:16:06:50 +0200] category=BACKEND severity=INFORMATION msgID=9437594 msg=Local DB backend userRoot does not specify the number of cleaner threads: defaulting to 24 threads
0N/A[
07/
Jun/
2011:16:06:51 +0200] category=JEB severity=NOTICE msgID=8847461 msg=Checked 1316 records and found 0 error(s) in 0 seconds (average rate
2506.7/
sec)
0N/A[
07/
Jun/
2011:16:06:51 +0200] category=JEB severity=INFORMATION msgID=8388710 msg=Number of records referencing more than one entry: 315
0N/A[
07/
Jun/
2011:16:06:51 +0200] category=JEB severity=INFORMATION msgID=8388711 msg=Number of records that exceed the entry limit: 0
0N/A[
07/
Jun/
2011:16:06:51 +0200] category=JEB severity=INFORMATION msgID=8388712 msg=Average number of entries referenced is
1.58/
record 0N/A[
07/
Jun/
2011:16:06:51 +0200] category=JEB severity=INFORMATION msgID=8388713 msg=Maximum number of entries referenced by any record is 32
0N/A <
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
0N/A <
title>Exit Status</
title>
0N/A <
term><
errorcode>0</
errorcode></
term>
0N/AThe command completed successfully.
0N/A <
term><
errorcode>1</
errorcode></
term>
0N/AAn error occurred while parsing the command-line arguments.
0N/A <
term><
errorcode>0-255</
errorcode></
term>
0N/AThe number of errors in the index, as indicated for the <
option 0N/A>--countErrors</
option> option.
0N/A <
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>