Skip to content

Commit 4466500

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 429a56e commit 4466500

File tree

4 files changed

+44
-5
lines changed

4 files changed

+44
-5
lines changed

.github/workflows/ci.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- uses: actions/checkout@v5
3333
- uses: actions/setup-node@v4
3434
with:
35-
node-version: 22
35+
node-version: 18
3636
- run: node --version
3737
- run: npm install --engine-strict
3838
working-directory: .github/scripts
@@ -46,7 +46,7 @@ jobs:
4646
- uses: actions/checkout@v5
4747
- uses: actions/setup-node@v4
4848
with:
49-
node-version: 22
49+
node-version: 18
5050
- run: npm install --engine-strict
5151
- run: npm test
5252
env:
@@ -57,7 +57,7 @@ jobs:
5757
- uses: actions/checkout@v5
5858
- uses: actions/setup-node@v4
5959
with:
60-
node-version: 22
60+
node-version: 18
6161
- run: npm install
6262
- run: npm run lint
6363
docs:
@@ -66,7 +66,7 @@ jobs:
6666
- uses: actions/checkout@v5
6767
- uses: actions/setup-node@v4
6868
with:
69-
node-version: 22
69+
node-version: 18
7070
- run: npm install
7171
- run: npm run docs
7272
- uses: JustinBeckwith/linkinator-action@v1

.github/workflows/issues-no-repro.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
- uses: actions/checkout@v5
1414
- uses: actions/setup-node@v4
1515
with:
16-
node-version: 22
16+
node-version: 18
1717
- run: npm install
1818
working-directory: ./.github/scripts
1919
- uses: actions/github-script@v7

.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).

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)