backendtool-examples.xml revision 36e213444660f0a74ed415adeab490a5f3d50a6f
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2015 ForgeRock AS.
!
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook
<title>Examples</title>
<para>
The following example displays index information.
</para>
<screen>
$ <userinput>bin/backendtool dump-tree -n userRoot -b dc=example,dc=com -t id2childrencount </userinput>
<computeroutput>
Key (len 2): 1#52
Value (len 8): 1
Key (len 2): 2#52
Value (len 8): 500000
Key (len 9): Total Children Count
Value (len 8): 500001
Total Records: 3
Total / Average Key Size: 13 bytes / 4 bytes
Total / Average Data Size: 24 bytes / 8 bytes
</computeroutput>
</screen>
</refsect1>