Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

feat: add session pool option for modelling a timeout around session acquisition.#2641

Merged
arpan14 merged 13 commits intogoogleapis:mainfrom
arpan14:session-timeout-pr
Sep 28, 2023
Merged

feat: add session pool option for modelling a timeout around session acquisition.#2641
arpan14 merged 13 commits intogoogleapis:mainfrom
arpan14:session-timeout-pr

Conversation

@arpan14
Copy link
Copy Markdown
Contributor

@arpan14 arpan14 commented Sep 26, 2023

Requests are made to wait till a session is available. We are introducing a session pool option acquireSessionTimeout and a public method setAcquireSessionTimeout in the SessionPoolOptions class that will allow to specify a timeout value for requests. Post this timeout application will receive a RESOURCE_EXHAUSTED error. If this option is not passed, the client library will wait for 60s by default.

  • Sample Usage
SessionPoolOptions sessionPoolOptions =
        SessionPoolOptions.newBuilder().setAcquireSessionTimeout(Duration.ofMillis(60)).build();
SpannerOptions.Builder builder =
        SpannerOptions.newBuilder()
            .setProjectId("my-project")
            .setChannelProvider(channelProvider)
            .setCredentials(NoCredentials.getInstance())
            .setSessionPoolOption(sessionPoolOptions);

@arpan14 arpan14 requested a review from a team September 26, 2023 08:26
@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: spanner Issues related to the googleapis/java-spanner API. labels Sep 26, 2023
@arpan14 arpan14 requested a review from olavloite September 26, 2023 08:30
olavloite
olavloite reviewed Sep 26, 2023
View reviewed changes
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java Outdated
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java Outdated
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolOptions.java
Comment thread google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java Outdated
Comment thread google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java Outdated
Comment thread google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseClientImplTest.java Outdated
Comment thread google-cloud-spanner/src/test/java/com/google/cloud/spanner/SessionPoolOptionsTest.java Outdated
arpan14 and others added 3 commits September 26, 2023 18:58
@arpan14 @olavloite
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Se…
b4d198f 
…ssionPoolOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>
@arpan14 @olavloite
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Se…
3cefc03 
…ssionPoolOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>
@arpan14
chore: address review comments.
5b9cb70
@product-auto-label product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Sep 26, 2023
@arpan14 arpan14 added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Sep 26, 2023
olavloite
olavloite reviewed Sep 28, 2023
View reviewed changes
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java Outdated
olavloite
olavloite reviewed Sep 28, 2023
View reviewed changes
Comment thread google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolOptions.java Outdated
arpan14 and others added 2 commits September 28, 2023 12:12
@arpan14 @olavloite
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Se…
0bc1c03 
…ssionPoolOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>
@arpan14
chore: fix review comments.
e2059d8
@arpan14 arpan14 added owlbot:run Add this label to trigger the Owlbot post processor. and removed do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Sep 28, 2023
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Sep 28, 2023
@gcf-owl-bot gcf-owl-bot bot requested a review from a team September 28, 2023 07:41
@arpan14 arpan14 merged commit 428e294 into googleapis:main Sep 28, 2023
@arpan14 arpan14 deleted the session-timeout-pr branch September 28, 2023 08:24
@release-please release-please bot mentioned this pull request Sep 28, 2023
Merged
surbhigarg92 pushed a commit to surbhigarg92/java-spanner that referenced this pull request Oct 5, 2023
@arpan14 @olavloite
@gcf-owl-bot @surbhigarg92
feat: add session pool option for modelling a timeout around session …
0159966 
…acquisition. (googleapis#2641)

* feat: add session pool option for modelling a timeout around session acquisition.

* docs: modify existing documentation.

* Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

* Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

* chore: address review comments.

* fix: lint errors.

* fix: broken unit test.

* chore: add more unit test.

* fix: review comments.

* fix: NPE in unit test.

* Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPoolOptions.java

Co-authored-by: Knut Olav Løite <koloite@gmail.com>

* chore: fix review comments.

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Knut Olav Løite <koloite@gmail.com>
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@olavloite olavloite olavloite approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

api: spanner Issues related to the googleapis/java-spanner API. size: l Pull request size is large.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@arpan14 @olavloite