From 748f1de2c23e94d7a1138b3bcbf7eeffc9bafc3b Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 20 Feb 2015 13:25:03 +0000
Subject: [PATCH] CR-6143 OPENDJ-1746 Update doc for alternative backends
---
opendj-server-legacy/src/main/docbkx/admin-guide/chap-monitoring.xml | 8
opendj-server-legacy/src/main/docbkx/release-notes/chap-whats-new.xml | 28 +++
opendj-server-legacy/src/main/docbkx/reference/appendix-file-layout.xml | 2
opendj-server-legacy/src/main/docbkx/admin-guide/chap-server-process.xml | 15
opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml | 20 +-
opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml | 18 +-
opendj-server-legacy/src/main/docbkx/admin-guide/chap-backup-restore.xml | 19 -
opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml | 19 +-
opendj-server-legacy/src/main/docbkx/shared/informalexample-default-indexes.xml | 54 ++++++
opendj-server-legacy/src/main/docbkx/admin-guide/chap-indexing.xml | 155 ++++++++++++++--
opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml | 61 +++---
opendj-server-legacy/src/messages/org/opends/messages/tool.properties | 7
opendj-server-legacy/src/main/docbkx/admin-guide/chap-admin-tools.xml | 8
opendj-server-legacy/src/main/docbkx/admin-guide/chap-import-export.xml | 71 +++++++
14 files changed, 369 insertions(+), 116 deletions(-)
diff --git a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-admin-tools.xml
index 3ff3e70..7b8d880 100644
--- a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -269,7 +269,7 @@
<term><link xlink:href="reference#dbtest-1"
xlink:role="http://docbook.org/xlink/role/olink">dbtest</link></term>
<listitem>
- <para>Debug JE databases.</para>
+ <para>Debug databases for <literal>local-db</literal> backends.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -287,7 +287,7 @@
<para>You can prepare <command>dsconfig</command> batch scripts by running
the tool with the <option>--commandFilePath</option> option in interactive
mode, then reading from the batch file with the
- <option>--batchFile</option> option in script mode. Batch files can be
+ <option>--batchFilePath</option> option in script mode. Batch files can be
useful when you have many <command>dsconfig</command> commands to run
and want to avoid starting the JVM and setting up a new connection for
each command.</para>
@@ -444,7 +444,7 @@
<term><link xlink:href="reference#rebuild-index-1"
xlink:role="http://docbook.org/xlink/role/olink">rebuild-index</link></term>
<listitem>
- <para>Rebuild an index stored in a JE backend.</para>
+ <para>Rebuild an index stored in an indexed backend.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -479,7 +479,7 @@
<term><link xlink:href="reference#verify-index-1"
xlink:role="http://docbook.org/xlink/role/olink">verify-index</link></term>
<listitem>
- <para>Verify that an index stored in a JE backend is not corrupt.</para>
+ <para>Verify that an index stored in an indexed backend is not corrupt.</para>
</listitem>
</varlistentry>
<varlistentry>
diff --git a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-backup-restore.xml b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-backup-restore.xml
index 6d14bf4..b615891 100644
--- a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-backup-restore.xml
+++ b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-backup-restore.xml
@@ -24,11 +24,11 @@
!
-->
<chapter xml:id='chap-backup-restore'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Backing Up & Restoring Data</title>
<para>OpenDJ lets you backup and restore your data either in compressed,
@@ -131,8 +131,7 @@
$ backup --backendID userRoot -d /path/to/opendj/bak
[13/Jun/2011:14:33:48 +0200] category=TOOLS severity=NOTICE msgID=10944792
msg=Starting backup for backend userRoot
-[13/Jun/2011:14:33:48 +0200] category=JEB severity=NOTICE msgID=8847446
- msg=Archived: 00000000.jdb
+...
[13/Jun/2011:14:33:48 +0200] category=TOOLS severity=NOTICE msgID=10944795
msg=The backup process completed successfully</computeroutput>
$ <userinput>start-ds</userinput>
@@ -278,8 +277,7 @@
Has Signed Hash: false
Dependent Upon: none</computeroutput>
$ <userinput>restore --backupDirectory /path/to/opendj/bak --backupID 20110613080032</userinput>
-<computeroutput>[13/Jun/2011:15:47:41 +0200] category=JEB severity=NOTICE msgID=8847445
- msg=Restored: 00000000.jdb (size 341835)</computeroutput>
+<computeroutput>[13/Jun/2011:15:47:41 +0200] ... msg=Restored: 00000000.jdb (size 341835)</computeroutput>
$ <userinput>start-ds</userinput>
<computeroutput>... The Directory Server has started successfully</computeroutput>
</screen>
@@ -359,8 +357,7 @@
Has Signed Hash: false
Dependent Upon: none</computeroutput>
$ <userinput>restore --backupDirectory /path/to/opendj/bak --backupID 20110613080032</userinput>
-<computeroutput>[13/Jun/2011:15:47:41 +0200] category=JEB severity=NOTICE msgID=8847445
- msg=Restored: 00000000.jdb (size 341835)</computeroutput>
+<computeroutput>[13/Jun/2011:15:47:41 +0200] ... msg=Restored: 00000000.jdb (size 341835)</computeroutput>
$ <userinput>start-ds</userinput>
<computeroutput>... The Directory Server has started successfully</computeroutput>
</screen>
diff --git a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-import-export.xml b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-import-export.xml
index 28c1a5f..71cd1bf 100644
--- a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-import-export.xml
+++ b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-import-export.xml
@@ -24,11 +24,12 @@
!
-->
<chapter xml:id='chap-import-export'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Importing & Exporting LDIF Data</title>
<indexterm><primary>Provisioning</primary></indexterm>
<indexterm><primary>Importing data</primary></indexterm>
@@ -163,7 +164,7 @@
<step performance="optional">
<para>If you do not want to use the default <literal>userRoot</literal>
- backend, create a new JE backend for your data.</para>
+ backend, create a new backend for your data.</para>
<para>See <xref linkend="create-database-backend" /> for details.</para>
</step>
<step>
@@ -383,6 +384,14 @@
xlink:href="reference#dsconfig-create-backend"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig create-backend</command></link> command.
+ OpenDJ directory server supports a variety of backend types,
+ including in-memory backends, backends that store data in LDIF files,
+ and backends that store data in key-value databases
+ with indexes to improve performance with large data sets.
+ When you create a backend, choose the type of backend that fits your purpose.
+ </para>
+
+ <para>
The following example creates a local backend named <literal>testData</literal>.
</para>
@@ -452,6 +461,56 @@
<para>Alternatively, you can create a new backend in OpenDJ Control Panel
(Directory Data > New Base DN > Backend > New Backend:
<replaceable>backend-name</replaceable>).</para>
+
+ <para>
+ The following example creates a <literal>persistit</literal> backend,
+ which relies on a Persistit database for data storage and indexing.
+ </para>
+
+ <screen>
+$ <userinput>dsconfig \
+ create-backend \
+ --hostname opendj.example.com \
+ --port 4444 \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --type persistit \
+ --backend-name myData \
+ --set base-dn:dc=example,dc=net \
+ --set enabled:true \
+ --trustAll \
+ --no-prompt</userinput>
+ </screen>
+
+ <para>
+ After creating the backend, you can view the settings
+ as in the following example.
+ </para>
+
+ <screen>
+$ <userinput>dsconfig \
+ get-backend-prop \
+ --hostname opendj.example.com \
+ --port 4444 \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --backend-name myData \
+ --trustAll \
+ --no-prompt</userinput>
+<computeroutput>Property : Value(s)
+------------------:--------------------
+backend-id : myData
+base-dn : "dc=example,dc=net"
+compact-encoding : true
+db-cache-percent : 50
+db-cache-size : 0 b
+db-directory : db
+enabled : true
+index-entry-limit : 4000
+writability-mode : enabled</computeroutput>
+ </screen>
+
+ <xinclude:include href="../shared/informalexample-default-indexes.xml" />
</section>
<section xml:id="set-database-backend-disk-thresholds">
diff --git a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-indexing.xml b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-indexing.xml
index 245a69d..ff4f541 100644
--- a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-indexing.xml
+++ b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-indexing.xml
@@ -24,11 +24,12 @@
!
-->
<chapter xml:id='chap-indexing'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Indexing Attribute Values</title>
<indexterm>
<primary>Indexes</primary>
@@ -392,6 +393,8 @@
xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command.
+ The subcommands to use depend on the backend type,
+ as shown in the examples that follow.
The configuration changes then take effect
after you rebuild the index according to the new configuration, using the
<link
@@ -420,8 +423,11 @@
<example xml:id="create-index-example">
<title>Create a New Index</title>
- <para>The following example creates a new substring index for
- <literal>description</literal>.</para>
+ <para>
+ The following example creates a new substring index
+ for the <literal>description</literal> attribute
+ in a backend of type <literal>local-db</literal>.
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -436,6 +442,27 @@
--trustAll \
--no-prompt</userinput>
</screen>
+
+ <para>
+ The following example creates a new equality index
+ for the <literal>cn</literal> (common name) attribute
+ in a backend of type <literal>persistit</literal>
+ named <literal>myData</literal>.
+ </para>
+
+ <screen>
+$ <userinput>dsconfig \
+ create-backend-index \
+ --port 4444 \
+ --hostname opendj.example.com \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --backend-name myData \
+ --index-name cn \
+ --set index-type:equality \
+ --trustAll \
+ --no-prompt</userinput>
+ </screen>
</example>
<example xml:id="approx-index-example">
@@ -444,9 +471,12 @@
<primary>Indexes</primary>
<secondary>Approximate</secondary>
</indexterm>
-
- <para>The following example configures an approximate index for
- <literal>cn</literal> (common name).</para>
+
+ <para>
+ The following example configures an approximate index for
+ the <literal>cn</literal> (common name) attribute
+ in a backend of type <literal>local-db</literal>.
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -461,6 +491,27 @@
--trustAll \
--no-prompt</userinput>
</screen>
+
+ <para>
+ The following example configures an approximate index for
+ the <literal>cn</literal> (common name) attribute
+ in a backend of type <literal>persistit</literal>
+ named <literal>myData</literal>.
+ </para>
+
+ <screen>
+$ <userinput>dsconfig \
+ set-backend-index-prop \
+ --port 4444 \
+ --hostname opendj.example.com \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --backend-name myData \
+ --index-name cn \
+ --set index-type:approximate \
+ --trustAll \
+ --no-prompt</userinput>
+ </screen>
</example>
<example xml:id="extensible-match-index-example">
@@ -474,9 +525,12 @@
extensible matching rule indexes. Use the <command>dsconfig</command>
command instead.</para>
- <para>The following example configures an extensible matching rule
- index for "later than" and "earlier than" generalized time matching on
- a <literal>lastLoginTime</literal> attribute.</para>
+ <para>
+ The following example configures an extensible matching rule index
+ for "later than" and "earlier than" generalized time matching
+ on a <literal>lastLoginTime</literal> attribute
+ in a backend of type <literal>local-db</literal>.
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -493,6 +547,30 @@
--trustAll \
--no-prompt</userinput>
</screen>
+
+ <para>
+ The following example configures an extensible matching rule index
+ for "later than" and "earlier than" generalized time matching
+ on a <literal>lastLoginTime</literal> attribute
+ in a backend of type <literal>persistit</literal>
+ named <literal>myData</literal>.
+ </para>
+
+ <screen>
+$ <userinput>dsconfig \
+ create-backend-index \
+ --port 4444 \
+ --hostname opendj.example.com \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --backend-name myData \
+ --set index-type:extensible \
+ --set index-extensible-matching-rule:1.3.6.1.4.1.26027.1.4.5 \
+ --set index-extensible-matching-rule:1.3.6.1.4.1.26027.1.4.6 \
+ --index-name lastLoginTime \
+ --trustAll \
+ --no-prompt</userinput>
+ </screen>
</example>
</section>
@@ -523,8 +601,12 @@
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>
+ <para>
+ You can also create the equivalent index configuration
+ by using the <command>dsconfig</command> command.
+ The following example shows how to create the VLV index
+ for a backend of type <literal>local-db</literal>.
+ </para>
<screen>
$ <userinput>dsconfig \
@@ -551,6 +633,29 @@
changing index properties such as the index entry limit, or verifying
indexes.</para>
</note>
+
+ <para>
+ The following example shows how to create the VLV index
+ for a backend of type <literal>persistit</literal>
+ named <literal>myData</literal> serving <literal>dc=example,dc=net</literal>.
+ </para>
+
+ <screen>
+$ <userinput>dsconfig \
+ create-backend-vlv-index \
+ --port 4444 \
+ --hostname opendj.example.com \
+ --bindDn "cn=Directory Manager" \
+ --bindPassword password \
+ --backend-name myData \
+ --index-name people-by-last-name \
+ --set base-dn:ou=People,dc=example,dc=net \
+ --set filter:"(|(givenName=*)(sn=*))" \
+ --set scope:single-level \
+ --set sort-order:"+sn +givenName" \
+ --trustAll \
+ --no-prompt</userinput>
+ </screen>
</section>
<section xml:id="rebuild-index">
@@ -582,8 +687,9 @@
--bindPassword password \
--baseDN dc=example,dc=com \
--index cn \
- --start 0</userinput>
-<computeroutput>Rebuild Index task 20110607171639867 scheduled to start Jun 7, 2011 5:16:39 PM</computeroutput>
+ --start 0 \
+ --trustAll</userinput>
+<computeroutput>Rebuild Index task 20150219181540575 scheduled to start Feb 19, 2015 6:15:40</computeroutput>
</screen>
</example>
@@ -798,6 +904,14 @@
production.</para>
</important>
+ <para>
+ The following example uses
+ the <command>dsconfig set-local-db-index-prop</command> command,
+ and works with a backend of type <literal>local-db</literal>.
+ For other indexed backend types, use
+ the <command>dsconfig set-backend-index-prop</command> command.
+ </para>
+
<screen>
$ <userinput>dsconfig \
set-local-db-index-prop \
@@ -1049,11 +1163,6 @@
</tgroup>
</table>
- <para>When you create a JE backend using the <command>dsconfig</command>
- command, OpenDJ creates the <literal>aci</literal> presence,
- <literal>ds-sync-conflict</literal> equality,
- <literal>ds-sync-hist</literal> ordering,
- <literal>entryUUID</literal> equality, and
- <literal>objectClass</literal> equality indexes automatically.</para>
+ <xinclude:include href="../shared/informalexample-default-indexes.xml" />
</section>
</chapter>
diff --git a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-monitoring.xml b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-monitoring.xml
index 27a789e..6315c7c 100644
--- a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-monitoring.xml
+++ b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-monitoring.xml
@@ -879,6 +879,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <!-- The typo is in the code. See ServerConstants.java. -->
<term><literal>org.opends.server.authentiation.dseecompat.ACIParseFailed</literal></term>
<listitem>
<para>The dseecompat access control subsystem failed to correctly parse
@@ -888,8 +889,11 @@
<varlistentry>
<term><literal>org.opends.server.BackendRunRecovery</literal></term>
<listitem>
- <para>The JE backend has thrown a <literal>RunRecoveryException</literal>.
- The directory server needs to be restarted.</para>
+ <para>
+ The <literal>local-db</literal> backend has thrown
+ a <literal>RunRecoveryException</literal>.
+ The directory server needs to be restarted.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
diff --git a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-server-process.xml b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-server-process.xml
index 2de5e66..8102ee4 100644
--- a/opendj-server-legacy/src/main/docbkx/admin-guide/chap-server-process.xml
+++ b/opendj-server-legacy/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -24,11 +24,11 @@
!
-->
<chapter xml:id='chap-server-process'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Managing Server Processes</title>
<para>Using the OpenDJ Control Panel, you can start and stop local servers.
You can also start and stop OpenDJ using command-line tools, and use the
@@ -295,9 +295,8 @@
<para>What can take some time during server startup is preloading database
content into memory when the server starts. Objects cached in memory do not
survive a crash. By default, OpenDJ does not cache objects in memory before
- starting to accept client requests. You can however set a
- <link xlink:href="${configRefBase}local-db-backend.html#preload-time-limit"
- ><literal>preload-time-limit</literal></link> for the database cache of your
+ starting to accept client requests. You can however set the
+ <literal>preload-time-limit</literal> property for the database cache of your
backend if you do want to load objects into the database cache before
OpenDJ begins accepting client connections.</para>
</section>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/appendix-file-layout.xml b/opendj-server-legacy/src/main/docbkx/reference/appendix-file-layout.xml
index 88ead47..7c8d49a 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/appendix-file-layout.xml
+++ b/opendj-server-legacy/src/main/docbkx/reference/appendix-file-layout.xml
@@ -164,7 +164,7 @@
<term><filename>db</filename></term>
<listitem>
<para>
- Backend database files for backends that hold user data
+ Backend database files for persistent, indexed backends that hold user data
</para>
</listitem>
</varlistentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml b/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml
index 462d686..75d15f6 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml
+++ b/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml
@@ -24,11 +24,11 @@
!
-->
<refentry xml:id='dbtest-1'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'>
<info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>dbtest</refentrytitle><manvolnum>1</manvolnum>
@@ -37,7 +37,7 @@
</refmeta>
<refnamediv>
<refname>dbtest</refname>
- <refpurpose>gather OpenDJ JE database debugging information</refpurpose>
+ <refpurpose>gather <literal>local-db</literal> backend database debug info</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
@@ -46,7 +46,7 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>This utility can be used to debug the JE database.</para>
+ <para>This utility can be used to debug a <literal>local-db</literal> backend database.</para>
</refsect1>
<refsect1>
<title>Subcommands</title>
@@ -125,7 +125,7 @@
<term>JE Database Name</term>
<listitem>
<para>
- Name of the Berkeley Java Edition database,
+ Name of the <literal>local-db</literal> database,
which reflects how OpenDJ directory server
organizes the data in the database.
</para>
@@ -207,7 +207,7 @@
<varlistentry>
<term><command>dbtest list-root-containers</command></term>
<listitem>
- <para>List the root containers used by all JE backends</para>
+ <para>List the root containers used by all <literal>local-db</literal> backends</para>
</listitem>
</varlistentry>
</variablelist>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml b/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml
index e468721..21756bf 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml
+++ b/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml
@@ -9,8 +9,7 @@
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
- ! You can also obtain a copy of the license at
- ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
+ ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
! See the License for the specific language governing permissions
! and limitations under the License.
!
@@ -20,17 +19,17 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='dsconfig-1'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'>
+ <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>dsconfig</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -5529,26 +5528,28 @@
What do you want to configure?
- 1) Access Control Handler 21) Log Publisher
- 2) Access Log Filtering Criteria 22) Log Retention Policy
- 3) Account Status Notification Handler 23) Log Rotation Policy
- 4) Administration Connector 24) Matching Rule
- 5) Alert Handler 25) Monitor Provider
- 6) Attribute Syntax 26) Password Generator
- 7) Backend 27) Password Policy
- 8) Certificate Mapper 28) Password Storage Scheme
- 9) Connection Handler 29) Password Validator
- 10) Crypto Manager 30) Plugin
- 11) Debug Target 31) Plugin Root
- 12) Entry Cache 32) Replication Domain
- 13) Extended Operation Handler 33) Replication Server
- 14) External Changelog Domain 34) Root DN
- 15) Global Configuration 35) Root DSE Backend
- 16) Group Implementation 36) SASL Mechanism Handler
- 17) Identity Mapper 37) Synchronization Provider
- 18) Key Manager Provider 38) Trust Manager Provider
- 19) Local DB Index 39) Virtual Attribute
- 20) Local DB VLV Index 40) Work Queue
+ 1) Access Control Handler 23) Log Publisher
+ 2) Access Log Filtering Criteria 24) Log Retention Policy
+ 3) Account Status Notification Handler 25) Log Rotation Policy
+ 4) Administration Connector 26) Matching Rule
+ 5) Alert Handler 27) Monitor Provider
+ 6) Attribute Syntax 28) Password Generator
+ 7) Backend 29) Password Policy
+ 8) Backend Index 30) Password Storage Scheme
+ 9) Backend VLV Index 31) Password Validator
+ 10) Certificate Mapper 32) Plugin
+ 11) Connection Handler 33) Plugin Root
+ 12) Crypto Manager 34) Replication Domain
+ 13) Debug Target 35) Replication Server
+ 14) Entry Cache 36) Root DN
+ 15) Extended Operation Handler 37) Root DSE Backend
+ 16) External Changelog Domain 38) SASL Mechanism Handler
+ 17) Global Configuration 39) Schema Provider
+ 18) Group Implementation 40) Synchronization Provider
+ 19) Identity Mapper 41) Trust Manager Provider
+ 20) Key Manager Provider 42) Virtual Attribute
+ 21) Local DB Index 43) Work Queue
+ 22) Local DB VLV Index
q) quit
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml b/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml
index f863532..e8de653 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml
+++ b/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml
@@ -20,16 +20,16 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='rebuild-index-1'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'>
+ <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>rebuild-index</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -47,8 +47,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>This utility can be used to rebuild index data within a backend based
- on the Berkeley DB Java Edition.</para>
+ <para>
+ This utility can be used to rebuild index data within an indexed backend database.
+ </para>
</refsect1>
<refsect1>
<title>Options</title>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml b/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml
index 92df2dc..7c7d670 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml
+++ b/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml
@@ -20,16 +20,16 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='verify-index-1'
- 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
- http://docbook.org/xml/5.0/xsd/docbook.xsd'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
+ 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'>
+ <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>verify-index</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -47,8 +47,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>This utility can be used to ensure that index data is consistent
- within a backend based on the Berkeley DB Java Edition.</para>
+ <para>
+ This utility can be used to ensure that index data is consistent
+ within an indexed backend database.
+ </para>
</refsect1>
<refsect1>
<title>Options</title>
diff --git a/opendj-server-legacy/src/main/docbkx/release-notes/chap-whats-new.xml b/opendj-server-legacy/src/main/docbkx/release-notes/chap-whats-new.xml
index 86bcd35..323fcfb 100644
--- a/opendj-server-legacy/src/main/docbkx/release-notes/chap-whats-new.xml
+++ b/opendj-server-legacy/src/main/docbkx/release-notes/chap-whats-new.xml
@@ -42,6 +42,34 @@
<listitem>
<para>
+ OpenDJ directory server now provides alternative backend types
+ for backends that use embedded databases for storage
+ (<link
+ xlink:show="new"
+ xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-1602"
+ >OPENDJ-1602</link>).
+ </para>
+
+ <para>
+ Alternative backend types continue to provide
+ the same high-performance full LDAPv3 compliance
+ and the same ease of use as previous choices.
+ </para>
+
+ <para>
+ If you do choose to make the change to a new backend type,
+ note that you must import the data again into the new backend.
+ This is necessary because
+ you are effectively changing underlying storage implementations.
+ You can make the move for example by exporting LDIF from the old backend
+ and then importing the LDIF into the new backend,
+ or simply through OpenDJ replication
+ by initializing a server using the new backend from an existing replica.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
OpenDJ directory server now requires a privilege,
<literal>changelog-read</literal> to read and search entries
under <literal>cn=changelog</literal>
diff --git a/opendj-server-legacy/src/main/docbkx/shared/informalexample-default-indexes.xml b/opendj-server-legacy/src/main/docbkx/shared/informalexample-default-indexes.xml
new file mode 100644
index 0000000..a27bd7b
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/shared/informalexample-default-indexes.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<informalexample 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
+ http://docbook.org/xml/5.0/xsd/docbook.xsd"
+ xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <!-- If we fix https://bugster.forgerock.org/jira/browse/OPENDJ-1838,
+ then we can remove this where it is used. -->
+
+ <para>
+ When you create a new backend using the <command>dsconfig</command> command,
+ OpenDJ creates the following indexes automatically:
+ </para>
+
+ <simplelist>
+ <member><literal>aci</literal> presence</member>
+ <member><literal>ds-sync-conflict</literal> equality</member>
+ <member><literal>ds-sync-hist</literal> ordering</member>
+ <member><literal>entryUUID</literal> equality</member>
+ <member><literal>objectClass</literal> equality</member>
+ </simplelist>
+
+ <para>
+ You can create additional indexes as described in
+ <link
+ xlink:href="admin-guide#configure-indexes"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ xlink:show="new"
+ ><citetitle>Configuring & Rebuilding Indexes</citetitle></link>.
+ </para>
+</informalexample>
diff --git a/opendj-server-legacy/src/messages/org/opends/messages/tool.properties b/opendj-server-legacy/src/messages/org/opends/messages/tool.properties
index c468df2..45299f6 100644
--- a/opendj-server-legacy/src/messages/org/opends/messages/tool.properties
+++ b/opendj-server-legacy/src/messages/org/opends/messages/tool.properties
@@ -1241,8 +1241,7 @@
this utility connects to the OpenDJ administration port and \
creates a shutdown task to stop the server
INFO_VERIFYINDEX_TOOL_DESCRIPTION_700=This utility can be used to ensure that \
- index data is consistent within a backend based on the Berkeley DB Java \
- Edition
+ index data is consistent within an indexed backend database
INFO_WAIT4DEL_TOOL_DESCRIPTION_701=This utility can be used to wait for a \
file to be removed from the filesystem
ERR_TOOL_CONFLICTING_ARGS_702=You may not provide both the --%s and \
@@ -1457,7 +1456,7 @@
ERR_WINDOWS_SERVICE_CLEANUP_ERROR_848=An unexpected error occurred \
cleaning up the service %s
INFO_REBUILDINDEX_TOOL_DESCRIPTION_849=This utility can be used to rebuild \
- index data within a backend based on the Berkeley DB Java Edition
+ index data within an indexed backend database
INFO_REBUILDINDEX_DESCRIPTION_BASE_DN_850=Base DN of a backend \
supporting indexing. Rebuild is performed on indexes within the scope of the \
given base DN
@@ -2659,7 +2658,7 @@
<term>JE Database Name</term> \
<listitem> \
<para> \
- Name of the Berkeley Java Edition database, \
+ Name of the <literal>local-db</literal> backend database, \
which reflects how OpenDJ directory server \
organizes the data in the database. \
</para> \
--
Gitblit v1.10.0