Skip to content

feat: support request and transaction tags #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 21, 2025
Merged

feat: support request and transaction tags #558

merged 5 commits into from
Feb 21, 2025

Conversation

olavloite
Copy link
Contributor

Do not merge: Depends on googleapis/python-spanner#1262

Fixes #525

Adds support for setting transaction tags and request tags in dbapi.
This makes these options available to frameworks that depend on
dbapi, like SQLAlchemy and Django.

Towards #525
@olavloite olavloite added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Dec 17, 2024
@product-auto-label product-auto-label bot added the api: spanner Issues related to the googleapis/python-spanner-sqlalchemy API. label Dec 17, 2024
@ahr9n
Copy link

ahr9n commented Dec 19, 2024

Thanks for your support!

BTW, this request_tag = self.execution_options.get("request_tag") means the request tag will be on connecting to spanner engines [so, it will be the same for all the transaction queries -- on transaction level], but it should be on executing queries [to be on query level], right?

transaction_tag = self.execution_options.get("transaction_tag") is making sense, since the whole transaction will belong to one connection.

@olavloite
Copy link
Contributor Author

@ahr9n

BTW, this request_tag = self.execution_options.get("request_tag") means the request tag will be on connecting to spanner engines [so, it will be the same for all the transaction queries -- on transaction level], but it should be on executing queries [to be on query level], right?

You can set execution_options on a lower level than the engine. E.g. it can also be set for specific queries like this:

with Session(engine.execution_options(read_only=True)) as session:
    # Execute two queries in a read-only transaction.
    session.scalars(
        select(Singer).execution_options(request_tag="my-tag-1")
    ).all()
    session.scalars(
        select(Singer).execution_options(request_tag="my-tag-2")
    ).all()

The request tag is then set on the cursor that is being used for the current query:

request_tag = self.execution_options.get("request_tag")
if request_tag:
    self.cursor.request_tag = request_tag

@olavloite olavloite removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Feb 20, 2025
@olavloite olavloite marked this pull request as ready for review February 20, 2025 17:19
@olavloite olavloite requested a review from bhatt4982 February 21, 2025 11:33
Copy link
Contributor

@bhatt4982 bhatt4982 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@bhatt4982 bhatt4982 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@olavloite olavloite merged commit c4496fd into main Feb 21, 2025
16 checks passed
@olavloite olavloite deleted the dbapi-tags branch February 21, 2025 12:32
@parthea parthea added release-please:force-run To run release-please and removed release-please:force-run To run release-please labels Feb 21, 2025
@release-please release-please bot removed the release-please:force-run To run release-please label Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: spanner Issues related to the googleapis/python-spanner-sqlalchemy API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support Spanner Request Options Tags
4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy