Update docstring

Author: trollyxia

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

@@ -708,38 +708,42 @@ async def execute_query(
                 If None, defaults to prepare_operation_timeout.
             prepare_retryable_errors: a list of errors that will be retried if encountered during prepareQuery.
                 Defaults to 4 (DeadlineExceeded) and 14 (ServiceUnavailable)
-            column_info:
-                (Optional) A dictionary mapping column names to Protobuf message classes or EnumTypeWrapper objects.
+            column_info: (Optional) A dictionary mapping column names to Protobuf message classes or EnumTypeWrapper objects.
                 This dictionary provides the necessary type information for deserializing PROTO and
                 ENUM column values from the query results. When an entry is provided
                 for a PROTO or ENUM column, the client library will attempt to deserialize the raw data.
 
-                - For PROTO columns: The value in the dictionary should be the
-                  Protobuf Message class (e.g., `my_pb2.MyMessage`).
-                - For ENUM columns: The value should be the Protobuf EnumTypeWrapper
-                  object (e.g., `my_pb2.MyEnum`).
+                    - For PROTO columns: The value in the dictionary should be the
+                      Protobuf Message class (e.g., ``my_pb2.MyMessage``).
+                    - For ENUM columns: The value should be the Protobuf EnumTypeWrapper
+                      object (e.g., ``my_pb2.MyEnum``).
+
+                Example::
 
-                Example:
                     import my_pb2
 
                     column_info = {
                         "my_proto_column": my_pb2.MyMessage,
                         "my_enum_column": my_pb2.MyEnum
                     }
 
-                If `column_info` is not provided, or if a specific column name is not found
+                If ``column_info`` is not provided, or if a specific column name is not found
                 in the dictionary, or if deserialization fails:
+
                     - PROTO columns will be returned as raw bytes.
                     - ENUM columns will be returned as integers.
 
                 Note for Nested PROTO or ENUM Fields:
+
                     To specify types for PROTO or ENUM fields within STRUCTs or MAPs, use a dot-separated
                     path from the top-level column name.
-                    - For STRUCTs: `struct_column_name.field_name`
-                    - For MAPs: `map_column_name.key` or `map_column_name.value` to specify types
-                      for the map keys or values, respectively.
 
-                    Examples:
+                        - For STRUCTs: ``struct_column_name.field_name``
+                        - For MAPs: ``map_column_name.key`` or ``map_column_name.value`` to specify types
+                          for the map keys or values, respectively.
+
+                    Example::
+
                         import my_pb2
 
                         column_info = {

google/cloud/bigtable/data/_sync_autogen/client.py

@@ -49,6 +49,8 @@
 from google.api_core.exceptions import DeadlineExceeded
 from google.api_core.exceptions import ServiceUnavailable
 from google.api_core.exceptions import Aborted
+from google.protobuf.message import Message
+from google.protobuf.internal.enum_type_wrapper import EnumTypeWrapper
 import google.auth.credentials
 import google.auth._default
 from google.api_core import client_options as client_options_lib
@@ -485,7 +487,7 @@ def execute_query(
             DeadlineExceeded,
             ServiceUnavailable,
         ),
-        column_info: dict[str, Any] | None = None,
+        column_info: dict[str, Message | EnumTypeWrapper] | None = None,
     ) -> "ExecuteQueryIterator":
         """Executes an SQL query on an instance.
         Returns an iterator to asynchronously stream back columns from selected rows.
@@ -533,13 +535,58 @@ def execute_query(
                 If None, defaults to prepare_operation_timeout.
             prepare_retryable_errors: a list of errors that will be retried if encountered during prepareQuery.
                 Defaults to 4 (DeadlineExceeded) and 14 (ServiceUnavailable)
-            column_info: Dictionary with mappings between column names and additional column information.
-                An object where column names as keys and custom objects as corresponding
-                values for deserialization. It's specifically useful for data types like
-                protobuf where deserialization logic is on user-specific code. When provided,
-                the custom object enables deserialization of backend-received column data.
-                If not provided, data remains serialized as bytes for Proto Messages and
-                integer for Proto Enums.
+            column_info: (Optional) A dictionary mapping column names to Protobuf message classes or EnumTypeWrapper objects.
+                This dictionary provides the necessary type information for deserializing PROTO and
+                ENUM column values from the query results. When an entry is provided
+                for a PROTO or ENUM column, the client library will attempt to deserialize the raw data.
+
+                    - For PROTO columns: The value in the dictionary should be the
+                      Protobuf Message class (e.g., ``my_pb2.MyMessage``).
+                    - For ENUM columns: The value should be the Protobuf EnumTypeWrapper
+                      object (e.g., ``my_pb2.MyEnum``).
+
+                Example::
+
+                    import my_pb2
+
+                    column_info = {
+                        "my_proto_column": my_pb2.MyMessage,
+                        "my_enum_column": my_pb2.MyEnum
+                    }
+
+                If ``column_info`` is not provided, or if a specific column name is not found
+                in the dictionary, or if deserialization fails:
+
+                    - PROTO columns will be returned as raw bytes.
+                    - ENUM columns will be returned as integers.
+
+                Note for Nested PROTO or ENUM Fields:
+
+                    To specify types for PROTO or ENUM fields within STRUCTs or MAPs, use a dot-separated
+                    path from the top-level column name.
+
+                        - For STRUCTs: ``struct_column_name.field_name``
+                        - For MAPs: ``map_column_name.key`` or ``map_column_name.value`` to specify types
+                          for the map keys or values, respectively.
+
+                    Example::
+
+                        import my_pb2
+
+                        column_info = {
+                            # Top-level column
+                            "my_proto_column": my_pb2.MyMessage,
+                            "my_enum_column": my_pb2.MyEnum,
+
+                            # Nested field in a STRUCT column named 'my_struct'
+                            "my_struct.nested_proto_field": my_pb2.OtherMessage,
+                            "my_struct.nested_enum_field": my_pb2.AnotherEnum,
+
+                            # Nested field in a MAP column named 'my_map'
+                            "my_map.key": my_pb2.MapKeyEnum, # If map keys were enums
+                            "my_map.value": my_pb2.MapValueMessage,
+                        }
+
         Returns:
             ExecuteQueryIterator: an asynchronous iterator that yields rows returned by the query
         Raises:

google/cloud/bigtable/data/execute_query/_sync_autogen/execute_query_iterator.py

@@ -18,6 +18,8 @@
 from __future__ import annotations
 from typing import Any, Dict, Optional, Sequence, Tuple, TYPE_CHECKING
 from google.api_core import retry as retries
+from google.protobuf.message import Message
+from google.protobuf.internal.enum_type_wrapper import EnumTypeWrapper
 from google.cloud.bigtable.data.execute_query._byte_cursor import _ByteCursor
 from google.cloud.bigtable.data._helpers import (
     _attempt_timeout_generator,
@@ -63,7 +65,7 @@ def __init__(
         operation_timeout: float,
         req_metadata: Sequence[Tuple[str, str]] = (),
         retryable_excs: Sequence[type[Exception]] = (),
-        column_info: Dict[str, Any] | None = None,
+        column_info: dict[str, Message | EnumTypeWrapper] | None = None,
     ) -> None:
         """Collects responses from ExecuteQuery requests and parses them into QueryResultRows.