Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify comments in ReadRowsRequest and RowFilter #494

Merged
merged 3 commits into from
Jan 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions google/cloud/bigtable_v2/types/bigtable.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,15 @@ class ReadRowsRequest(proto.Message):
If not specified, the "default" application
profile will be used.
rows (google.cloud.bigtable_v2.types.RowSet):
The row keys and/or ranges to read. If not
specified, reads from all rows.
The row keys and/or ranges to read
sequentially. If not specified, reads from all
rows.
filter (google.cloud.bigtable_v2.types.RowFilter):
The filter to apply to the contents of the
specified row(s). If unset, reads the entirety
of each row.
rows_limit (int):
The read will terminate after committing to N
The read will stop after committing to N
rows' worth of results. The default (zero) is to
return all results.
"""
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/bigtable_v2/types/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ class RowFilter(proto.Message):
RowFilter.Chain and RowFilter.Interleave documentation.

The total serialized size of a RowFilter message must not exceed
4096 bytes, and RowFilters may not be nested within each other (in
20480 bytes, and RowFilters may not be nested within each other (in
Chains or Interleaves) to a depth of more than 20.

This message has `oneof`_ fields (mutually exclusive fields).
Expand Down