google-cloud-bigtable 2.42.0__tar.gz → 2.43.0__tar.gz

{google_cloud_bigtable-2.42.0/google_cloud_bigtable.egg-info → google_cloud_bigtable-2.43.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-bigtable
-Version: 2.42.0
+Version: 2.43.0
 Summary: Google Cloud Bigtable API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigtable
 Author: Google LLC

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable/batcher.py

@@ -186,6 +186,13 @@ class MutationsBatcher(object):
 
     Note on thread safety: The same :class:`MutationBatcher` cannot be shared by multiple end-user threads.
 
+    .. warning::
+
+       If using ``MutationsBatcher``, please ensure you are using
+       ``google-cloud-bigtable >= 2.42.0``, or consider migrating to the
+       batcher provided by the synchronous/asynchronous data client
+       (:mod:`google.cloud.bigtable.data`).
+
     :type table: class
     :param table: class:`~google.cloud.bigtable.table.Table`.
 

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.42.0"  # {x-release-please-version}
+__version__ = "2.43.0"  # {x-release-please-version}

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable/row.py

@@ -231,7 +231,7 @@ class _SetDeleteRow(Row):
         else:
             delete_kwargs = {}
             if time_range is not None:
-                delete_kwargs["time_range"] = time_range.to_pb()
+                delete_kwargs["time_range"] = time_range._to_pb()
 
             to_append = []
             for column in columns:
@@ -602,7 +602,7 @@ class ConditionalRow(_SetDeleteRow):
         resp = data_client.check_and_mutate_row(
             table_name=self._table.name,
             row_key=self._row_key,
-            predicate_filter=self._filter.to_pb(),
+            predicate_filter=self._filter._to_pb(),
             app_profile_id=self._table._app_profile_id,
             true_mutations=true_mutations,
             false_mutations=false_mutations,

google_cloud_bigtable-2.43.0/google/cloud/bigtable/row_filters.py

@@ -0,0 +1,232 @@
+# Copyright 2016 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.
+
+"""Filters for Google Cloud Bigtable Row classes."""
+
+import struct
+
+from google.cloud.bigtable.data.row_filters import (  # noqa: F401
+    RowFilter,
+    SinkFilter,
+    _BoolFilter,
+    PassAllFilter,
+    BlockAllFilter,
+    _RegexFilter,
+    RowKeyRegexFilter,
+    RowSampleFilter,
+    FamilyNameRegexFilter,
+    ColumnQualifierRegexFilter,
+    TimestampRange,
+    TimestampRangeFilter as BaseTimestampRangeFilter,
+    ColumnRangeFilter as BaseColumnRangeFilter,
+    ValueRegexFilter,
+    ValueRangeFilter,
+    ValueBitmaskFilter,
+    _CellCountFilter,
+    CellsRowOffsetFilter,
+    CellsRowLimitFilter,
+    CellsColumnLimitFilter,
+    StripValueTransformerFilter,
+    ApplyLabelFilter,
+    _FilterCombination,
+    RowFilterChain,
+    RowFilterUnion,
+    ConditionalRowFilter as BaseConditionalRowFilter,
+)
+
+_PACK_I64 = struct.Struct(">q").pack
+
+
+def _deprecated_to_pb(self):
+    import warnings
+
+    warnings.warn(
+        "`to_pb()` is deprecated and will be removed in a future release. "
+        "Filter objects should be passed directly to Bigtable client read and query "
+        "methods without manual protobuf conversion.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return self._to_pb()
+
+
+# Provide to_pb alias with DeprecationWarning for backwards compatibility with legacy client code
+RowFilter.to_pb = _deprecated_to_pb  # type: ignore[attr-defined]
+TimestampRange.to_pb = _deprecated_to_pb  # type: ignore[attr-defined]
+
+
+class _MappableAttributesMixin:
+    """
+    Mixin for classes that need some of their attribute names remapped.
+
+    This is for taking some of the classes from the data client row filters
+    that are 1:1 with their legacy client counterparts but with some of their
+    attributes renamed. To use in a class, override the base class with this mixin
+    class and define a map _attribute_map from legacy client attributes to data client
+    attributes.
+
+    Attributes are remapped and redefined in __init__ as well as getattr/setattr.
+    """
+
+    def __init__(self, *args, **kwargs):
+        new_kwargs = {self._attribute_map.get(k, k): v for (k, v) in kwargs.items()}
+        super(_MappableAttributesMixin, self).__init__(*args, **new_kwargs)
+
+    def __getattr__(self, name):
+        if name not in self._attribute_map:
+            raise AttributeError
+        return getattr(self, self._attribute_map[name])
+
+    def __setattr__(self, name, value):
+        attribute = self._attribute_map.get(name, name)
+        super(_MappableAttributesMixin, self).__setattr__(attribute, value)
+
+
+# The classes defined below are to provide constructors and members
+# that have an interface that does not match the one used by the data
+# client, for backwards compatibility purposes.
+
+# Each underscored class is an ABC. Make them into classes that can be
+# instantiated with a placeholder to_dict method for consistency.
+
+
+class TimestampRangeFilter(BaseTimestampRangeFilter):
+    """Row filter that limits cells to a range of time.
+
+    :type range_: :class:`TimestampRange`
+    :param range_: Range of time that cells should match against.
+    """
+
+    def __init__(self, range_):
+        self.range_ = range_
+
+
+class ExactValueFilter(ValueRegexFilter):
+    """Row filter for an exact value.
+
+
+    :type value: bytes or str or int
+    :param value:
+        a literal string encodable as ASCII, or the
+        equivalent bytes, or an integer (which will be packed into 8-bytes).
+    """
+
+    def __init__(self, value):
+        if isinstance(value, int):
+            value = _PACK_I64(value)
+        super(ExactValueFilter, self).__init__(value)
+
+
+class ColumnRangeFilter(_MappableAttributesMixin, BaseColumnRangeFilter):
+    """A row filter to restrict to a range of columns.
+
+    Both the start and end column can be included or excluded in the range.
+    By default, we include them both, but this can be changed with optional
+    flags.
+
+    :type column_family_id: str
+    :param column_family_id: The column family that contains the columns. Must
+                             be of the form ``[_a-zA-Z0-9][-_.a-zA-Z0-9]*``.
+
+    :type start_column: bytes
+    :param start_column: The start of the range of columns. If no value is
+                         used, the backend applies no upper bound to the
+                         values.
+
+    :type end_column: bytes
+    :param end_column: The end of the range of columns. If no value is used,
+                       the backend applies no upper bound to the values.
+
+    :type inclusive_start: bool
+    :param inclusive_start: Boolean indicating if the start column should be
+                            included in the range (or excluded). Defaults
+                            to :data:`True` if ``start_column`` is passed and
+                            no ``inclusive_start`` was given.
+
+    :type inclusive_end: bool
+    :param inclusive_end: Boolean indicating if the end column should be
+                          included in the range (or excluded). Defaults
+                          to :data:`True` if ``end_column`` is passed and
+                          no ``inclusive_end`` was given.
+
+    :raises: :class:`ValueError <exceptions.ValueError>` if ``inclusive_start``
+             is set but no ``start_column`` is given or if ``inclusive_end``
+             is set but no ``end_column`` is given
+    """
+
+    _attribute_map = {
+        "column_family_id": "family_id",
+        "start_column": "start_qualifier",
+        "end_column": "end_qualifier",
+    }
+
+
+class ConditionalRowFilter(_MappableAttributesMixin, BaseConditionalRowFilter):
+    """Conditional row filter which exhibits ternary behavior.
+
+    Executes one of two filters based on another filter. If the ``base_filter``
+    returns any cells in the row, then ``true_filter`` is executed. If not,
+    then ``false_filter`` is executed.
+
+    .. note::
+
+        The ``base_filter`` does not execute atomically with the true and false
+        filters, which may lead to inconsistent or unexpected results.
+
+        Additionally, executing a :class:`ConditionalRowFilter` has poor
+        performance on the server, especially when ``false_filter`` is set.
+
+    :type base_filter: :class:`RowFilter`
+    :param base_filter: The filter to condition on before executing the
+                        true/false filters.
+
+    :type true_filter: :class:`RowFilter`
+    :param true_filter: (Optional) The filter to execute if there are any cells
+                        matching ``base_filter``. If not provided, no results
+                        will be returned in the true case.
+
+    :type false_filter: :class:`RowFilter`
+    :param false_filter: (Optional) The filter to execute if there are no cells
+                         matching ``base_filter``. If not provided, no results
+                         will be returned in the false case.
+    """
+
+    _attribute_map = {"base_filter": "predicate_filter"}
+
+
+__all__ = (
+    "RowFilter",
+    "SinkFilter",
+    "PassAllFilter",
+    "BlockAllFilter",
+    "RowKeyRegexFilter",
+    "RowSampleFilter",
+    "FamilyNameRegexFilter",
+    "ColumnQualifierRegexFilter",
+    "TimestampRange",
+    "TimestampRangeFilter",
+    "ColumnRangeFilter",
+    "ValueRegexFilter",
+    "ExactValueFilter",
+    "ValueRangeFilter",
+    "ValueBitmaskFilter",
+    "CellsRowOffsetFilter",
+    "CellsRowLimitFilter",
+    "CellsColumnLimitFilter",
+    "StripValueTransformerFilter",
+    "ApplyLabelFilter",
+    "RowFilterChain",
+    "RowFilterUnion",
+    "ConditionalRowFilter",
+)

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable/table.py

@@ -873,6 +873,13 @@ class Table(object):
             :end-before: [END bigtable_api_mutations_batcher]
             :dedent: 4
 
+        .. warning::
+
+           If using ``MutationsBatcher``, please ensure you are using
+           ``google-cloud-bigtable >= 2.42.0``, or consider migrating to the
+           batcher provided by the synchronous/asynchronous data client
+           (:mod:`google.cloud.bigtable.data`).
+
         :type flush_count: int
         :param flush_count: (Optional) Maximum number of rows per batch. If it
                 reaches the max number of rows it calls finish_batch() to
@@ -1328,7 +1335,7 @@ def _create_row_request(
         raise ValueError("Row range and row set cannot be set simultaneously")
 
     if filter_ is not None:
-        request_kwargs["filter"] = filter_.to_pb()
+        request_kwargs["filter"] = filter_._to_pb()
     if limit is not None:
         request_kwargs["rows_limit"] = limit
     if app_profile_id is not None:

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable_admin/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.42.0"  # {x-release-please-version}
+__version__ = "2.43.0"  # {x-release-please-version}

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable_admin_v2/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.42.0"  # {x-release-please-version}
+__version__ = "2.43.0"  # {x-release-please-version}

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable_v2/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "2.42.0"  # {x-release-please-version}
+__version__ = "2.43.0"  # {x-release-please-version}

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/google/cloud/bigtable_v2/types/feature_flags.py

@@ -84,6 +84,9 @@ class FeatureFlags(proto.Message):
         sessions_required (bool):
             Internal flag to force sessions for internal
             projects.
+        microsecond_timestamp (bool):
+            Optional. Indicates whether the client
+            supports microsecond precision timestamps.
     """
 
     reverse_scans: bool = proto.Field(
@@ -134,6 +137,10 @@ class FeatureFlags(proto.Message):
         proto.BOOL,
         number=13,
     )
+    microsecond_timestamp: bool = proto.Field(
+        proto.BOOL,
+        number=14,
+    )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0/google_cloud_bigtable.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-bigtable
-Version: 2.42.0
+Version: 2.43.0
 Summary: Google Cloud Bigtable API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-bigtable
 Author: Google LLC

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/tests/unit/v2_client/test_row.py

@@ -283,7 +283,7 @@ def _delete_cells_helper(time_range=None):
         )
     )
     if time_range is not None:
-        expected_pb.delete_from_column.time_range._pb.CopyFrom(time_range.to_pb()._pb)
+        expected_pb.delete_from_column.time_range._pb.CopyFrom(time_range._to_pb()._pb)
     assert row._pb_mutations == [expected_pb]
 
 

{google_cloud_bigtable-2.42.0 → google_cloud_bigtable-2.43.0}/tests/unit/v2_client/test_row_data.py

@@ -937,7 +937,7 @@ def test_RRRM_build_updated_request(rrrm_data):
     row_filter = RowSampleFilter(0.33)
     last_scanned_key = b"row_key25"
     request = _ReadRowsRequestPB(
-        filter=row_filter.to_pb(),
+        filter=row_filter._to_pb(),
         rows_limit=8,
         table_name=TABLE_NAME,
         app_profile_id="app-profile-id-1",
@@ -950,7 +950,7 @@ def test_RRRM_build_updated_request(rrrm_data):
 
     expected_result = _ReadRowsRequestPB(
         table_name=TABLE_NAME,
-        filter=row_filter.to_pb(),
+        filter=row_filter._to_pb(),
         rows_limit=6,
         app_profile_id="app-profile-id-1",
     )
@@ -985,7 +985,7 @@ def test_RRRM_build_updated_request_no_start_key():
     row_filter = RowSampleFilter(0.33)
     last_scanned_key = b"row_key25"
     request = _ReadRowsRequestPB(
-        filter=row_filter.to_pb(), rows_limit=8, table_name=TABLE_NAME
+        filter=row_filter._to_pb(), rows_limit=8, table_name=TABLE_NAME
     )
     row_range1 = types.RowRange(end_key_open=b"row_key29")
     request.rows.row_ranges.append(row_range1)
@@ -995,7 +995,7 @@ def test_RRRM_build_updated_request_no_start_key():
     result = request_manager.build_updated_request()
 
     expected_result = _ReadRowsRequestPB(
-        table_name=TABLE_NAME, filter=row_filter.to_pb(), rows_limit=6
+        table_name=TABLE_NAME, filter=row_filter._to_pb(), rows_limit=6
     )
 
     row_range2 = types.RowRange(
@@ -1013,7 +1013,7 @@ def test_RRRM_build_updated_request_no_end_key():
     row_filter = RowSampleFilter(0.33)
     last_scanned_key = b"row_key25"
     request = _ReadRowsRequestPB(
-        filter=row_filter.to_pb(), rows_limit=8, table_name=TABLE_NAME
+        filter=row_filter._to_pb(), rows_limit=8, table_name=TABLE_NAME
     )
 
     row_range1 = types.RowRange(start_key_closed=b"row_key20")
@@ -1024,7 +1024,7 @@ def test_RRRM_build_updated_request_no_end_key():
     result = request_manager.build_updated_request()
 
     expected_result = _ReadRowsRequestPB(
-        table_name=TABLE_NAME, filter=row_filter.to_pb(), rows_limit=6
+        table_name=TABLE_NAME, filter=row_filter._to_pb(), rows_limit=6
     )
     row_range2 = types.RowRange(start_key_open=last_scanned_key)
     expected_result.rows.row_ranges.append(row_range2)
@@ -1038,7 +1038,7 @@ def test_RRRM_build_updated_request_rows():
     row_filter = RowSampleFilter(0.33)
     last_scanned_key = b"row_key4"
     request = _ReadRowsRequestPB(
-        filter=row_filter.to_pb(), rows_limit=5, table_name=TABLE_NAME
+        filter=row_filter._to_pb(), rows_limit=5, table_name=TABLE_NAME
     )
     request.rows.row_keys.extend(
         [b"row_key1", b"row_key2", b"row_key4", b"row_key5", b"row_key7", b"row_key9"]
@@ -1049,7 +1049,7 @@ def test_RRRM_build_updated_request_rows():
     result = request_manager.build_updated_request()
 
     expected_result = _ReadRowsRequestPB(
-        table_name=TABLE_NAME, filter=row_filter.to_pb(), rows_limit=2
+        table_name=TABLE_NAME, filter=row_filter._to_pb(), rows_limit=2
     )
     expected_result.rows.row_keys.extend([b"row_key5", b"row_key7", b"row_key9"])