gerrit/Documentation/cmd-index-activate.txt
Khai Do d9cda09116 doc: add option and example section to ssh index command
Add an options and example section to index start and index activate
commands.  Update to include 'accounts' index as a valid value.

From reindex command:
 ~/gerrit: java -jar buck-out/gen/gerrit/gerrit.war reindex --index bogus -d gerrit_testsite
 fatal: invalid index name(s): [bogus] available indices are: [accounts, changes]

Change-Id: I0500fcf1a6bc524e58fb6d56160a75599afd3ee1
2016-07-20 09:50:05 -07:00

48 lines
1.1 KiB
Plaintext

= gerrit index activate
== NAME
gerrit index activate - Activate the latest index version available
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit index activate <INDEX>_
--
== 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 to activate the latest index even if there were some
failures.
== ACCESS
Caller must be a member of the privileged 'Administrators' group.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
<INDEX>::
The index to activate.
Currently supported values:
* changes
* accounts
== EXAMPLES
Activate the latest change index:
----
$ ssh -p 29418 review.example.com gerrit activate changes
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------