[GitHub] [calcite-avatica] stoty commented on a diff in pull request #217: CALCITE-5581: Client side LB implementation

["stoty (via GitHub)" <gi...@apache.org>]

stoty commented on code in PR #217:
URL: https://github.com/apache/calcite-avatica/pull/217#discussion_r1156769190


##########
site/_docs/client_reference.md:
##########
@@ -193,3 +193,52 @@ on-hover images for the permalink, but oh well.
 : _Default_: `false`.
 
 : _Required_: No.
+
+<strong><a name="use_client_side_lb" href="#use_client_side_lb">use_client_side_lb</a></strong>
+
+: _Description_: Enables the client side load-balancing.
+: _Default_: `false`.
+
+: _Required_: No.
+
+<strong><a name="lb_urls" href="#lb_urls">lb_urls</a></strong>
+
+: _Description_: List of URLs in a comma separated format, for example "URL1,URL2...URLn", to be used by the client side
+load balancer. Depending on the load balancing strategy, load balancer selects one of the URLs from the list.
+
+: _Default_: `null`.
+
+: _Required_: No.
+
+<strong><a name="lb_strategy" href="#lb_strategy">lb_strategy</a></strong>
+
+: _Description_: The load balancing strategy to be used by the client side load balancer. It must be a fully qualified
+Java class name which implements `org.apache.calcite.avatica.ha.LBStrategy`. Out of the box we have provided two
+implementations `org.apache.calcite.avatica.ha.RandomSelectLBStrategy` and
+`org.apache.calcite.avatica.ha.RoundRobinLBStrategy` which you can use as load balancing strategies.

Review Comment:
   nit:
   The load balancing strategy to be used by the client side load balancer. It must be a fully qualified
   Java class name which implements `org.apache.calcite.avatica.ha.LBStrategy`.
   Two implementations are provided: `org.apache.calcite.avatica.ha.RandomSelectLBStrategy` and
   `org.apache.calcite.avatica.ha.RoundRobinLBStrategy` .



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@calcite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org