fix: clarify connection pool document (#2877) · googleapis/java-bigquerystorage@4a4adbb

File tree

2 files changed

lines changed

  • google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1

2 files changed

lines changed

Original file line numberDiff line numberDiff line change

@@ -312,8 +312,21 @@ public Builder setReconnectAfter10M(boolean reconnectAfter10M) {

312312

}

313313
314314

/**

315-

* Enable multiplexing for this writer. In multiplexing mode tables will share the same

316-

* connection if possible until the connection is overwhelmed.

315+

* Enables a static shared bidi-streaming connection pool that would dynamically scale up

316+

* connections based on backlog within each individual connection. A single table's traffic

317+

* might be splitted into multiple connections if needed. Different tables' traffic can also be

318+

* multiplexed within the same connection.

319+

*

320+

* <pre>

321+

* Each connection pool would have a upper limit (default to 20) and lower limit (default to

322+

* 2) for the number of active connections. This parameter can be tuned via a static method

323+

* exposed on {@link ConnectionWorkerPool}.

324+

*

325+

* Example:

326+

* ConnectionWorkerPool.setOptions(

327+

* Settings.builder().setMinConnectionsPerRegion(4).setMaxConnectionsPerRegion(10).build());

328+

*

329+

* </pre>

317330

*

318331

* @param enableConnectionPool

319332

* @return Builder

Original file line numberDiff line numberDiff line change

@@ -729,8 +729,21 @@ public Builder setEndpoint(String endpoint) {

729729

}

730730
731731

/**

732-

* Enable multiplexing for this writer. In multiplexing mode tables will share the same

733-

* connection if possible until the connection is overwhelmed.

732+

* Enables a static shared bidi-streaming connection pool that would dynamically scale up

733+

* connections based on backlog within each individual connection. A single table's traffic

734+

* might be splitted into multiple connections if needed. Different tables' traffic can also be

735+

* multiplexed within the same connection.

736+

*

737+

* <pre>

738+

* Each connection pool would have a upper limit (default to 20) and lower limit (default to

739+

* 2) for the number of active connections. This parameter can be tuned via a static method

740+

* exposed on {@link ConnectionWorkerPool}.

741+

*

742+

* Example:

743+

* ConnectionWorkerPool.setOptions(

744+

* Settings.builder().setMinConnectionsPerRegion(4).setMaxConnectionsPerRegion(10).build());

745+

*

746+

* </pre>

734747

*

735748

* @param enableConnectionPool

736749

* @return Builder