blob: 7a12eb18a1b4bb880a3b08f097f71f8e6533caad [file] [log] [blame]
{
"documentation":"https://lucene.apache.org/solr/guide/collection-management.html#modifycollection",
"description":"Modifies specific attributes of a collection. Multiple attributes can be changed at one time.",
"type": "object",
"properties":{
"rule": {
"type": "array",
"documentation": "https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description": "Modifies the rules for where replicas should be located in a cluster.",
"items": {
"type": "string"
}
},
"snitch": {
"type": "array",
"documentation": "https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description": "Details of the snitch provider",
"items": {
"type": "string"
}
},
"policy": {
"type": "string",
"documentation": "https://lucene.apache.org/solr/guide/solrcloud-autoscaling-policy-preferences.html",
"description": "Name of the collection-level policy"
},
"autoAddReplicas": {
"type": "boolean",
"description": "When set to true, enables auto addition of replicas when the number of active replicas falls below the value set for replicationFactor.",
"documentation": "https://lucene.apache.org/solr/guide/solrcloud-autoscaling-auto-add-replicas.html",
"default": "false"
},
"replicationFactor": {
"type": "integer",
"description": "The number of replicas to be created for each shard. Replicas are physical copies of each shard, acting as failover for the shard. Note that changing this value on an existing collection does not automatically add more replicas to the collection. However, it will allow add-replica commands to succeed."
},
"maxShardsPerNode": {
"type": "integer",
"description": "When creating collections, the shards and/or replicas are spread across all available, live, nodes, and two replicas of the same shard will never be on the same node. If a node is not live when the collection is created, it will not get any parts of the new collection, which could lead to too many replicas being created on a single live node. Defining maxShardsPerNode sets a limit on the number of replicas can be spread to each node. If the entire collection can not be fit into the live nodes, no collection will be created at all."
}
}
}