rebuild-index

Description

Rebuild index data within a backend based on the Berkeley DB Java Edition. Note that this tool uses different approaches to rebuilding indexes based on whether it is running in online mode (as a task) rather than with the server offline. Running in offline mode will often provide significantly better performance and require significantly less database cleaning, particularly for indexes containing keys that match a large number of entries and have high index entry limit and exploded index entry threshold values. Also note that rebuilding an index with the server online will prevent the server from using that index while the rebuild is in progress, so some searches may behave differently while a rebuild is active than when it is not.

An index must be rebuilt if the database already contains data when the index is configured. The backend containing the provided base DN must be a local DB backend. The types of indexes that can be rebuilt include system indexes, attribute indexes, VLV indexes, and JSON field indexes.

This tool features both an offline mode of operation as well as the ability to schedule an operation to run within the Directory Server's process. To schedule an operation supply LDAP connection options that allow this tool to communicate with the server through its task interface. Tasks can be scheduled to run immediately or at a later time (see Task Scheduling Options below). Once scheduled, tasks can be managed using the manage-tasks tool.

Examples

rebuild-index --baseDN dc=example,dc=com --index sn --index vlv.example

rebuild-index --task --hostname directory.example.com --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN dc=example,dc=com --index cn

Arguments

-V
--version

-H
--help

--help-ldap

--help-sasl

--help-debug

-Z
--useSSL

-q
--useStartTLS

--useNoSecurity

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {bindDN}
--bindDN {bindDN}

-w {bindPassword}
--bindPassword {bindPassword}

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

-o {name=value}
--saslOption {name=value}

-X
--trustAll

-P {truststorePath}
--trustStorePath {truststorePath}

-T {truststorePassword}
--trustStorePassword {truststorePassword}

-U {path}
--trustStorePasswordFile {path}

-K {keystorePath}
--keyStorePath {keystorePath}

-W {keystorePassword}
--keyStorePassword {keystorePassword}

-u {keystorePasswordFile}
--keyStorePasswordFile {keystorePasswordFile}

-N {nickname}
--certNickname {nickname}

--useAdministrativeSession

--propertiesFilePath {propertiesFilePath}

--usePropertiesFile

--script-friendly

--task

-t {startTime}
--start {startTime}

--startAlert

--successAlert

--errorAlert

--startNotify {emailAddress}

--completionNotify {emailAddress}

--successNotify {emailAddress}

--errorNotify {emailAddress}

--dependency {taskID}

--failedDependencyAction {action}

-Q
--quiet

-b {baseDN}
--baseDN {baseDN}

-i {index}
--index {index}

--bulkRebuild {all|new|untrusted|trusted}

--maxThreads {numThreads}

--logFilePath {logFilePath}