sub-enabled

DS attribute indexing (IDX) properties

Description

Directory Server can index attributes, making them faster to search. The dsconf command helps you configure five of the six supported index types:

Equality indexes to determine expediently whether an attribute value is equal to a specified value
Presence indexes to determine whether a specified attribute has any values
Substring indexes to determine whether a specified attribute has values containing a specified string, also used to compare regular expressions to attribute values
Approximate indexes, based on metaphone approximation and useful for English language strings only, to determine whether a specified attribute has any values that sound like the specified string
International indexes, also called matching rule indexes, to expedite sorting and searching in accordance with the language rules of a particular locale

The dsconf command does not help you configure virtual list view, also known as browsing, indexes.

The dsconf command does help you assign all IDs threshold values to indexes. As the number of entries and attribute values grows in a directory, the number of attribute values to index also grows, as does therefore the size of the indexes. In some deployments a server can end up maintaining index lists so large that the cost of rebuilding an index when attributes are modified or added outweighs the benefit the index provides for searches. All IDs thresholds limit the growth of large indexes by definining the maximum number of entry identifiers Directory Server maintains in an index list. You can define all IDs thresholds for individual indexes and for some types of indexes.

Some indexes are maintained by the server for its own use. These are called system indexes. In general, do not modify or remove systems indexes; such modifications could have severe repercussions on performance.

See Directory Server Indexing in Reference for Oracle Directory Server Enterprise Edition for further details about indexing.

PROPERTY: all-ids-threshold

Characteristic	Value
Syntax	`INTEGER \| inherited`
Default Value	`inherited`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the maximum number of entry IDs the server maintains in an index list for the specified attribute type. By default its value is inherited from the all-ids-threshold setting for the suffix, whose default value in turn is inherited from the all-ids-threshold setting for the server, which by default is 4000. In addition to inheritance of default settings, this property handles settings as follows:

inherited: The threshold is inherited from the more global setting.
<2000: The threshold value is rounded up to 2000.
>2000: The setting is used as a guaranteed minimum threshold. Because of internal mechanisms, the real value can be slightly more than the specified value.

After you modify this property, reindex the attribute for which you changed the threshold. For example:

$ dsconf set-index-prop dc=example,dc=com uid all-ids-threshold:5000
$ dsconf reindex -t uid dc=example,dc=com

## example: Indexing attribute: uid
## example: Finished indexing.

Task completed (slapd exit code: 0).
$

PROPERTY: all-ids-threshold-eq

Characteristic	Value
Syntax	`INTEGER \| inherited`
Default Value	`inherited`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the all IDs threshold for equality indexes of the specified attribute. By default its value is inherited from the all-ids-threshold setting for the attribute type. See all-ids-threshold(5DSCONF) for more information.

PROPERTY: all-ids-threshold-pres

Characteristic	Value
Syntax	`INTEGER \| inherited`
Default Value	`inherited`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the all IDs threshold for presence indexes of the specified attribute. By default its value is inherited from the all-ids-threshold setting for the attribute type. See all-ids-threshold(5DSCONF) for more information.

PROPERTY: all-ids-threshold-sub

Characteristic	Value
Syntax	`INTEGER \| inherited`
Default Value	`inherited`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property defines the all IDs threshold for substring indexes of the specified attribute. By default its value is inherited from the all-ids-threshold setting for the attribute type. See all-ids-threshold(5DSCONF) for more information.

PROPERTY: approx-enabled

Characteristic	Value
Syntax	`on\|off`
Default Value	`off`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property determines whether approximate indexes are maintained for the specified attribute type. You cannot set an all IDs threshold value for approximate indexes.

PROPERTY: desc

Characteristic	Value
Syntax	`STRING`
Default Value	None
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

Use this optional property to provide a short description of the index configuration.

PROPERTY: eq-enabled

Characteristic	Value
Syntax	`on\|off`
Default Value	`on`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property determines whether equality indexes are maintained for the specified attribute type.

PROPERTY: matching-rule

Characteristic	Value
Syntax	`STRING`
Default Value	None
Is readable	Yes
Is modifiable	Yes
Is multi-valued	Yes

This property specifies the matching rule indexes maintained for the specified attribute type.

Values for this property must be valid collation order object identifiers (OIDs). See Directory Server Internationalized Directory in Directory Server Enterprise Edition Reference for the OIDs corresponding to supported locales.

PROPERTY: pres-enabled

Characteristic	Value
Syntax	`on\|off`
Default Value	`on`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property determines whether presence indexes are maintained for the specified attribute type.

PROPERTY: sub-enabled

Characteristic	Value
Syntax	`on\|off`
Default Value	`off`
Is readable	Yes
Is modifiable	Yes
Is multi-valued	No

This property determines whether substring indexes are maintained for the specified attribute type.

PROPERTY: system

Characteristic	Value
Syntax	`true\|false`
Default Value	`false`
Is readable	Yes
Is modifiable	No
Is multi-valued	No

This property identifies whether the specified index is a system index, and therefore should be left alone.

Syntax Values

Syntax values shown in lower case or partly in lower case are literal values.

Those shown in upper case are syntax types, defined as follows:

ATTR_NAME

A valid attribute type name such as cn or objectClass.

BOOLEAN

true or false.

DN

A valid distinguished name such as ou=People,dc=example,dc=com.

DURATION

A duration specified in months (M), weeks (w), days (d), hours (h), minutes (m), seconds (s), and miliseconds (ms), or some combination with multiple specifiers. For example, you can specify one week as 1w, 7d, 168h, 10080m, or 604800s. You can also specify one week as 1w0d0h0m0s.

DURATION properties typically do not each support all duration specifiers (Mwdhms). Examine the output of dsconf help-properties for the property to determine which duration specifiers are supported.

EMAIL_ADDRESS

A valid e-mail address.

HOST_NAME

An IP address or host name.

INTEGER

A positive integer value between 0 and the maximum supported integer value in the system address space. On 32-bit systems, 2147483647. On 64-bit systems, 9223372036854775807.

INTERVAL

An interval value of the form hhmm-hhmm 0123456, where the first element specifies the starting hour, the next element the finishing hour in 24-hour time format, from 0000-2359, and the second specifies days, starting with Sunday (0) to Saturday (6).

IP_RANGE

An IP address or range of address in one of the following formats:

IP address in dotted decimal form.
IP address and bits, in the form of network number/mask bits.
IP address and quad, in the form of a pair of dotted decimal quads.
All address. A catch-all for clients that are note placed into other, higher priority groups.
0.0.0.0. This address is for groups to which initial membership is not considered. For example, for groups that clients switch to after their initial bind.
IP address of the local host.

LDAP_URL

A valid LDAP URL as specified by RFC 2255 (http://www.ietf.org/rfc/rfc2255.txt).

MEMORY_SIZE

A memory size specified in gigabytes (G), megabytes (M),kilobytes (k), or bytes (b). Unlike DURATION properties, MEMORY_SIZE properties cannot combine multiple specifiers. However, MEMORY_SIZE properties allow decimal values, for example, 1.5M.

NAME

A valid cn (common name).

OCTAL_MODE

A three-digit, octal file permissions specifier. The first digit specifies permissions for the server user ID, the second for the server group ID, the last for other users. Each digit consists of a bitmask defining read (4), write (2), execute (1), or no access (0) permissions, thus 640 specifies read-write access for the server user, read-only access for other users of the server group, and no access for other users.

PASSWORD_FILE

The full path to the file from which the bind password should be read.

PATH

A valid, absolute file system path.

STRING

A DirectoryString value, as specified by RFC 2252 (http://www.ietf.org/rfc/rfc2252.txt).

SUPPORTED_SSL_CIPHER

An SSL cipher supported by the server. See the Reference for a list of supported ciphers.

SUPPORTED_SSL_PROTOCOL

An SSL protocol supported by the server. See the Reference for a list of supported protocols.

TIME

A time of the form hhmm in 24-hour format, where hh stands for hours and mm stands for minutes.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWdsee7
Stability Level	Evolving