From 4a2bb894a78d6acc336f6bff950c1e18ed788edb Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Mon, 17 Oct 2011 08:33:28 +0000
Subject: [PATCH] Thanks to Danny Turner for more doc review comments
---
opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-indexing.xml | 44 +++++++++++++++++++++++++++++++++++++-------
1 files changed, 37 insertions(+), 7 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-indexing.xml b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-indexing.xml
index 29f5544..3f3df21 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-indexing.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-indexing.xml
@@ -200,7 +200,9 @@
<para>You modify index configurations using the <command>dsconfig</command>
command. The configuration changes then take effect after you rebuild the
index according to the new configuration, using the
- <command>rebuild-index</command>.</para>
+ <command>rebuild-index</command>. The <command>dsconfig
+ --help-database</command> command lists subcommands for creating, reading,
+ updating, and deleting index configuration.</para>
<tip>
<para>Indexes are per directory backend rather than per suffix. To maintain
@@ -272,11 +274,29 @@
<imageobject>
<imagedata fileref="images/create-vlv-index.png" format="PNG" />
</imageobject>
- </mediaobject>
+ </mediaobject>
<para>After you finish configuring your index and click OK, the Control
Panel prompts you to make the additional changes necessary to complete the
VLV index configuration, and then to build the index.</para>
+
+ <para>You can also create the equivalent index configuration using the
+ <command>dsconfig</command> command.</para>
+
+ <screen>$ dsconfig
+ create-local-db-vlv-index
+ --port 4444
+ --hostname `hostname`
+ --bindDn "cn=Directory Manager"
+ --bindPassword password
+ --backend-name userRoot
+ --index-name people-by-last-name
+ --set base-dn:ou=People,dc=example,dc=com
+ --set filter:"(|(givenName=*)(sn=*))"
+ --set scope:single-level
+ --set sort-order:"+sn +givenName"
+ --trustAll
+ --no-prompt</screen>
</section>
<section xml:id="rebuild-index">
@@ -287,8 +307,11 @@
</indexterm>
<para>After you change an index configuration, or when you find that
- an index is corrupt, you can rebuild the index. If you rebuild the index
- while the server is online, then you must schedule the rebuild process
+ an index is corrupt, you can rebuild the index. When you rebuild indexes,
+ you specify the base DN of the data to index, and either the list of indexes
+ to rebuild or <option>--rebuildAll</option>. You can rebuild indexes while
+ the server is offline, or while the server is online. If you rebuild the
+ index while the server is online, then you must schedule the rebuild process
as a task.</para>
<example xml:id="rebuild-index-example">
@@ -316,9 +339,6 @@
<secondary>Entry limits</secondary>
</indexterm>
- <para>Indexing data makes sense when maintaining the index is quicker and
- cheaper than searching through all entries.</para>
-
<para>As the number of entries in your directory grows, it can make sense
not to maintain indexes for particular values. For example, every entry
in the directory has the value <literal>top</literal> for the
@@ -375,6 +395,13 @@
-t 0
Rebuild Index task 20110607160349596 scheduled to start Jun 7, 2011 4:03:49 PM</screen>
</example>
+
+ <para>Alternatively, you can configure the index entry limit for all
+ indexes stored in a backend by using the <command>dsconfig
+ set-backend-prop</command> command with the <option>--backend-name
+ <replaceable>backendName</replaceable> --set
+ index-entry-limit:<replaceable>limitValue</replaceable></option>
+ options.</para>
</section>
</section>
@@ -414,6 +441,9 @@
[07/Jun/2011:16:06:51 +0200] category=JEB severity=INFORMATION
msgID=8388713 msg=Maximum number of entries referenced by any
record is 32</screen>
+
+ <para>Ignore the messages regarding lock tables and cleaner threads. The
+ important information is whether any errors are found in the indexes.</para>
</example>
</section>
--
Gitblit v1.10.0