-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat: Implement initial Google Cloud Spanner DB-API 2.0 driver #16157
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
Open
bhatt4982
wants to merge
2
commits into
dbapi-driver
Choose a base branch
from
dbapi-driver-1
base: dbapi-driver
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
138 changes: 138 additions & 0 deletions
138
packages/google-cloud-spanner-dbapi-driver/google/cloud/spanner_driver/connection.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| import logging | ||
| from typing import Any | ||
|
|
||
| from google.cloud.spannerlib.pool import Pool | ||
|
|
||
| from . import errors | ||
| from .cursor import Cursor | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def check_not_closed(function): | ||
| """`Connection` class methods decorator. | ||
|
|
||
| Raise an exception if the connection is closed. | ||
|
|
||
| :raises: :class:`InterfaceError` if the connection is closed. | ||
| """ | ||
|
|
||
| def wrapper(connection, *args, **kwargs): | ||
| if connection._closed: | ||
| raise errors.InterfaceError("Connection is closed") | ||
|
|
||
| return function(connection, *args, **kwargs) | ||
|
|
||
| return wrapper | ||
|
|
||
|
|
||
| class Connection: | ||
| """Connection to a Google Cloud Spanner database. | ||
|
|
||
| This class provides a connection to the Spanner database and adheres to | ||
| PEP 249 (Python Database API Specification v2.0). | ||
| """ | ||
|
|
||
| def __init__(self, internal_connection: Any): | ||
| """ | ||
| Args: | ||
| internal_connection: An instance of | ||
| google.cloud.spannerlib.Connection | ||
| """ | ||
| self._internal_conn = internal_connection | ||
| self._closed = False | ||
| self._messages: list[Any] = [] | ||
|
|
||
| @property | ||
| def messages(self) -> list[Any]: | ||
| """Return the list of messages sent to the client by the database.""" | ||
| return self._messages | ||
|
|
||
| @check_not_closed | ||
| def cursor(self) -> Cursor: | ||
| """Return a new Cursor Object using the connection. | ||
|
|
||
| Returns: | ||
| Cursor: A cursor object. | ||
| """ | ||
| return Cursor(self) | ||
|
|
||
| @check_not_closed | ||
| def begin(self) -> None: | ||
| """Begin a new transaction.""" | ||
| logger.debug("Beginning transaction") | ||
| try: | ||
| self._internal_conn.begin_transaction() | ||
| except Exception as e: | ||
| raise errors.map_spanner_error(e) | ||
|
|
||
| @check_not_closed | ||
| def commit(self) -> None: | ||
| """Commit any pending transaction to the database. | ||
|
|
||
| This is a no-op if there is no active client transaction. | ||
| """ | ||
| logger.debug("Committing transaction") | ||
| try: | ||
| self._internal_conn.commit() | ||
| except Exception as e: | ||
| logger.debug(f"Commit failed {e}") | ||
bhatt4982 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| raise errors.map_spanner_error(e) | ||
|
|
||
| @check_not_closed | ||
| def rollback(self) -> None: | ||
| """Rollback any pending transaction to the database. | ||
|
|
||
| This is a no-op if there is no active client transaction. | ||
| """ | ||
| logger.debug("Rolling back transaction") | ||
| try: | ||
| self._internal_conn.rollback() | ||
| except Exception as e: | ||
| logger.debug(f"Rollback failed {e}") | ||
bhatt4982 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| raise errors.map_spanner_error(e) | ||
|
|
||
| def close(self) -> None: | ||
| """Close the connection now. | ||
|
|
||
| The connection will be unusable from this point forward; an Error (or | ||
| subclass) exception will be raised if any operation is attempted with | ||
| the connection. The same applies to all cursor objects trying to use | ||
| the connection. | ||
| """ | ||
| if self._closed: | ||
| raise errors.InterfaceError("Connection is already closed") | ||
|
|
||
| logger.debug("Closing connection") | ||
| self._internal_conn.close() | ||
| self._closed = True | ||
|
|
||
| def __enter__(self) -> "Connection": | ||
| return self | ||
|
|
||
| def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None: | ||
| self.close() | ||
|
|
||
|
|
||
| def connect(connection_string: str) -> Connection: | ||
| logger.debug(f"Connecting to {connection_string}") | ||
| # Create the pool | ||
| pool = Pool.create_pool(connection_string) | ||
|
|
||
| # Create the low-level connection | ||
| internal_conn = pool.create_connection() | ||
|
|
||
| return Connection(internal_conn) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.