[SOLR-12309] CloudSolrClient.Builder constructors are not well documented

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 7.3
• Component/s: clients - java
• Assignee: Unassigned
• Reporter: Shawn Heisey
• Created: 03/May/18 21:20
• Updated: 08/Jul/20 17:22
• Resolved: 08/Jul/20 17:22

Description

I was having a lot of trouble figuring out how to create a CloudSolrClient object without using deprecated code.

The no-arg constructor on the Builder object is deprecated, and the two remaining methods have similar signatures to each other. It is not at all obvious how to successfully call the one that uses ZooKeeper to connect. The javadoc is silent on the issue. I did finally figure it out with a lot of googling, and I would like to save others the hassle.

I believe that this is what the javadoc for the third ctor should say:

---

Provide a series of ZooKeeper hosts which will be used when configuring CloudSolrClient instances. Optionally, include a chroot to be used when accessing the ZooKeeper database.

Here are a couple of examples. The first one has no chroot, the second one does:

new CloudSolrClient.Builder(zkHosts, Optional.empty())
new CloudSolrClient.Builder(zkHosts, Optional.of("/solr"))

---

The javadoc for the URL-based method should probably say something to indicate that it is easy to confuse with the ZK-based method.

I have not yet looked at the current reference guide to see if that has any clarification.

Is it a good idea to completely eliminate the ability to create a cloud client using a single string that matches the zkHost value used when starting Solr in cloud mode?