Skip to content

Commit 053a6ee

Browse files
daniel-sanchedaniel-sanche
authored
feat: added generated docs for async client (#947)
1 parent 390b059 commit 053a6ee

13 files changed

+128
-7
lines changed

‎docs/async_data_client.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Bigtable Data Client Async
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data._async.client
5+
:members:
6+
:show-inheritance:

‎docs/async_data_exceptions.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Custom Exceptions
2+
~~~~~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data.exceptions
5+
:members:
6+
:show-inheritance:

‎docs/async_data_mutations.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Mutations
2+
~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data.mutations
5+
:members:
6+
:show-inheritance:

‎docs/async_data_mutations_batcher.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Mutations Batcher Async
2+
~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data._async.mutations_batcher
5+
:members:
6+
:show-inheritance:

‎docs/async_data_read_modify_write_rules.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Read Modify Write Rules
2+
~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data.read_modify_write_rules
5+
:members:
6+
:show-inheritance:

‎docs/async_data_read_rows_query.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Read Rows Query
2+
~~~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data.read_rows_query
5+
:members:
6+
:show-inheritance:

‎docs/async_data_row.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Rows and Cells
2+
~~~~~~~~~~~~~~
3+
4+
.. automodule:: google.cloud.bigtable.data.row
5+
:members:
6+
:show-inheritance:

‎docs/async_data_row_filters.rst

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
Bigtable Row Filters
2+
====================
3+
4+
It is possible to use a
5+
:class:`RowFilter <google.cloud.bigtable.data.row_filters.RowFilter>`
6+
when constructing a :class:`ReadRowsQuery <google.cloud.bigtable.data.read_rows_query.ReadRowsQuery>`
7+
8+
The following basic filters
9+
are provided:
10+
11+
* :class:`SinkFilter <.data.row_filters.SinkFilter>`
12+
* :class:`PassAllFilter <.data.row_filters.PassAllFilter>`
13+
* :class:`BlockAllFilter <.data.row_filters.BlockAllFilter>`
14+
* :class:`RowKeyRegexFilter <.data.row_filters.RowKeyRegexFilter>`
15+
* :class:`RowSampleFilter <.data.row_filters.RowSampleFilter>`
16+
* :class:`FamilyNameRegexFilter <.data.row_filters.FamilyNameRegexFilter>`
17+
* :class:`ColumnQualifierRegexFilter <.data.row_filters.ColumnQualifierRegexFilter>`
18+
* :class:`TimestampRangeFilter <.data.row_filters.TimestampRangeFilter>`
19+
* :class:`ColumnRangeFilter <.data.row_filters.ColumnRangeFilter>`
20+
* :class:`ValueRegexFilter <.data.row_filters.ValueRegexFilter>`
21+
* :class:`ValueRangeFilter <.data.row_filters.ValueRangeFilter>`
22+
* :class:`CellsRowOffsetFilter <.data.row_filters.CellsRowOffsetFilter>`
23+
* :class:`CellsRowLimitFilter <.data.row_filters.CellsRowLimitFilter>`
24+
* :class:`CellsColumnLimitFilter <.data.row_filters.CellsColumnLimitFilter>`
25+
* :class:`StripValueTransformerFilter <.data.row_filters.StripValueTransformerFilter>`
26+
* :class:`ApplyLabelFilter <.data.row_filters.ApplyLabelFilter>`
27+
28+
In addition, these filters can be combined into composite filters with
29+
30+
* :class:`RowFilterChain <.data.row_filters.RowFilterChain>`
31+
* :class:`RowFilterUnion <.data.row_filters.RowFilterUnion>`
32+
* :class:`ConditionalRowFilter <.data.row_filters.ConditionalRowFilter>`
33+
34+
These rules can be nested arbitrarily, with a basic filter at the lowest
35+
level. For example:
36+
37+
.. code:: python
38+
39+
# Filter in a specified column (matching any column family).
40+
col1_filter = ColumnQualifierRegexFilter(b'columnbia')
41+
42+
# Create a filter to label results.
43+
label1 = u'label-red'
44+
label1_filter = ApplyLabelFilter(label1)
45+
46+
# Combine the filters to label all the cells in columnbia.
47+
chain1 = RowFilterChain(filters=[col1_filter, label1_filter])
48+
49+
# Create a similar filter to label cells blue.
50+
col2_filter = ColumnQualifierRegexFilter(b'columnseeya')
51+
label2 = u'label-blue'
52+
label2_filter = ApplyLabelFilter(label2)
53+
chain2 = RowFilterChain(filters=[col2_filter, label2_filter])
54+
55+
# Bring our two labeled columns together.
56+
row_filter = RowFilterUnion(filters=[chain1, chain2])
57+
58+
----
59+
60+
.. automodule:: google.cloud.bigtable.data.row_filters
61+
:members:
62+
:show-inheritance:

‎docs/async_data_usage.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Using the Async Data Client
2+
===========================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
async_data_client
8+
async_data_mutations_batcher
9+
async_data_read_rows_query
10+
async_data_row
11+
async_data_row_filters
12+
async_data_mutations
13+
async_data_read_modify_write_rules
14+
async_data_exceptions

‎docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Using the API
88
:maxdepth: 2
99

1010
usage
11+
async_data_usage
1112

1213

1314
API Reference

‎docs/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Using the API
2-
=============
1+
Using the Sync Client
2+
=====================
33

44
.. toctree::
55
:maxdepth: 2

‎google/cloud/bigtable/data/_async/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1150,7 +1150,7 @@ async def check_and_mutate_row(
11501150
applied to row_key. Entries are applied in order,
11511151
meaning that earlier mutations can be masked by later
11521152
ones. Must contain at least one entry if
1153-
`true_case_mutations is empty, and at most 100000.
1153+
`true_case_mutations` is empty, and at most 100000.
11541154
- operation_timeout: the time budget for the entire operation, in seconds.
11551155
Failed requests will not be retried. Defaults to the Table's default_operation_timeout
11561156
Returns:

‎google/cloud/bigtable/data/row.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,12 @@ def __str__(self) -> str:
147147
"""
148148
Human-readable string representation
149149
150-
{
151-
(family='fam', qualifier=b'col'): [b'value', (+1 more),],
152-
(family='fam', qualifier=b'col2'): [b'other'],
153-
}
150+
.. code-block:: python
151+
152+
{
153+
(family='fam', qualifier=b'col'): [b'value', (+1 more),],
154+
(family='fam', qualifier=b'col2'): [b'other'],
155+
}
154156
"""
155157
output = ["{"]
156158
for family, qualifier in self._get_column_components():

0 commit comments

Comments
 (0)