mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git
opends/src/admin/defn/org/opends/server/admin/std/LocalDBVLVIndexConfiguration.xml
@@ -1,45 +1,46 @@ <?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. ! --> <adm:managed-object name="local-db-vlv-index" plural-name="local-db-vlv-indexes" ! 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-vlv-index" plural-name="local-db-vlv-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 about a specific search request that makes it possible to efficiently process them using the VLV control. 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. </adm:synopsis> <adm:description> A VLV index effectively notifies the server that a virtual list view, with specific query and sort parameters, will be performed. This index also allows the server to collect and maintain the information required to make using the virtual list view faster. A VLV index effectively notifies the server that a virtual list view, with specific query and sort parameters, will be performed. This index also allows the server to collect and maintain the information required to make using the virtual list view faster. </adm:description> <adm:tag name="database" /> <adm:profile name="ldap"> @@ -48,9 +49,7 @@ <ldap:superior>top</ldap:superior> </ldap:object-class> </adm:profile> <adm:property name="base-dn" mandatory="true" multi-valued="false"> <adm:property name="base-dn" mandatory="true"> <adm:synopsis> This specifies the base DN used in the search query being indexed. </adm:synopsis> @@ -63,7 +62,7 @@ </adm:other> </adm:requires-admin-action> <adm:syntax> <adm:dn/> <adm:dn /> </adm:syntax> <adm:profile name="ldap"> <ldap:attribute> @@ -71,9 +70,7 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="scope" mandatory="true" multi-valued="false"> <adm:property name="scope" mandatory="true"> <adm:synopsis> This specifies the LDAP scope of the query being indexed. </adm:synopsis> @@ -88,9 +85,7 @@ <adm:syntax> <adm:enumeration> <adm:value name="base-object"> <adm:synopsis> Search the base object only. </adm:synopsis> <adm:synopsis>Search the base object only.</adm:synopsis> </adm:value> <adm:value name="single-level"> <adm:synopsis> @@ -100,8 +95,8 @@ </adm:value> <adm:value name="subordinate-subtree"> <adm:synopsis> Search the entire subtree below the base object but not include the base object itself. Search the entire subtree below the base object but not include the base object itself. </adm:synopsis> </adm:value> <adm:value name="whole-subtree"> @@ -114,13 +109,11 @@ </adm:syntax> <adm:profile name="ldap"> <ldap:attribute> <ldap:name>ds-cfg-scope </ldap:name> <ldap:name>ds-cfg-scope</ldap:name> </ldap:attribute> </adm:profile> </adm:property> <adm:property name="filter" mandatory="true" multi-valued="false"> <adm:property name="filter" mandatory="true"> <adm:synopsis> This specifies the LDAP filter used in the query being indexed. </adm:synopsis> @@ -141,17 +134,15 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="sort-order" mandatory="true" multi-valued="false"> <adm:property name="sort-order" mandatory="true"> <adm:synopsis> This specifies the names of attributes to sort the entries for the query being indexed. This specifies the names of attributes to sort the entries for the query 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 will need to be rebuilt after this modifying this property. </adm:synopsis> </adm:other> @@ -165,10 +156,7 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="name" mandatory="true" multi-valued="false" read-only="true"> <adm:property name="name" mandatory="true" read-only="true"> <adm:synopsis> This specifies a unique name for this VLV index. </adm:synopsis> @@ -181,26 +169,20 @@ </ldap:attribute> </adm:profile> </adm:property> <adm:property name="max-block-size" mandatory="false" multi-valued="false" read-only="true"> <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 set before it must be split. This specifies the number of entry IDs to store in a single sorted set before it must be split. </adm:synopsis> <adm:default-behavior> <adm:defined> <adm:value> 4000 </adm:value> <adm:value>4000</adm:value> </adm:defined> </adm:default-behavior> <adm:syntax> <adm:integer> <adm:unit-synopsis> Number of entry IDs </adm:unit-synopsis> <adm:unit-synopsis>Number of entry IDs</adm:unit-synopsis> </adm:integer> </adm:syntax> <adm:profile name="ldap">
