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.
The following components have a direct COMPOSITION relation TO Backend VLV Indexes :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ base-dn | None |
| ↓ filter | |
| ↓ name | |
| ↓ scope | |
| ↓ sort-order |
| Description | 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 | The index must be rebuilt after modifying this property. |
| Advanced Property | No |
| Read-only | No |
| Description | 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 | The index must be rebuilt after modifying this property. |
| Advanced Property | No |
| Read-only | No |
| Description | 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 Property | No |
| Read-only | Yes |
| Description | 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 | The index must be rebuilt after modifying this property. |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies the names of the attributes that are used to sort the entries for the query being indexed.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 | The index must be rebuilt after modifying this property. |
| Advanced Property | No |
| Read-only | No |