Skip to content

Commit e64d18a

Browse files
README: update readme for multiplexed sessions (#2405)
* README: update readme for multiplexed session * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent d3d6d5d commit e64d18a

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

handwritten/spanner/.readme-partials.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,24 @@ introduction: |-
22
[Cloud Spanner](https://cloud.google.com/spanner/docs/) is a fully managed, mission-critical, relational database service that
33
offers transactional consistency at global scale, schemas, SQL (ANSI 2011 with extensions),
44
and automatic, synchronous replication for high availability.
5+
6+
body: |-
7+
## Multiplexed Sessions
8+
9+
Spanner's Multiplexed Sessions can now be used as an efficient alternative to the default session pool. This feature helps reduce
10+
session management overhead and minimize session-related errors. Multiplexed sessions can be enabled for all transaction types via environment variables.
11+
12+
### Configuration
13+
14+
To enable this feature, set the following environment variables to `true`:
15+
16+
* **For Read-Only Transactions:**
17+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS`
18+
* **For Partitioned Operations:**
19+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS`
20+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_PARTITIONED_OPS`
21+
* **For Read-Write Transactions:**
22+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS`
23+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_FOR_RW`
24+
25+
For a detailed explanation of this feature, please refer to the [official documentation](https://cloud.google.com/spanner/docs/sessions#multiplexed_sessions).

handwritten/spanner/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,25 @@ console.log(`Query: ${rows.length} found.`);
8080
rows.forEach(row => console.log(row));
8181

8282
```
83+
## Multiplexed Sessions
8384

85+
Spanner's Multiplexed Sessions can now be used as an efficient alternative to the default session pool. This feature helps reduce
86+
session management overhead and minimize session-related errors. Multiplexed sessions can be enabled for all transaction types via environment variables.
87+
88+
### Configuration
89+
90+
To enable this feature, set the following environment variables to `true`:
91+
92+
* **For Read-Only Transactions:**
93+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS`
94+
* **For Partitioned Operations:**
95+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS`
96+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_PARTITIONED_OPS`
97+
* **For Read-Write Transactions:**
98+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS`
99+
- `GOOGLE_CLOUD_SPANNER_MULTIPLEXED_SESSIONS_FOR_RW`
100+
101+
For a detailed explanation of this feature, please refer to the [official documentation](https://cloud.google.com/spanner/docs/sessions#multiplexed_sessions).
84102

85103

86104
## Samples

0 commit comments

Comments
 (0)