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.
This commit is contained in:
Eric Pugh 2020-07-23 17:52:56 -04:00 committed by GitHub
parent 67da34ac3b
commit 80b6dcecfe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 19 deletions

View File

@ -700,7 +700,7 @@ source collection.
There's a number of optional parameters that determine the target collection layout. If they 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. 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 <<create,CREATE collection>> section): The following parameters are currently supported (described in detail in the <<create,CREATE collection>> section):
`numShards`, `replicationFactor`, `nrtReplicas`, `tlogReplicas`, `pullReplicas`, `numShards`, `replicationFactor`, `nrtReplicas`, `tlogReplicas`, `pullReplicas`,
`shards`, `policy`, `createNodeSet`, `createNodeSet.shuffle`, `router.*`. `shards`, `policy`, `createNodeSet`, `createNodeSet.shuffle`, `router.*`.
@ -1256,27 +1256,16 @@ Request ID to track this action which will be <<collections-api.adoc#asynchronou
`repository`:: `repository`::
The name of a repository to be used for the backup. If no repository is specified then the local filesystem repository will be used automatically. The name of a repository to be used for the backup. If no repository is specified then the local filesystem repository will be used automatically.
*Override Parameters* There's a number of optional parameters that determine the target collection layout.
The following parameters are currently supported (described in detail in the <<create,CREATE collection>> 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`:: *Overridable Parameters*
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.
`replicationFactor`:: 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 <<create,CREATE collection>> section):
The number of replicas to be created for each shard. `collection.configName`, `replicationFactor`, `nrtReplicas`, `tlogReplicas`, `pullReplicas`, `property._name_=_value_`.
`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 <<shards-and-indexing-data-in-solrcloud.adoc#types-of-replicas,Types of Replicas>> 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 <<shards-and-indexing-data-in-solrcloud.adoc#types-of-replicas,Types of Replicas>> for more information about replica types.
`property._name_=_value_`::
Set core property _name_ to _value_. See the section <<defining-core-properties.adoc#defining-core-properties,Defining core.properties>> for details on supported properties and values.
[[rebalanceleaders]] [[rebalanceleaders]]
== REBALANCELEADERS: Rebalance Leaders == REBALANCELEADERS: Rebalance Leaders