<?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 legal-notices/CDDLv1_0.txt
|
! or http://forgerock.org/license/CDDLv1.0.html.
|
! 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 legal-notices/CDDLv1_0.txt.
|
! 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
|
!
|
!
|
! Copyright 2007-2008 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>
|
<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.
|
</adm:description>
|
<adm:tag name="database" />
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-local-db-vlv-index</ldap:name>
|
<ldap:superior>top</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:property name="base-dn" mandatory="true">
|
<adm:synopsis>
|
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 must be rebuilt after modifying this
|
property.
|
</adm:synopsis>
|
</adm:other>
|
</adm:requires-admin-action>
|
<adm:syntax>
|
<adm:dn />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-base-dn</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="scope" mandatory="true">
|
<adm:synopsis>
|
Specifies the LDAP scope of the query that is being indexed.
|
</adm:synopsis>
|
<adm:requires-admin-action>
|
<adm:other>
|
<adm:synopsis>
|
The index must be rebuilt after modifying this
|
property.
|
</adm:synopsis>
|
</adm:other>
|
</adm:requires-admin-action>
|
<adm:syntax>
|
<adm:enumeration>
|
<adm:value name="base-object">
|
<adm:synopsis>Search the base object only.</adm:synopsis>
|
</adm:value>
|
<adm:value name="single-level">
|
<adm:synopsis>
|
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 do not
|
include the base object itself.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="whole-subtree">
|
<adm:synopsis>
|
Search the base object and the entire subtree below the base
|
object.
|
</adm:synopsis>
|
</adm:value>
|
</adm:enumeration>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-scope</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="filter" mandatory="true">
|
<adm:synopsis>
|
Specifies the LDAP filter used in the query that is being indexed.
|
</adm:synopsis>
|
<adm:requires-admin-action>
|
<adm:other>
|
<adm:synopsis>
|
The index must be rebuilt after modifying this
|
property.
|
</adm:synopsis>
|
</adm:other>
|
</adm:requires-admin-action>
|
<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>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="sort-order" mandatory="true">
|
<adm:synopsis>
|
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 must be rebuilt after modifying this
|
property.
|
</adm:synopsis>
|
</adm:other>
|
</adm:requires-admin-action>
|
<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>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="name" mandatory="true" read-only="true">
|
<adm:synopsis>
|
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>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-name</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="max-block-size" read-only="true"
|
advanced="true">
|
<adm:synopsis>
|
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>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer>
|
<adm:unit-synopsis>Number of entry IDs</adm:unit-synopsis>
|
</adm:integer>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-max-block-size</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
