From 1f52b83f06af5eed61157d4ecfb0d6165a968335 Mon Sep 17 00:00:00 2001
From: lfrost <lfrost@localhost>
Date: Tue, 29 Jan 2008 07:18:09 +0000
Subject: [PATCH] Doc changes to Index Configuration docs and some copyright changes. Thanks to Daniel for the review.
---
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBVLVIndexConfiguration.xml | 78 +++++++++++++++++++++++++++++----------
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBIndexConfiguration.xml | 37 +++++++++---------
2 files changed, 76 insertions(+), 39 deletions(-)
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBIndexConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBIndexConfiguration.xml
index ecb64ac..3cca982 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBIndexConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBIndexConfiguration.xml
@@ -23,21 +23,20 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="local-db-index" plural-name="local-db-indexes"
package="org.opends.server.admin.std"
xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
- The
<adm:user-friendly-plural-name />
are used to store information that makes it possible to locate
entries very quickly when processing search operations.
</adm:synopsis>
<adm:description>
Indexing is performed on a per-attribute level and different types
- of indexing may be performed for different kinds of attributes based
+ of indexing may be performed for different kinds of attributes, based
on how they are expected to be accessed during search operations.
</adm:description>
<adm:tag name="database" />
@@ -49,7 +48,7 @@
</adm:profile>
<adm:property name="attribute" mandatory="true" read-only="true">
<adm:synopsis>
- This specifies the name of the attribute for which the index is to
+ Specifies the name of the attribute for which the index is to
be maintained.
</adm:synopsis>
<adm:syntax>
@@ -63,23 +62,23 @@
</adm:property>
<adm:property name="index-entry-limit">
<adm:synopsis>
- This specifies the maximum number of entries that will be allowed
+ Specifies the maximum number of entries that are allowed
to match a given index key before that particular index key is no
longer maintained.
</adm:synopsis>
<adm:description>
This is analogous to the ALL IDs threshold in the Sun Java System
- Directory Server. If this is specified, it will override the JE
+ Directory Server. If this is specified, its value overrides the JE
backend-wide configuration. For no limit, use 0 for the value.
</adm:description>
<adm:requires-admin-action>
- <adm:none>
+ <adm:other>
<adm:synopsis>
If any index keys have already reached this limit, indexes
- will need to be rebuilt before they will be allowed to use the
+ must be rebuilt before they will be allowed to use the
new limit.
</adm:synopsis>
- </adm:none>
+ </adm:other>
</adm:requires-admin-action>
<adm:default-behavior>
<adm:inherited>
@@ -101,7 +100,7 @@
<adm:property name="index-type" mandatory="true"
multi-valued="true">
<adm:synopsis>
- This specifies the type(s) of indexing that should be performed
+ Specifies the type(s) of indexing that should be performed
for the associated attribute.
</adm:synopsis>
<adm:description>
@@ -111,9 +110,9 @@
<adm:requires-admin-action>
<adm:other>
<adm:synopsis>
- If any new index types are added for an attribute and there
- are values for that attribute which already exist in the
- database, then the index will need to be rebuilt before it
+ If any new index types are added for an attribute, and
+ values for that attribute already exist in the
+ database, the index must be rebuilt before it
will be accurate.
</adm:synopsis>
</adm:other>
@@ -122,32 +121,32 @@
<adm:enumeration>
<adm:value name="equality">
<adm:synopsis>
- This index type will be used to help improve the efficiency
+ This index type is used to improve the efficiency
of searches using equality search filters.
</adm:synopsis>
</adm:value>
<adm:value name="ordering">
<adm:synopsis>
- This index type will be used to help improve the efficiency
+ This index type is used to improve the efficiency
of searches using "greater than or equal to" or "less then
or equal to" search filters.
</adm:synopsis>
</adm:value>
<adm:value name="presence">
<adm:synopsis>
- This index type will be used to help improve the efficiency
+ This index type is used to improve the efficiency
of searches using the presence search filters.
</adm:synopsis>
</adm:value>
<adm:value name="substring">
<adm:synopsis>
- This index type will be used to help improve the efficiency
+ This index type is used to improve the efficiency
of searches using substring search filters.
</adm:synopsis>
</adm:value>
<adm:value name="approximate">
<adm:synopsis>
- This index type will be used to help improve the efficiency
+ This index type is used to improve the efficiency
of searches using approximate matching search filters.
</adm:synopsis>
</adm:value>
@@ -166,7 +165,7 @@
<adm:requires-admin-action>
<adm:other>
<adm:synopsis>
- The index will need to be rebuilt before it will reflect the
+ The index must be rebuilt before it will reflect the
new value.
</adm:synopsis>
</adm:other>
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBVLVIndexConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBVLVIndexConfiguration.xml
index aa146ba..714399d 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBVLVIndexConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LocalDBVLVIndexConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="local-db-vlv-index"
plural-name="local-db-vlv-indexes"
@@ -31,7 +31,6 @@
xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
- The
<adm:user-friendly-plural-name />
are used to store information about a specific search request that
makes it possible to efficiently process them using the VLV control.
@@ -51,12 +50,13 @@
</adm:profile>
<adm:property name="base-dn" mandatory="true">
<adm:synopsis>
- This specifies the base DN used in the search query being indexed.
+ Specifies the base DN used in the search query that is being
+ indexed.
</adm:synopsis>
<adm:requires-admin-action>
<adm:other>
<adm:synopsis>
- The index will need to be rebuilt after this modifying this
+ The index must be rebuilt after modifying this
property.
</adm:synopsis>
</adm:other>
@@ -72,12 +72,12 @@
</adm:property>
<adm:property name="scope" mandatory="true">
<adm:synopsis>
- This specifies the LDAP scope of the query being indexed.
+ Specifies the LDAP scope of the query that is being indexed.
</adm:synopsis>
<adm:requires-admin-action>
<adm:other>
<adm:synopsis>
- The index will need to be rebuilt after this modifying this
+ The index must be rebuilt after modifying this
property.
</adm:synopsis>
</adm:other>
@@ -89,13 +89,13 @@
</adm:value>
<adm:value name="single-level">
<adm:synopsis>
- Search immediate children of the base object but not include
- any of their descendants and the base object itself.
+ Search the immediate children of the base object but do not
+ include any of their descendants or the base object itself.
</adm:synopsis>
</adm:value>
<adm:value name="subordinate-subtree">
<adm:synopsis>
- Search the entire subtree below the base object but not
+ Search the entire subtree below the base object but do not
include the base object itself.
</adm:synopsis>
</adm:value>
@@ -115,19 +115,27 @@
</adm:property>
<adm:property name="filter" mandatory="true">
<adm:synopsis>
- This specifies the LDAP filter used in the query being indexed.
+ Specifies the LDAP filter used in the query that is being indexed.
</adm:synopsis>
<adm:requires-admin-action>
<adm:other>
<adm:synopsis>
- The index will need to be rebuilt after this modifying this
+ The index must be rebuilt after modifying this
property.
</adm:synopsis>
</adm:other>
</adm:requires-admin-action>
<adm:syntax>
- <adm:string />
- </adm:syntax>
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ A valid LDAP search filter.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
+ </adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-filter</ldap:name>
@@ -136,20 +144,35 @@
</adm:property>
<adm:property name="sort-order" mandatory="true">
<adm:synopsis>
- This specifies the names of attributes to sort the entries for the
- query being indexed.
+ Specifies the names of the attributes that are used to sort the
+ entries for the query being indexed.
</adm:synopsis>
+ <adm:description>
+ Multiple attributes can be used to determine the sort order by
+ listing the attribute names from highest to lowest precedence.
+ Optionally, + or - can be prefixed to the attribute name to sort
+ the attribute in ascending order or descending order respectively.
+ </adm:description>
<adm:requires-admin-action>
<adm:other>
<adm:synopsis>
- The index will need to be rebuilt after this modifying this
+ The index must be rebuilt after modifying this
property.
</adm:synopsis>
</adm:other>
</adm:requires-admin-action>
<adm:syntax>
- <adm:string />
- </adm:syntax>
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>STRING</adm:usage>
+ <adm:synopsis>
+ Valid attribute types defined in the schema, separated by a
+ space and optionally prefixed by + or -.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
+ </adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-sort-order</ldap:name>
@@ -158,8 +181,15 @@
</adm:property>
<adm:property name="name" mandatory="true" read-only="true">
<adm:synopsis>
- This specifies a unique name for this VLV index.
+ Specifies a unique name for this VLV index.
</adm:synopsis>
+ <adm:requires-admin-action>
+ <adm:none>
+ <adm:synopsis>
+ The VLV index name cannot be altered after the index is created.
+ </adm:synopsis>
+ </adm:none>
+ </adm:requires-admin-action>
<adm:syntax>
<adm:string />
</adm:syntax>
@@ -172,9 +202,17 @@
<adm:property name="max-block-size" read-only="true"
advanced="true">
<adm:synopsis>
- This specifies the number of entry IDs to store in a single sorted
+ Specifies the number of entry IDs to store in a single sorted
set before it must be split.
</adm:synopsis>
+ <adm:requires-admin-action>
+ <adm:none>
+ <adm:synopsis>
+ The blocks are resized lazily the next time the index is
+ modified.
+ </adm:synopsis>
+ </adm:none>
+ </adm:requires-admin-action>
<adm:default-behavior>
<adm:defined>
<adm:value>4000</adm:value>
--
Gitblit v1.10.0