6330N/A<?
xml version="1.0" encoding="UTF-8"?>
6330N/A ! This work is licensed under the Creative Commons 6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 6330N/A ! To view a copy of this license, visit 6330N/A ! or send a letter to Creative Commons, 444 Castro Street, 6330N/A ! Suite 900, Mountain View, California, 94041, USA. 6330N/A ! You can also obtain a copy of the license at 6330N/A ! See the License for the specific language governing permissions 6330N/A ! and limitations under the License. 6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields 6330N/A ! enclosed by brackets "[]" replaced with your own identifying information: 6330N/A ! Portions Copyright [yyyy] [name of copyright owner] 6330N/A ! Copyright 2011-2012 ForgeRock AS 6330N/A ! Portions Copyright 2013 Jens Elkner 6330N/A <
refentrytitle><
application>dbtest</
application></
refentrytitle>
6330N/A <
xi:
include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A <
refname><
application>dbtest</
application></
refname>
6330N/A <
refpurpose>gather OpenDJ JE database debugging information</
refpurpose>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A <
arg choice="plain">dump-database-container</
arg>
6330N/A <
arg>-n <
replaceable class="parameter">backendId</
replaceable></
arg>
6330N/A <
arg>-b <
replaceable class="parameter">baseDN</
replaceable></
arg>
6330N/A <
arg>-d <
replaceable class="parameter">dbName</
replaceable></
arg>
6330N/A <
arg>-K <
replaceable class="parameter">maxKeyVal</
replaceable></
arg>
6330N/A <
arg>-k <
replaceable class="parameter">minKeyVal</
replaceable></
arg>
6330N/A <
arg>-S <
replaceable class="parameter">maxDataSz</
replaceable></
arg>
6330N/A <
arg>-s <
replaceable class="parameter">minDataSz</
replaceable></
arg>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A <
arg choice="plain">list-database-containers</
arg>
6330N/A <
arg>-n <
replaceable class="parameter">backendId</
replaceable></
arg>
6330N/A <
arg>-b <
replaceable class="parameter">baseDN</
replaceable></
arg>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A <
arg choice="plain">list-entry-containers</
arg>
6330N/A <
arg>-n <
replaceable class="parameter">backendId</
replaceable></
arg>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A <
arg choice="plain">list-index-status</
arg>
6330N/A <
arg>-n <
replaceable class="parameter">backendId</
replaceable></
arg>
6330N/A <
arg>-b <
replaceable class="parameter">baseDN</
replaceable></
arg>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A <
arg choice="plain">list-root-containers</
arg>
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/AThis utility can be used to debug the JE database.
6330N/AThe following subcommands are supported.
6330N/A <
term><
command>dbtest dump-database-container</
command></
term>
6330N/ADump records from a database container.
6330N/AThe following options are supported:
6330N/A <
term><
option>-n, --backendID</
option> <
replaceable 6330N/A class="parameter">backendName</
replaceable></
term>
6330N/AThe backend ID of the JE backend to debug.
6330N/A <
term><
option>-b, --baseDN</
option> <
replaceable 6330N/A class="parameter">baseDN</
replaceable></
term>
6330N/AThe base DN of the entry container to debug.
6330N/A <
term><
option>-d, --databaseName</
option> <
replaceable 6330N/A class="parameter">dbName</
replaceable></
term>
6330N/AThe name of the database container to debug.
6330N/A <
term><
option>-p, --skipDecode</
option></
term>
6330N/ADo not try to decode the JE data to their appropriate types.
6330N/A <
term><
option>-q, --statsOnly</
option></
term>
6330N/ADo not display the JE data, just statistics.
6330N/A <
term><
option>-K, --maxKeyValue</
option> <
replaceable 6330N/A class="parameter">value</
replaceable></
term>
6330N/AOnly show records with keys that should be ordered before the provided value
6330N/Ausing the comparator for the database container.
6330N/A <
term><
option>-k, --minKeyValue</
option> <
replaceable 6330N/A class="parameter">value</
replaceable></
term>
6330N/AOnly show records with keys that should be ordered after the provided value
6330N/Ausing the comparator for the database container.
6330N/A <
term><
option>-S, --maxDataSize</
option> <
replaceable 6330N/A class="parameter">value</
replaceable></
term>
6330N/AOnly show records whose data is no larger than the provided value (Default: -1).
6330N/A <
term><
option>-s, --minDataSize</
option> <
replaceable 6330N/A class="parameter">value</
replaceable></
term>
6330N/AOnly show records whose data is no smaller than the provided value (Default: -1).
6330N/A <
term><
command>dbtest list-database-containers</
command></
term>
6330N/AList the database containers for an entry container.
6330N/AThe following options are supported:
6330N/A <
term><
option>-n, --backendID</
option> <
replaceable 6330N/A class="parameter">backendName</
replaceable></
term>
6330N/AThe backend ID of the JE backend to debug.
6330N/A <
term><
option>-b, --baseDN</
option> <
replaceable 6330N/A class="parameter">baseDN</
replaceable></
term>
6330N/AThe base DN of the entry container to debug.
6330N/A <
term><
command>dbtest list-entry-containers</
command></
term>
6330N/AList the entry containers for a root container.
6330N/AThe following options are supported:
6330N/A <
term><
option>-n, --backendID</
option> <
replaceable 6330N/A class="parameter">backendName</
replaceable></
term>
6330N/AThe backend ID of the JE backend to debug.
6330N/A <
term><
command>dbtest list-index-status</
command></
term>
6330N/AList the status of indexes in an entry container.
6330N/AThe following options are supported:
6330N/A <
term><
option>-n, --backendID</
option> <
replaceable 6330N/A class="parameter">backendName</
replaceable></
term>
6330N/AThe backend ID of the JE backend to debug.
6330N/A <
term><
option>-b, --baseDN</
option> <
replaceable 6330N/A class="parameter">baseDN</
replaceable></
term>
6330N/AThe base DN of the entry container to debug.
6330N/A <
term><
command>dbtest list-root-containers</
command></
term>
6330N/AList the root containers used by all JE backends.
6330N/AThe following global options are supported.
6330N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6330N/AThe following example displays debugging information about the equality index
6330N/Afor <
acronym>sudoUser</
acronym>.
6330N/A>$ </
prompt><
command>dbtest dump-database-container -n userRoot \
6330N/AIndexed Value (6 bytes): %admin
6330N/AEntry ID List (8 bytes): 165
6330N/AIndexed Value (5 bytes): %sudo
6330N/AEntry ID List (8 bytes): 164
6330N/AIndexed Value (4 bytes): root
6330N/AEntry ID List (8 bytes): 163
6330N/ATotal / Average Key Size: 13 bytes / 4 bytes
6330N/ATotal / Average Data Size: 24 bytes / 8 bytes
6330N/A <
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
6330N/A <
xi:
include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>