| Hugo Arès | 3a59335 | 2015-06-29 16:04:59 -0400 | [diff] [blame] | 1 | = gerrit index start |
| 2 | |
| 3 | == NAME |
| David Shevitz | e369eee | 2018-09-26 12:31:46 -0700 | [diff] [blame] | 4 | gerrit index start - Start the online indexer. |
| Hugo Arès | 3a59335 | 2015-06-29 16:04:59 -0400 | [diff] [blame] | 5 | |
| 6 | == SYNOPSIS |
| Michael Ochmann | e2d76a1 | 2016-06-23 17:07:37 +0200 | [diff] [blame] | 7 | [verse] |
| Hugo Arès | 3a59335 | 2015-06-29 16:04:59 -0400 | [diff] [blame] | 8 | -- |
| Khai Do | b9a5d00 | 2016-05-21 08:59:44 -0700 | [diff] [blame] | 9 | _ssh_ -p <port> <host> _gerrit index start_ <INDEX> [--force] |
| Hugo Arès | 3a59335 | 2015-06-29 16:04:59 -0400 | [diff] [blame] | 10 | -- |
| 11 | |
| 12 | == DESCRIPTION |
| 13 | Gerrit supports online index schema upgrades. When starting Gerrit for the first |
| 14 | time after an upgrade that requires an index schema upgrade, the online indexer |
| 15 | will be started. If the schema upgrade is a success, the new index will be |
| 16 | activated and if it fails, a statement in the logs will be printed with the |
| 17 | number of successfully/failed indexed changes. |
| 18 | |
| 19 | This command allows restarting the online indexer without having to restart |
| 20 | Gerrit. This command will not start the indexer if it is already running or if |
| 21 | the active index is the latest. |
| 22 | |
| Khai Do | e0169d1 | 2016-08-15 09:24:03 -0700 | [diff] [blame] | 23 | The link:cmd-show-queue.html[show-queue] command provides online index status. |
| 24 | |
| Hugo Arès | 3a59335 | 2015-06-29 16:04:59 -0400 | [diff] [blame] | 25 | == ACCESS |
| 26 | Caller must be a member of the privileged 'Administrators' group. |
| 27 | |
| 28 | == SCRIPTING |
| 29 | This command is intended to be used in scripts. |
| 30 | |
| Khai Do | d9cda09 | 2016-07-18 11:43:27 -0700 | [diff] [blame] | 31 | == OPTIONS |
| 32 | <INDEX>:: |
| 33 | Restart the online indexer on this secondary index. |
| 34 | Currently supported values: |
| 35 | * changes |
| 36 | * accounts |
| David Pursehouse | 9f90c7c | 2018-03-27 19:45:40 +0100 | [diff] [blame] | 37 | * groups |
| 38 | * projects |
| Khai Do | d9cda09 | 2016-07-18 11:43:27 -0700 | [diff] [blame] | 39 | |
| Khai Do | b9a5d00 | 2016-05-21 08:59:44 -0700 | [diff] [blame] | 40 | --force:: |
| 41 | Force an online re-index. |
| 42 | |
| Khai Do | d9cda09 | 2016-07-18 11:43:27 -0700 | [diff] [blame] | 43 | == EXAMPLES |
| Khai Do | b9a5d00 | 2016-05-21 08:59:44 -0700 | [diff] [blame] | 44 | Start the online indexer for the 'changes' index: |
| Khai Do | d9cda09 | 2016-07-18 11:43:27 -0700 | [diff] [blame] | 45 | |
| 46 | ---- |
| David Shevitz | e369eee | 2018-09-26 12:31:46 -0700 | [diff] [blame] | 47 | $ ssh -p 29418 review.example.com gerrit index start changes |
| Khai Do | d9cda09 | 2016-07-18 11:43:27 -0700 | [diff] [blame] | 48 | ---- |
| 49 | |
| Hugo Arès | 3a59335 | 2015-06-29 16:04:59 -0400 | [diff] [blame] | 50 | GERRIT |
| 51 | ------ |
| 52 | Part of link:index.html[Gerrit Code Review] |
| 53 | |
| 54 | SEARCHBOX |
| 55 | --------- |
