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:

Backend VLV Index Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties

base-dn
filter
name
scope
sort-order

Basic Properties

Use the --advanced option to access advanced properties.

base-dn

Synopsis

Specifies the base DN used in the search query that is being indexed.

Default Value

None

Allowed Values

A valid DN.

Multi-valued

No

Required

Yes

Admin Action Required

None

The index must be rebuilt after modifying this property.

Advanced

No

Read-Only

No

filter

Synopsis

Specifies the LDAP filter used in the query that is being indexed.

Default Value

None

Allowed Values

A valid LDAP search filter.

Multi-valued

No

Required

Yes

Admin Action Required

None

The index must be rebuilt after modifying this property.

Advanced

No

Read-Only

No

name

Synopsis

Specifies a unique name for this VLV index.

Default Value

None

Allowed Values

A string.

Multi-valued

No

Required

Yes

Admin Action Required

None

The VLV index name cannot be altered after the index is created.

Advanced

No

Read-Only

Yes

scope

Synopsis

Specifies the LDAP scope of the query that is being indexed.

Default Value

None

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-valued

No

Required

Yes

Admin Action Required

None

The index must be rebuilt after modifying this property.

Advanced

No

Read-Only

No

sort-order

Synopsis

Specifies the names of the attributes that are used to sort the entries for the query being indexed.

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.

Default Value

None

Allowed Values

Valid attribute types defined in the schema, separated by a space and optionally prefixed by + or -.

Multi-valued

No

Required

Yes

Admin Action Required

None

The index must be rebuilt after modifying this property.

Advanced

No

Read-Only

No