Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
Local DB 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.
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following components have a direct composition relation to Local DB VLV Indexes:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ base-dn | ↓ max-block-size |
| ↓ scope | ↓ cache-mode |
| ↓ filter | |
| ↓ sort-order | |
| ↓ name |
| 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. |
| 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. whole-subtree - Search the base object and the entire subtree below the base object. subordinate-subtree - Search the entire subtree below the base object but do not include the base object itself. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The index must be rebuilt after modifying this property. |
| 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. |
| 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. |
| 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. |
max-block-size (Advanced Property, Read-Only)
| Description | Specifies the number of entry IDs to store in a single sorted set before it must be split. |
| Default Value | 4000 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. The blocks are re-sized lazily the next time the index is modified. |
cache-mode (Advanced Property)
| Description | Specifies the cache mode that should be used when accessing the records in the database for this index. |
| Default Value | The cache mode specified by the default-cache-mode property in the associated backend will be used. |
| Allowed Values | keep-hot - Records from this database should be kept hot in the cache, so that they are less likely to be evicted under memory pressure than records from databases with other cache modes. default - Records from this database should be given the default cache priority, which makes them more likely to be evicted under memory pressure than records from databases with a cache mode of "keep-hot", but less likely to be evicted than with a cache mode of "make-cold". make-cold - Records from this database should be made cold in the cache, so that they are more likely to be evicted under memory pressure than records from databases with a cache mode of "keep-hot" or "default". evict-leaf-immediately - Leaf nodes from this database should be evicted from the cache as soon as they are no longer needed by the operation referencing them, regardless of whether there is memory pressure. evict-bin-immediately - Entire BINs should be evicted from the cache as soon as possible when the associated leaf nodes are no longer needed by the operation referencing them, regardless of whether there is memory pressure. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Local DB VLV Index must be disabled and re-enabled for changes to this setting to take effect. This modification requires that you disable and then re-enable this component for the change to take effect |
To list the configured Local DB VLV Indexes:
dsconfig list-local-db-vlv-indexes
[--property {propertyName}] ...
To view the configuration for an existing Local DB VLV Index:
dsconfig get-local-db-vlv-index-prop
--index-name {name}
--backend-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Local DB VLV Index:
dsconfig set-local-db-vlv-index-prop
--index-name {name}
--backend-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Local DB VLV Index:
dsconfig create-local-db-vlv-index
--index-name {name}
--backend-name {name}
--set base-dn:{propertyValue}
--set scope:{propertyValue}
--set filter:{propertyValue}
--set sort-order:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Local DB VLV Index:
dsconfig delete-local-db-vlv-index
--index-name {name}
--backend-name {name}