google-cloud-bigtable 2.30.0__py3-none-any.whl

google/cloud/bigtable/data/_sync_autogen/mutations_batcher.py

@@ -0,0 +1,449 @@
+# Copyright 2024 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.
+#
+
+# This file is automatically generated by CrossSync. Do not edit manually.
+
+from __future__ import annotations
+from typing import Sequence, TYPE_CHECKING, cast
+import atexit
+import warnings
+from collections import deque
+import concurrent.futures
+from google.cloud.bigtable.data.exceptions import MutationsExceptionGroup
+from google.cloud.bigtable.data.exceptions import FailedMutationEntryError
+from google.cloud.bigtable.data._helpers import _get_retryable_errors
+from google.cloud.bigtable.data._helpers import _get_timeouts
+from google.cloud.bigtable.data._helpers import TABLE_DEFAULT
+from google.cloud.bigtable.data.mutations import _MUTATE_ROWS_REQUEST_MUTATION_LIMIT
+from google.cloud.bigtable.data.mutations import Mutation
+from google.cloud.bigtable.data._cross_sync import CrossSync
+
+if TYPE_CHECKING:
+    from google.cloud.bigtable.data.mutations import RowMutationEntry
+    from google.cloud.bigtable.data._sync_autogen.client import Table as TableType
+_MB_SIZE = 1024 * 1024
+
+
+@CrossSync._Sync_Impl.add_mapping_decorator("_FlowControl")
+class _FlowControl:
+    """
+    Manages flow control for batched mutations. Mutations are registered against
+    the FlowControl object before being sent, which will block if size or count
+    limits have reached capacity. As mutations completed, they are removed from
+    the FlowControl object, which will notify any blocked requests that there
+    is additional capacity.
+
+    Flow limits are not hard limits. If a single mutation exceeds the configured
+    limits, it will be allowed as a single batch when the capacity is available.
+
+    Args:
+        max_mutation_count: maximum number of mutations to send in a single rpc.
+            This corresponds to individual mutations in a single RowMutationEntry.
+        max_mutation_bytes: maximum number of bytes to send in a single rpc.
+    Raises:
+        ValueError: if max_mutation_count or max_mutation_bytes is less than 0
+    """
+
+    def __init__(self, max_mutation_count: int, max_mutation_bytes: int):
+        self._max_mutation_count = max_mutation_count
+        self._max_mutation_bytes = max_mutation_bytes
+        if self._max_mutation_count < 1:
+            raise ValueError("max_mutation_count must be greater than 0")
+        if self._max_mutation_bytes < 1:
+            raise ValueError("max_mutation_bytes must be greater than 0")
+        self._capacity_condition = CrossSync._Sync_Impl.Condition()
+        self._in_flight_mutation_count = 0
+        self._in_flight_mutation_bytes = 0
+
+    def _has_capacity(self, additional_count: int, additional_size: int) -> bool:
+        """Checks if there is capacity to send a new entry with the given size and count
+
+        FlowControl limits are not hard limits. If a single mutation exceeds
+        the configured flow limits, it will be sent in a single batch when
+        previous batches have completed.
+
+        Args:
+            additional_count: number of mutations in the pending entry
+            additional_size: size of the pending entry
+        Returns:
+            bool: True if there is capacity to send the pending entry, False otherwise
+        """
+        acceptable_size = max(self._max_mutation_bytes, additional_size)
+        acceptable_count = max(self._max_mutation_count, additional_count)
+        new_size = self._in_flight_mutation_bytes + additional_size
+        new_count = self._in_flight_mutation_count + additional_count
+        return new_size <= acceptable_size and new_count <= acceptable_count
+
+    def remove_from_flow(
+        self, mutations: RowMutationEntry | list[RowMutationEntry]
+    ) -> None:
+        """Removes mutations from flow control. This method should be called once
+        for each mutation that was sent to add_to_flow, after the corresponding
+        operation is complete.
+
+        Args:
+            mutations: mutation or list of mutations to remove from flow control"""
+        if not isinstance(mutations, list):
+            mutations = [mutations]
+        total_count = sum((len(entry.mutations) for entry in mutations))
+        total_size = sum((entry.size() for entry in mutations))
+        self._in_flight_mutation_count -= total_count
+        self._in_flight_mutation_bytes -= total_size
+        with self._capacity_condition:
+            self._capacity_condition.notify_all()
+
+    def add_to_flow(self, mutations: RowMutationEntry | list[RowMutationEntry]):
+        """Generator function that registers mutations with flow control. As mutations
+        are accepted into the flow control, they are yielded back to the caller,
+        to be sent in a batch. If the flow control is at capacity, the generator
+        will block until there is capacity available.
+
+        Args:
+            mutations: list mutations to break up into batches
+        Yields:
+            list[RowMutationEntry]:
+                list of mutations that have reserved space in the flow control.
+                Each batch contains at least one mutation."""
+        if not isinstance(mutations, list):
+            mutations = [mutations]
+        start_idx = 0
+        end_idx = 0
+        while end_idx < len(mutations):
+            start_idx = end_idx
+            batch_mutation_count = 0
+            with self._capacity_condition:
+                while end_idx < len(mutations):
+                    next_entry = mutations[end_idx]
+                    next_size = next_entry.size()
+                    next_count = len(next_entry.mutations)
+                    if (
+                        self._has_capacity(next_count, next_size)
+                        and batch_mutation_count + next_count
+                        <= _MUTATE_ROWS_REQUEST_MUTATION_LIMIT
+                    ):
+                        end_idx += 1
+                        batch_mutation_count += next_count
+                        self._in_flight_mutation_bytes += next_size
+                        self._in_flight_mutation_count += next_count
+                    elif start_idx != end_idx:
+                        break
+                    else:
+                        self._capacity_condition.wait_for(
+                            lambda: self._has_capacity(next_count, next_size)
+                        )
+            yield mutations[start_idx:end_idx]
+
+
+class MutationsBatcher:
+    """
+    Allows users to send batches using context manager API:
+
+    Runs mutate_row,  mutate_rows, and check_and_mutate_row internally, combining
+    to use as few network requests as required
+
+    Will automatically flush the batcher:
+    - every flush_interval seconds
+    - after queue size reaches flush_limit_mutation_count
+    - after queue reaches flush_limit_bytes
+    - when batcher is closed or destroyed
+
+    Args:
+        table: Table to preform rpc calls
+        flush_interval: Automatically flush every flush_interval seconds.
+            If None, no time-based flushing is performed.
+        flush_limit_mutation_count: Flush immediately after flush_limit_mutation_count
+            mutations are added across all entries. If None, this limit is ignored.
+        flush_limit_bytes: Flush immediately after flush_limit_bytes bytes are added.
+        flow_control_max_mutation_count: Maximum number of inflight mutations.
+        flow_control_max_bytes: Maximum number of inflight bytes.
+        batch_operation_timeout: timeout for each mutate_rows operation, in seconds.
+            If TABLE_DEFAULT, defaults to the Table's default_mutate_rows_operation_timeout.
+        batch_attempt_timeout: timeout for each individual request, in seconds.
+            If TABLE_DEFAULT, defaults to the Table's default_mutate_rows_attempt_timeout.
+            If None, defaults to batch_operation_timeout.
+        batch_retryable_errors: a list of errors that will be retried if encountered.
+            Defaults to the Table's default_mutate_rows_retryable_errors.
+    """
+
+    def __init__(
+        self,
+        table: TableType,
+        *,
+        flush_interval: float | None = 5,
+        flush_limit_mutation_count: int | None = 1000,
+        flush_limit_bytes: int = 20 * _MB_SIZE,
+        flow_control_max_mutation_count: int = 100000,
+        flow_control_max_bytes: int = 100 * _MB_SIZE,
+        batch_operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
+        batch_attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
+        batch_retryable_errors: Sequence[type[Exception]]
+        | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
+    ):
+        (self._operation_timeout, self._attempt_timeout) = _get_timeouts(
+            batch_operation_timeout, batch_attempt_timeout, table
+        )
+        self._retryable_errors: list[type[Exception]] = _get_retryable_errors(
+            batch_retryable_errors, table
+        )
+        self._closed = CrossSync._Sync_Impl.Event()
+        self._table = table
+        self._staged_entries: list[RowMutationEntry] = []
+        (self._staged_count, self._staged_bytes) = (0, 0)
+        self._flow_control = CrossSync._Sync_Impl._FlowControl(
+            flow_control_max_mutation_count, flow_control_max_bytes
+        )
+        self._flush_limit_bytes = flush_limit_bytes
+        self._flush_limit_count = (
+            flush_limit_mutation_count
+            if flush_limit_mutation_count is not None
+            else float("inf")
+        )
+        self._sync_rpc_executor = (
+            concurrent.futures.ThreadPoolExecutor(max_workers=8)
+            if not CrossSync._Sync_Impl.is_async
+            else None
+        )
+        self._sync_flush_executor = (
+            concurrent.futures.ThreadPoolExecutor(max_workers=4)
+            if not CrossSync._Sync_Impl.is_async
+            else None
+        )
+        self._flush_timer = CrossSync._Sync_Impl.create_task(
+            self._timer_routine, flush_interval, sync_executor=self._sync_flush_executor
+        )
+        self._flush_jobs: set[CrossSync._Sync_Impl.Future[None]] = set()
+        self._entries_processed_since_last_raise: int = 0
+        self._exceptions_since_last_raise: int = 0
+        self._exception_list_limit: int = 10
+        self._oldest_exceptions: list[Exception] = []
+        self._newest_exceptions: deque[Exception] = deque(
+            maxlen=self._exception_list_limit
+        )
+        atexit.register(self._on_exit)
+
+    def _timer_routine(self, interval: float | None) -> None:
+        """Set up a background task to flush the batcher every interval seconds
+
+        If interval is None, an empty future is returned
+
+        Args:
+            flush_interval: Automatically flush every flush_interval seconds.
+                If None, no time-based flushing is performed."""
+        if not interval or interval <= 0:
+            return None
+        while not self._closed.is_set():
+            CrossSync._Sync_Impl.event_wait(
+                self._closed, timeout=interval, async_break_early=False
+            )
+            if not self._closed.is_set() and self._staged_entries:
+                self._schedule_flush()
+
+    def append(self, mutation_entry: RowMutationEntry):
+        """Add a new set of mutations to the internal queue
+
+        Args:
+            mutation_entry: new entry to add to flush queue
+        Raises:
+            RuntimeError: if batcher is closed
+            ValueError: if an invalid mutation type is added"""
+        if self._closed.is_set():
+            raise RuntimeError("Cannot append to closed MutationsBatcher")
+        if isinstance(cast(Mutation, mutation_entry), Mutation):
+            raise ValueError(
+                f"invalid mutation type: {type(mutation_entry).__name__}. Only RowMutationEntry objects are supported by batcher"
+            )
+        self._staged_entries.append(mutation_entry)
+        self._staged_count += len(mutation_entry.mutations)
+        self._staged_bytes += mutation_entry.size()
+        if (
+            self._staged_count >= self._flush_limit_count
+            or self._staged_bytes >= self._flush_limit_bytes
+        ):
+            self._schedule_flush()
+            CrossSync._Sync_Impl.yield_to_event_loop()
+
+    def _schedule_flush(self) -> CrossSync._Sync_Impl.Future[None] | None:
+        """Update the flush task to include the latest staged entries
+
+        Returns:
+            Future[None] | None:
+                future representing the background task, if started"""
+        if self._staged_entries:
+            (entries, self._staged_entries) = (self._staged_entries, [])
+            (self._staged_count, self._staged_bytes) = (0, 0)
+            new_task = CrossSync._Sync_Impl.create_task(
+                self._flush_internal, entries, sync_executor=self._sync_flush_executor
+            )
+            if not new_task.done():
+                self._flush_jobs.add(new_task)
+                new_task.add_done_callback(self._flush_jobs.remove)
+            return new_task
+        return None
+
+    def _flush_internal(self, new_entries: list[RowMutationEntry]):
+        """Flushes a set of mutations to the server, and updates internal state
+
+        Args:
+            new_entries list of RowMutationEntry objects to flush"""
+        in_process_requests: list[
+            CrossSync._Sync_Impl.Future[list[FailedMutationEntryError]]
+        ] = []
+        for batch in self._flow_control.add_to_flow(new_entries):
+            batch_task = CrossSync._Sync_Impl.create_task(
+                self._execute_mutate_rows, batch, sync_executor=self._sync_rpc_executor
+            )
+            in_process_requests.append(batch_task)
+        found_exceptions = self._wait_for_batch_results(*in_process_requests)
+        self._entries_processed_since_last_raise += len(new_entries)
+        self._add_exceptions(found_exceptions)
+
+    def _execute_mutate_rows(
+        self, batch: list[RowMutationEntry]
+    ) -> list[FailedMutationEntryError]:
+        """Helper to execute mutation operation on a batch
+
+        Args:
+            batch: list of RowMutationEntry objects to send to server
+            timeout: timeout in seconds. Used as operation_timeout and attempt_timeout.
+                If not given, will use table defaults
+        Returns:
+            list[FailedMutationEntryError]:
+                list of FailedMutationEntryError objects for mutations that failed.
+                FailedMutationEntryError objects will not contain index information"""
+        try:
+            operation = CrossSync._Sync_Impl._MutateRowsOperation(
+                self._table.client._gapic_client,
+                self._table,
+                batch,
+                operation_timeout=self._operation_timeout,
+                attempt_timeout=self._attempt_timeout,
+                retryable_exceptions=self._retryable_errors,
+            )
+            operation.start()
+        except MutationsExceptionGroup as e:
+            for subexc in e.exceptions:
+                subexc.index = None
+            return list(e.exceptions)
+        finally:
+            self._flow_control.remove_from_flow(batch)
+        return []
+
+    def _add_exceptions(self, excs: list[Exception]):
+        """Add new list of exceptions to internal store. To avoid unbounded memory,
+        the batcher will store the first and last _exception_list_limit exceptions,
+        and discard any in between.
+
+        Args:
+            excs: list of exceptions to add to the internal store"""
+        self._exceptions_since_last_raise += len(excs)
+        if excs and len(self._oldest_exceptions) < self._exception_list_limit:
+            addition_count = self._exception_list_limit - len(self._oldest_exceptions)
+            self._oldest_exceptions.extend(excs[:addition_count])
+            excs = excs[addition_count:]
+        if excs:
+            self._newest_exceptions.extend(excs[-self._exception_list_limit :])
+
+    def _raise_exceptions(self):
+        """Raise any unreported exceptions from background flush operations
+
+        Raises:
+            MutationsExceptionGroup: exception group with all unreported exceptions"""
+        if self._oldest_exceptions or self._newest_exceptions:
+            (oldest, self._oldest_exceptions) = (self._oldest_exceptions, [])
+            newest = list(self._newest_exceptions)
+            self._newest_exceptions.clear()
+            (entry_count, self._entries_processed_since_last_raise) = (
+                self._entries_processed_since_last_raise,
+                0,
+            )
+            (exc_count, self._exceptions_since_last_raise) = (
+                self._exceptions_since_last_raise,
+                0,
+            )
+            raise MutationsExceptionGroup.from_truncated_lists(
+                first_list=oldest,
+                last_list=newest,
+                total_excs=exc_count,
+                entry_count=entry_count,
+            )
+
+    def __enter__(self):
+        """Allow use of context manager API"""
+        return self
+
+    def __exit__(self, exc_type, exc, tb):
+        """Allow use of context manager API.
+
+        Flushes the batcher and cleans up resources."""
+        self.close()
+
+    @property
+    def closed(self) -> bool:
+        """Returns:
+        - True if the batcher is closed, False otherwise"""
+        return self._closed.is_set()
+
+    def close(self):
+        """Flush queue and clean up resources"""
+        self._closed.set()
+        self._flush_timer.cancel()
+        self._schedule_flush()
+        if self._sync_flush_executor:
+            with self._sync_flush_executor:
+                self._sync_flush_executor.shutdown(wait=True)
+        if self._sync_rpc_executor:
+            with self._sync_rpc_executor:
+                self._sync_rpc_executor.shutdown(wait=True)
+        CrossSync._Sync_Impl.wait([*self._flush_jobs, self._flush_timer])
+        atexit.unregister(self._on_exit)
+        self._raise_exceptions()
+
+    def _on_exit(self):
+        """Called when program is exited. Raises warning if unflushed mutations remain"""
+        if not self._closed.is_set() and self._staged_entries:
+            warnings.warn(
+                f"MutationsBatcher for table {self._table.table_name} was not closed. {len(self._staged_entries)} Unflushed mutations will not be sent to the server."
+            )
+
+    @staticmethod
+    def _wait_for_batch_results(
+        *tasks: CrossSync._Sync_Impl.Future[list[FailedMutationEntryError]]
+        | CrossSync._Sync_Impl.Future[None],
+    ) -> list[Exception]:
+        """Takes in a list of futures representing _execute_mutate_rows tasks,
+        waits for them to complete, and returns a list of errors encountered.
+
+        Args:
+            *tasks: futures representing _execute_mutate_rows or _flush_internal tasks
+        Returns:
+            list[Exception]:
+                list of Exceptions encountered by any of the tasks. Errors are expected
+                to be FailedMutationEntryError, representing a failed mutation operation.
+                If a task fails with a different exception, it will be included in the
+                output list. Successful tasks will not be represented in the output list.
+        """
+        if not tasks:
+            return []
+        exceptions: list[Exception] = []
+        for task in tasks:
+            try:
+                exc_list = task.result()
+                if exc_list:
+                    for exc in exc_list:
+                        exc.index = None
+                    exceptions.extend(exc_list)
+            except Exception as e:
+                exceptions.append(e)
+        return exceptions