mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opends/src/admin/defn/org/opends/server/admin/std/LocalDBIndexConfiguration.xml
@@ -1,39 +1,39 @@ <?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 ! trunk/opends/resource/legal-notices/OpenDS.LICENSE ! or https://OpenDS.dev.java.net/OpenDS.LICENSE. ! 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 ! trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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 ! ! ! Portions Copyright 2007 Sun Microsystems, Inc. ! --> ! 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 ! trunk/opends/resource/legal-notices/OpenDS.LICENSE ! or https://OpenDS.dev.java.net/OpenDS.LICENSE. ! 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 ! trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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 ! ! ! Portions Copyright 2007 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. 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 @@ -47,16 +47,13 @@ <ldap:superior>top</ldap:superior> </ldap:object-class> </adm:profile> <adm:property name="attribute" mandatory="true" multi-valued="false" read-only="true"> <adm:property name="attribute" mandatory="true" read-only="true"> <adm:synopsis> This specifies the name of the attribute for which the index is to be maintained. This specifies the name of the attribute for which the index is to be maintained. </adm:synopsis> <adm:syntax> <adm:attribute-type/> <adm:attribute-type /> </adm:syntax> <adm:profile name="ldap"> <ldap:attribute> @@ -64,9 +61,7 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="index-entry-limit" mandatory="false" multi-valued="false"> <adm:property name="index-entry-limit"> <adm:synopsis> This specifies the maximum number of entries that will be allowed to match a given index key before that particular index key is no @@ -75,31 +70,26 @@ <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 backend-wide configuration. If any index keys have already reached this limit, indexes will need to be rebuilt before they will be allowed to use the new limit. For no limit, use 0 for the value. backend-wide configuration. For no limit, use 0 for the value. </adm:description> <adm:requires-admin-action> <adm:other> <adm:none> <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 new limit. will need to be rebuilt before they will be allowed to use the new limit. </adm:synopsis> </adm:other> </adm:none> </adm:requires-admin-action> <adm:default-behavior> <adm:inherited> <adm:relative property-name="index-entry-limit" offset="1" managed-object-name="local-db-backend" /> <adm:relative property-name="index-entry-limit" offset="1" managed-object-name="local-db-backend" /> </adm:inherited> </adm:default-behavior> <adm:syntax> <adm:integer lower-limit="0" upper-limit="2147483647"> <adm:unit-synopsis> Number of entries </adm:unit-synopsis> <adm:unit-synopsis>Number of entries</adm:unit-synopsis> </adm:integer> </adm:syntax> <adm:profile name="ldap"> @@ -108,12 +98,11 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="index-type" mandatory="true" multi-valued="true"> <adm:property name="index-type" mandatory="true" multi-valued="true"> <adm:synopsis> This specifies the type(s) of indexing that should be performed for the associated attribute. This specifies the type(s) of indexing that should be performed for the associated attribute. </adm:synopsis> <adm:description> For equality, presence, and substring index types, the associated @@ -133,33 +122,33 @@ <adm:enumeration> <adm:value name="equality"> <adm:synopsis> This index type will be used to help improve the efficiency of searches using equality search filters. This index type will be used to help 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 of searches using "greater than or equal to" or "less then or equal to" search filters. This index type will be used to help 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 of searches using the presence search filters. This index type will be used to help 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 of searches using substring search filters. This index type will be used to help 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 of searches using approximate matching search filters. This index type will be used to help improve the efficiency of searches using approximate matching search filters. </adm:synopsis> </adm:value> </adm:enumeration> @@ -170,17 +159,15 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="substring-length" mandatory="false" multi-valued="false"> <adm:property name="substring-length" advanced="true"> <adm:synopsis> The length of substrings in a substring index. </adm:synopsis> <adm:requires-admin-action> <adm:other> <adm:synopsis> The index will need to be rebuilt before it will reflect the new value. The index will need to be rebuilt before it will reflect the new value. </adm:synopsis> </adm:other> </adm:requires-admin-action>
