gerrit/Documentation/cmd-index-start.txt
Khai Do e0169d1e78 doc update: how to get online index status info
Change-Id: I0fedb0b9c76ce804ef62d1a5b364321c5f059abc
2016-08-15 13:57:37 -07:00

54 lines
1.3 KiB
Plaintext

= gerrit index start
== NAME
gerrit index start - Start the online indexer
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit index start_ <INDEX> [--force]
--
== DESCRIPTION
Gerrit supports online index schema upgrades. When starting Gerrit for the first
time after an upgrade that requires an index schema upgrade, the online indexer
will be started. If the schema upgrade is a success, the new index will be
activated and if it fails, a statement in the logs will be printed with the
number of successfully/failed indexed changes.
This command allows restarting the online indexer without having to restart
Gerrit. This command will not start the indexer if it is already running or if
the active index is the latest.
The link:cmd-show-queue.html[show-queue] command provides online index status.
== ACCESS
Caller must be a member of the privileged 'Administrators' group.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
<INDEX>::
Restart the online indexer on this secondary index.
Currently supported values:
* changes
* accounts
--force::
Force an online re-index.
== EXAMPLES
Start the online indexer for the 'changes' index:
----
$ ssh -p 29418 review.example.com gerrit index start changes
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------