Module mutations (2.24.0)

Version 2.24.0

• 2.26.0 (latest)
• 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

API documentation for bigtable.data.mutations module.

Classes

DeleteAllFromFamily

DeleteAllFromFamily(family_to_delete: str)

Mutation to delete all cells from a column family.

DeleteAllFromRow

DeleteAllFromRow()

Mutation to delete all cells from a row.

DeleteRangeFromColumn

DeleteRangeFromColumn(
    family: str,
    qualifier: bytes,
    start_timestamp_micros: typing.Optional[int] = None,
    end_timestamp_micros: typing.Optional[int] = None,
)

Mutation to delete a range of cells from a column.

Exceptions
Type	Description
ValueError	If start_timestamp_micros is greater than end_timestamp_micros.

Mutation

Mutation()

Abstract base class for mutations.

This class defines the interface for different types of mutations that can be applied to Bigtable rows.

RowMutationEntry

RowMutationEntry(
    row_key: bytes | str,
    mutations: (
        google.cloud.bigtable.data.mutations.Mutation
        | list[google.cloud.bigtable.data.mutations.Mutation]
    ),
)

A single entry in a MutateRows request.

This class represents a set of mutations to apply to a specific row in a Bigtable table.

Exceptions
Type	Description
ValueError	If mutations is empty or contains more than _MUTATE_ROWS_REQUEST_MUTATION_LIMIT mutations.

SetCell

SetCell(
    family: str,
    qualifier: bytes | str,
    new_value: bytes | str | int,
    timestamp_micros: typing.Optional[int] = None,
)

Mutation to set the value of a cell.

Exceptions
Type	Description
TypeError	If qualifier is not bytes or str.
TypeError	If new_value is not bytes, str, or int.
ValueError	If timestamp_micros is less than _SERVER_SIDE_TIMESTAMP.