As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Read Modify Write Rules

class google.cloud.bigtable.data.read_modify_write_rules.AppendValueRule(family: str, qualifier: bytes | str, append_value: bytes | str)[source]

Bases: google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule

Rule to append a value to a cell’s value.

Parameters
  • family – The family name of the cell to append to.

  • qualifier – The qualifier of the cell to append to.

  • append_value – The value to append to the cell’s value.

Raises

TypeError – If append_value is not bytes or str.

class google.cloud.bigtable.data.read_modify_write_rules.IncrementRule(family: str, qualifier: bytes | str, increment_amount: int = 1)[source]

Bases: google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule

Rule to increment a cell’s value.

Parameters
  • family – The family name of the cell to increment.

  • qualifier – The qualifier of the cell to increment.

  • increment_amount – The amount to increment the cell’s value. Must be between -2**63 and 2**63 (64-bit signed int).

Raises
  • TypeError – If increment_amount is not an integer.

  • ValueError – If increment_amount is not between -2**63 and 2**63 (64-bit signed int).

class google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule(family: str, qualifier: bytes | str)[source]

Bases: abc.ABC

Abstract base class for read-modify-write rules.