'\" t
|
.\" Title: dbtest
|
.\" Author:
|
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
|
.\" Date: 03/21/2012
|
.\" Manual: Tools Reference
|
.\" Source: OpenDJ 2.5.0
|
.\" Language: English
|
.\"
|
.TH "DBTEST" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
|
.\" -----------------------------------------------------------------
|
.\" * Define some portability stuff
|
.\" -----------------------------------------------------------------
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
.\" http://bugs.debian.org/507673
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
.ie \n(.g .ds Aq \(aq
|
.el .ds Aq '
|
.\" -----------------------------------------------------------------
|
.\" * set default formatting
|
.\" -----------------------------------------------------------------
|
.\" disable hyphenation
|
.nh
|
.\" disable justification (adjust text to left margin only)
|
.ad l
|
.\" -----------------------------------------------------------------
|
.\" * MAIN CONTENT STARTS HERE *
|
.\" -----------------------------------------------------------------
|
.SH "NAME"
|
dbtest \- gather OpenDJ JE database debugging information
|
.SH "SYNOPSIS"
|
.HP \w'\fBdbtest\fR\fBsubcommand\fR\ 'u
|
\fBdbtest\fR\fBsubcommand\fR [options]
|
.SH "DESCRIPTION"
|
.PP
|
This utility can be used to debug the JE database\&.
|
.SH "SUBCOMMANDS"
|
.PP
|
The following subcommands are supported\&.
|
.PP
|
\fBdbtest dump\-database\-container\fR
|
.RS 4
|
Dump records from a database container
|
.RE
|
.PP
|
\fBdbtest list\-database\-containers\fR
|
.RS 4
|
List the database containers for an entry container
|
.RE
|
.PP
|
\fBdbtest list\-entry\-containers\fR
|
.RS 4
|
List the entry containers for a root container
|
.RE
|
.PP
|
\fBdbtest list\-index\-status\fR
|
.RS 4
|
List the status of indexes in an entry container
|
.RE
|
.PP
|
\fBdbtest list\-root\-containers\fR
|
.RS 4
|
List the root containers used by all JE backends
|
.RE
|
.SH "OPTIONS"
|
.PP
|
The following global options are supported\&.
|
.PP
|
For other options, see
|
\fBdbtest \fR\fB\fIsubcommand\fR\fR\fB \-\-help\fR\&.
|
.PP
|
\fB\-\-version\fR
|
.RS 4
|
Display version information
|
.RE
|
.PP
|
\fB\-?, \-H, \-\-help\fR
|
.RS 4
|
Display usage information
|
.RE
|
.SH "EXIT CODES"
|
.PP
|
0
|
.RS 4
|
The command completed successfully\&.
|
.RE
|
.PP
|
> 0
|
.RS 4
|
An error occurred\&.
|
.RE
|
.SH "EXAMPLES"
|
.PP
|
The following example displays debugging information about the equality index for
|
sudoUser\&.
|
.sp
|
.if n \{\
|
.RS 4
|
.\}
|
.nf
|
$ dbtest dump\-database\-container \-n userRoot \-b dc=example,dc=com
|
\-d sudoUser\&.equality
|
Indexed Value (6 bytes): %admin
|
Entry ID List (8 bytes): 165
|
|
Indexed Value (5 bytes): %sudo
|
Entry ID List (8 bytes): 164
|
|
Indexed Value (4 bytes): root
|
Entry ID List (8 bytes): 163
|
|
|
Total Records: 3
|
Total / Average Key Size: 13 bytes / 4 bytes
|
Total / Average Data Size: 24 bytes / 8 bytes
|
.fi
|
.if n \{\
|
.RE
|
.\}
|
.SH "COPYRIGHT"
|
.br
|
Copyright \(co 2011-2012 ForgeRock AS
|
.br
|
