2.42.0 (latest) 2.41.0 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

    ReadRowsQuery(
        row_keys: typing.Optional[typing.Union[list[str | bytes], str, bytes]] = None,
        row_ranges: typing.Optional[
            typing.Union[
                list[google.cloud.bigtable.data.read_rows_query.RowRange],
                google.cloud.bigtable.data.read_rows_query.RowRange,
            ]
        ] = None,
        limit: typing.Optional[int] = None,
        row_filter: typing.Optional[
            google.cloud.bigtable.data.row_filters.RowFilter
        ] = None,
    )

Class to encapsulate details of a read row request

## Properties

### filter

Return the RowFilter applied to this query

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `RowFilter None` | the RowFilter applied to this query |

### limit

Return the maximum number of rows to return by this query

None or 0 means no limit

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int None` | the maximum number of rows to return by this query |

### row_keys

Return the row keys in this query

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `list[bytes]` | the row keys in this query |

### row_ranges

Return the row ranges in this query

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `list[RowRange]` | the row ranges in this query |

## Methods

### __eq__

    __eq__(other)

RowRanges are equal if they have the same row keys, row ranges,
filter and limit, or if they both represent a full scan with the
same filter and limit

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` | True if the objects are equal, False otherwise |

### add_key

    add_key(row_key: str | bytes)

Add a row key to this query

A query can contain multiple keys, but ranges should be preferred

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `ValueError` | if an input is not a string or bytes |

### add_range

    add_range(row_range: google.cloud.bigtable.data.read_rows_query.RowRange)

Add a range of row keys to this query.

### shard

    shard(shard_keys: RowKeySamples) -> ShardedQuery

Split this query into multiple queries that can be evenly distributed
across nodes and run in parallel

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `AttributeError` | if the query contains a limit |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `ShardedQuery` | a ShardedQuery that can be used in sharded_read_rows calls |