From 80b6dcecfebf267ca8390d8421b5d47305fc6db9 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 23 Jul 2020 17:52:56 -0400 Subject: [PATCH] SOLR-14435: Update collection management docs on RESTORE (#1683) * include missing RESTORE parameters * small grammer fix * remove duplication of describing the parameters in favour of the pattern of pointing to the CREATE command documentation. --- .../src/collection-management.adoc | 27 ++++++------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/solr/solr-ref-guide/src/collection-management.adoc b/solr/solr-ref-guide/src/collection-management.adoc index b2bef1e4232..bb713516a72 100644 --- a/solr/solr-ref-guide/src/collection-management.adoc +++ b/solr/solr-ref-guide/src/collection-management.adoc @@ -700,7 +700,7 @@ source collection. There's a number of optional parameters that determine the target collection layout. If they are not specified in the request then their values are copied from the source collection. -The following parameters are currently supported (described in details in the <> section): +The following parameters are currently supported (described in detail in the <> section): `numShards`, `replicationFactor`, `nrtReplicas`, `tlogReplicas`, `pullReplicas`, `shards`, `policy`, `createNodeSet`, `createNodeSet.shuffle`, `router.*`. @@ -1256,27 +1256,16 @@ Request ID to track this action which will be <> section): +`createNodeSet`, `createNodeSet.shuffle`. -Additionally, there are several parameters that may have been set on the original collection that can be overridden when restoring the backup: +Note: for `createNodeSet` the special value of `EMPTY` is not allowed with this command. -`collection.configName`:: -Defines the name of the configurations to use for this collection. These must already be stored in ZooKeeper. If not provided, Solr will default to the collection name as the configuration name. +*Overridable Parameters* -`replicationFactor`:: -The number of replicas to be created for each shard. - -`nrtReplicas`:: -The number of NRT (Near-Real-Time) replicas to create for this collection. This type of replica maintains a transaction log and updates its index locally. This parameter behaves the same way as setting replicationFactor parameter. - -`tlogReplicas`:: -The number of TLOG replicas to create for this collection. This type of replica maintains a transaction log but only updates its index via replication from a leader. See the section <> for more information about replica types. - -`pullReplicas`:: -The number of PULL replicas to create for this collection. This type of replica does not maintain a transaction log and only updates its index via replication from a leader. This type is not eligible to become a leader and should not be the only type of replicas in the collection. See the section <> for more information about replica types. - -`property._name_=_value_`:: -Set core property _name_ to _value_. See the section <> for details on supported properties and values. +Additionally, there are several parameters that may have been set on the original collection that can be overridden when restoring the backup (described in detail in the <> section): +`collection.configName`, `replicationFactor`, `nrtReplicas`, `tlogReplicas`, `pullReplicas`, `property._name_=_value_`. [[rebalanceleaders]] == REBALANCELEADERS: Rebalance Leaders