Backend VLV Index

Backend VLV Indexes are used to store information about a specific search request that makes it possible to efficiently process them using the VLV control.

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.

Dependencies

The following objects have Backend VLV Indexes:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

Advanced Properties

  • None

Basic Properties

base-dn

SynopsisSpecifies the base DN used in the search query that is being indexed.
Default ValueNone
Allowed ValuesA valid DN.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
The index must be rebuilt after modifying this property.
AdvancedNo
Read-OnlyNo

filter

SynopsisSpecifies the LDAP filter used in the query that is being indexed.
Default ValueNone
Allowed ValuesA valid LDAP search filter.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
The index must be rebuilt after modifying this property.
AdvancedNo
Read-OnlyNo

name

SynopsisSpecifies a unique name for this VLV index.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
The VLV index name cannot be altered after the index is created.
AdvancedNo
Read-OnlyYes

scope

SynopsisSpecifies the LDAP scope of the query that is being indexed.
Default ValueNone
Allowed Values

base-object: Search the base object only.

single-level: Search the immediate children of the base object but do not include any of their descendants or the base object itself.

subordinate-subtree: Search the entire subtree below the base object but do not include the base object itself.

whole-subtree: Search the base object and the entire subtree below the base object.

Multi-valuedNo
RequiredYes
Admin Action RequiredNone
The index must be rebuilt after modifying this property.
AdvancedNo
Read-OnlyNo

sort-order

SynopsisSpecifies the names of the attributes that are used to sort the entries for the query being indexed.
DescriptionMultiple 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.
Default ValueNone
Allowed ValuesValid attribute types defined in the schema, separated by a space and optionally prefixed by + or -.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
The index must be rebuilt after modifying this property.
AdvancedNo
Read-OnlyNo