dsconfig create-backend-vlv-index — Creates Backend VLV Indexes
dsconfig create-backend-vlv-index
{options}
The dsconfig create-backend-vlv-index command takes the following options:
--backend-name {name}
The name of the Pluggable Backend.
Backend VLV Index properties depend on the Backend VLV Index type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Backend VLV Index types:
Default {name}: Backend VLV Index
Enabled by default: false
See the section called “Backend VLV Index” for the properties of this Backend VLV Index type.
--index-name {STRING}
The name of the new Backend VLV Index which will also be used as the value of the "name" property: Specifies a unique name for this VLV index.
Backend VLV Index properties depend on the Backend VLV Index type, which depends on the {STRING} you provide.
By default, OpenDJ directory server supports the following Backend VLV Index types:
Default {STRING}: Backend VLV Index
Enabled by default: false
See the section called “Backend VLV Index” for the properties of this Backend VLV Index type.
--set {PROP:VALUE}
Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.
Backend VLV Index properties depend on the Backend VLV Index type, which depends on the --index-name {STRING}
option.
Backend VLV Indexes of type backend-vlv-index have the following properties:
Specifies the base DN used in the search query that is being indexed.
None
A valid DN.
No
Yes
The index must be rebuilt after modifying this property.
No
No
Specifies the LDAP filter used in the query that is being indexed.
None
A valid LDAP search filter.
No
Yes
The index must be rebuilt after modifying this property.
No
No
Specifies a unique name for this VLV index.
None
A String
No
Yes
None
The VLV index name cannot be altered after the index is created.
No
Yes
Specifies the LDAP scope of the query that is being indexed.
None
Search the base object only.
Search the immediate children of the base object but do not include any of their descendants or the base object itself.
Search the entire subtree below the base object but do not include the base object itself.
Search the base object and the entire subtree below the base object.
No
Yes
The index must be rebuilt after modifying this property.
No
No
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.
None
Valid attribute types defined in the schema, separated by a space and optionally prefixed by + or -.
No
Yes
The index must be rebuilt after modifying this property.
No
No