Skip to content

[Python] Deprecate native SpannerIO implementation (#35860) #37609

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.

Sign up for GitHub

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
Kaustubh1204 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Python] Deprecate native SpannerIO implementation (#35860) #37609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions sdks/python/apache_beam/io/gcp/experimental/spannerio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
This is an experimental module for reading and writing data from Google Cloud
Spanner. Visit: https://cloud.google.com/spanner for more details.

.. deprecated:: 2.68
Native Python SpannerIO is deprecated and will be removed in Beam 3.0.
Use the cross-language SpannerIO available in apache_beam.io.gcp.spanner instead.


Reading Data from Cloud Spanner.

To read from Cloud Spanner apply ReadFromSpanner transformation. It will
Expand Down Expand Up @@ -169,6 +174,7 @@
column does not exits, it will cause a exception and fails the entire pipeline.
"""
import typing
import warnings
from collections import deque
from collections import namedtuple

Expand Down Expand Up @@ -218,6 +224,12 @@
# Ignoring for environments where the Spanner library is not available.
pass

_DEPRECATION_MESSAGE = (
"Native Python SpannerIO is deprecated and will be removed in Beam 3.0. "
"Use the cross-language SpannerIO available in apache_beam.io.gcp.spanner instead."
)
warnings.warn(_DEPRECATION_MESSAGE, DeprecationWarning)

__all__ = [
'create_transaction',
'ReadFromSpanner',
Expand All @@ -241,9 +253,12 @@ class ReadOperation(namedtuple(
"""
Encapsulates a spanner read operation.
"""

__slots__ = ()

@deprecated(since='2.68', extra_message=_DEPRECATION_MESSAGE)
def __new__(cls, *args, **kwargs):
return super(ReadOperation, cls).__new__(cls, *args, **kwargs)

@classmethod
def query(cls, sql, params=None, param_types=None):
"""
Expand Down Expand Up @@ -535,6 +550,7 @@ def process(self, element, *args, **kwargs):
return [_SPANNER_TRANSACTION(self._snapshot.to_dict())]


@deprecated(since='2.68', extra_message=_DEPRECATION_MESSAGE)
@ptransform_fn
def create_transaction(
pbegin,
Expand Down Expand Up @@ -670,7 +686,10 @@ def teardown(self):
self._snapshot.close()


@deprecated(since='2.68', current='apache_beam.io.gcp.spanner.ReadFromSpanner')
@deprecated(
since='2.68',
current='apache_beam.io.gcp.spanner.ReadFromSpanner',
extra_message=_DEPRECATION_MESSAGE)
class ReadFromSpanner(PTransform):
"""
A PTransform to perform reads from cloud spanner.
Expand Down Expand Up @@ -822,7 +841,9 @@ def display_data(self):


@deprecated(
since='2.68', current='apache_beam.io.gcp.spanner.WriteToSpannerSchema')
since='2.68',
current='apache_beam.io.gcp.spanner',
extra_message=_DEPRECATION_MESSAGE)
class WriteToSpanner(PTransform):
def __init__(
self,
Expand Down Expand Up @@ -915,6 +936,10 @@ class MutationGroup(deque):
"""
A Bundle of Spanner Mutations (_Mutator).
"""
@deprecated(since='2.68', extra_message=_DEPRECATION_MESSAGE)
def __init__(self, *args, **kwargs):
super(MutationGroup, self).__init__(*args, **kwargs)

@property
def info(self):
cells = 0
Expand All @@ -938,6 +963,7 @@ class WriteMutation(object):
_OPERATION_REPLACE = "replace"
_OPERATION_UPDATE = "update"

@deprecated(since='2.68', extra_message=_DEPRECATION_MESSAGE)
def __init__(
self,
insert=None,
Expand Down
Loading