This repository was archived by the owner on Dec 8, 2021. It is now read-only.
File tree Expand file tree Collapse file tree 5 files changed +25
-8
lines changed Expand file tree Collapse file tree 5 files changed +25
-8
lines changed Original file line number Diff line number Diff line change @@ -59,13 +59,14 @@ class Connection {
5959
6060 // @{
6161 /* *
62- * Defines the arguments for each member function.
62+ * @name Defines the arguments for each member function.
6363 *
6464 * Applications may define classes derived from `Connection`, for example,
6565 * because they want to mock the class. To avoid breaking all such derived
6666 * classes when we change the number or type of the arguments to the member
6767 * functions we define light weight structures to pass the arguments.
6868 */
69+
6970 // / Wrap the arguments to `Read()`.
7071 struct ReadParams {
7172 Transaction transaction;
Original file line number Diff line number Diff line change @@ -62,7 +62,7 @@ class DatabaseAdminConnection {
6262
6363 // @{
6464 /* *
65- * Define the arguments for each member function.
65+ * @name Define the arguments for each member function.
6666 *
6767 * Applications may define classes derived from `DatabaseAdminConnection`, for
6868 * example, because they want to mock the class. To avoid breaking all such
Original file line number Diff line number Diff line change @@ -73,7 +73,7 @@ class InstanceAdminConnection {
7373
7474 // @{
7575 /* *
76- * Define the arguments for each member function.
76+ * @name Define the arguments for each member function.
7777 *
7878 * Applications may define classes derived from `InstanceAdminConnection`,
7979 * for example, because they want to mock the class. To avoid breaking all
@@ -114,7 +114,7 @@ class InstanceAdminConnection {
114114 };
115115
116116 /* *
117- * The parameters for a `ListInstances()` request .
117+ * Wrap the arguments for `ListInstances()`.
118118 */
119119 struct ListInstancesParams {
120120 /* *
Original file line number Diff line number Diff line change @@ -228,12 +228,12 @@ Row MakeTestRow(Ts&&... ts) {
228228}
229229
230230/* *
231- * A `RowStreamIterator` is an [Input Iterator][input-iterator] that returns a
231+ * A `RowStreamIterator` is an _Input Iterator_ (see below) that returns a
232232 * sequence of `StatusOr<Row>` objects.
233233 *
234- * As an Input Iterator, the sequence may only be consumed once. Default
235- * constructing a `RowStreamIterator` creates an instance that represents
236- * "end".
234+ * As an [ Input Iterator][input-iterator] , the sequence may only be consumed
235+ * once. Default constructing a `RowStreamIterator` creates an instance that
236+ * represents "end".
237237 *
238238 * @note The term "stream" in this name refers to the general nature
239239 * of the the data source, and is not intended to suggest any similarity to
Original file line number Diff line number Diff line change @@ -29,6 +29,22 @@ inline namespace SPANNER_CLIENT_NS {
2929// What action to take if the session pool is exhausted.
3030enum class ActionOnExhaustion { kBlock , kFail };
3131
32+ /* *
33+ * Controls the session pool maintained by a `spanner::Client`.
34+ *
35+ * Creating Cloud Spanner sessions is an expensive operation. The
36+ * [recommended practice][spanner-sessions-doc] is to maintain a cache (or pool)
37+ * of sessions in the client side. This class controls the initial size of this
38+ * pool, and how the pool grows (or shrinks) as needed.
39+ *
40+ * @note If no sessions are available to perform an operation the client library
41+ * blocks until new sessions are available (either released by other threads
42+ * or allocated on-demand, depending on the active constraints). It is
43+ * also possible to configure the client to fail a request when the session
44+ * pool is exhausted.
45+ *
46+ * [spanner-sessions-doc]: https://cloud.google.com/spanner/docs/sessions
47+ */
3248class SessionPoolOptions {
3349 public:
3450 /* *
You can’t perform that action at this time.
0 commit comments