2.41.0 (latest) 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.1 2.29.0 2.28.1 2.26.0 2.25.0 2.24.0 2.23.1 2.22.0 2.21.0 2.20.0 2.19.0 2.18.1 2.17.0 2.16.0 2.15.0 2.14.1 2.13.2 2.12.0 2.11.3 2.10.1 2.9.0 2.8.1 2.7.1 2.6.0 2.5.2 2.4.0 2.3.3 2.2.0 2.1.0 2.0.0 1.7.3 1.6.1 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.0 0.34.0

### *class* google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync(table: TargetType, \*, flush_interval: [float](https://docs.python.org/3/library/functions.html#float) \| [None](https://docs.python.org/3/library/constants.html#None) = 5, flush_limit_mutation_count: [int](https://docs.python.org/3/library/functions.html#int) \| [None](https://docs.python.org/3/library/constants.html#None) = 1000, flush_limit_bytes: [int](https://docs.python.org/3/library/functions.html#int) = 20971520, flow_control_max_mutation_count: [int](https://docs.python.org/3/library/functions.html#int) = 100000, flow_control_max_bytes: [int](https://docs.python.org/3/library/functions.html#int) = 104857600, batch_operation_timeout: [float](https://docs.python.org/3/library/functions.html#float) \| TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS, batch_attempt_timeout: [float](https://docs.python.org/3/library/functions.html#float) \| [None](https://docs.python.org/3/library/constants.html#None) \| TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS, batch_retryable_errors: Sequence\[[type](https://docs.python.org/3/library/functions.html#type)\[[Exception](https://docs.python.org/3/library/exceptions.html#Exception)\]\] \| TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS)

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

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

- **Parameters**

  - **table** -- table or autrhorized_view used 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.

#### *async* _*aenter_*()

Allow use of context manager API

#### *async* _*aexit_*(exc_type, exc, tb)

Allow use of context manager API.

Flushes the batcher and cleans up resources.

#### *async* append(mutation_entry: [RowMutationEntry](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/common_data_mutations#google.cloud.bigtable.data.mutations.RowMutationEntry))

Add a new set of mutations to the internal queue

- **Parameters**

  **mutation_entry** -- new entry to add to flush queue
- **Raises**

  - [**RuntimeError**](https://docs.python.org/3/library/exceptions.html#RuntimeError) -- if batcher is closed

  - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError) -- if an invalid mutation type is added

#### *async* close()

Flush queue and clean up resources

#### *property* closed(*: \[bool\](<https://docs.python.org/3/library/functions.html#bool>* )

Returns:

- True if the batcher is closed, False otherwise