dsconfig get-backend-index-prop — Shows Backend Index properties
dsconfig get-backend-index-prop
{options}
The dsconfig get-backend-index-prop command takes the following options:
--backend-name {name}
The name of the Pluggable Backend.
Backend Index properties depend on the Backend Index type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Backend Index types:
Default {name}: Backend Index
Enabled by default: false
See the section called “Backend Index” for the properties of this Backend Index type.
--index-name {name}
The name of the Backend Index.
Backend Index properties depend on the Backend Index type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Backend Index types:
Default {name}: Backend Index
Enabled by default: false
See the section called “Backend Index” for the properties of this Backend Index type.
--property {property}
The name of a property to be displayed.
Backend Index properties depend on the Backend Index type, which depends on the {property} you provide.
By default, OpenDJ directory server supports the following Backend Index types:
Default {property}: Backend Index
Enabled by default: false
See the section called “Backend Index” for the properties of this Backend Index type.
-E | --record
Modifies the display output to show one property value per line.
Backend Index properties depend on the Backend Index type, which depends on the null you provide.
By default, OpenDJ directory server supports the following Backend Index types:
Default null: Backend Index
Enabled by default: false
See the section called “Backend Index” for the properties of this Backend Index type.
-z | --unit-size {unit}
Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
Backend Index properties depend on the Backend Index type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Backend Index types:
Default {unit}: Backend Index
Enabled by default: false
See the section called “Backend Index” for the properties of this Backend Index type.
-m | --unit-time {unit}
Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Backend Index properties depend on the Backend Index type, which depends on the {unit} you provide.
By default, OpenDJ directory server supports the following Backend Index types:
Default {unit}: Backend Index
Enabled by default: false
See the section called “Backend Index” for the properties of this Backend Index type.
Backend Indexes of type backend-index have the following properties:
Specifies the name of the attribute for which the index is to be maintained.
None
The name of an attribute type defined in the server schema.
No
Yes
None
No
Yes
Specifies whether contents of the index should be confidential. Setting the flag to true will hash keys for equality type indexes using SHA-1 and encrypt the list of entries matching a substring key for substring indexes.
false
true
false
No
No
If the index for the attribute must be protected for security purposes and values for that attribute already exist in the database, the index must be rebuilt before it will be accurate. The property cannot be set on a backend for which confidentiality is not enabled.
No
No
Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. This is analogous to the ALL IDs threshold in the Sun Java System Directory Server. If this is specified, its value overrides the JE backend-wide configuration. For no limit, use 0 for the value.
4000
An integer value. Lower value is 0. Upper value is 2147483647.
No
No
If any index keys have already reached this limit, indexes must be rebuilt before they will be allowed to use the new limit.
No
No
The extensible matching rule in an extensible index. An extensible matching rule must be specified using either LOCALE or OID of the matching rule.
No extensible matching rules will be indexed.
A Locale or an OID.
Yes
No
The index must be rebuilt before it will reflect the new value.
No
No
Specifies the type(s) of indexing that should be performed for the associated attribute. For equality, presence, and substring index types, the associated attribute type must have a corresponding matching rule.
None
This index type is used to improve the efficiency of searches using approximate matching search filters.
This index type is used to improve the efficiency of searches using equality search filters.
This index type is used to improve the efficiency of searches using extensible matching search filters.
This index type is used to improve the efficiency of searches using "greater than or equal to" or "less then or equal to" search filters.
This index type is used to improve the efficiency of searches using the presence search filters.
This index type is used to improve the efficiency of searches using substring search filters.
Yes
Yes
If any new index types are added for an attribute, and values for that attribute already exist in the database, the index must be rebuilt before it will be accurate.
No
No
The length of substrings in a substring index.
6
An integer value. Lower value is 3.
No
No
The index must be rebuilt before it will reflect the new value.
Yes (Use --advanced in interactive mode.)
No