Skip to content

Commit 9be6cb2

Browse files
authored
Update TabularDataByMQL documentation (#837)
1 parent 3fed4a0 commit 9be6cb2

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/viam/app/data_client.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,9 @@ async def tabular_data_by_mql(
364364
Args:
365365
organization_id (str): The ID of the organization that owns the data.
366366
You can obtain your organization ID from the Viam app's organization settings page.
367-
query (Union[List[bytes], List[Dict[str, Any]]]): The MQL query to run as a list of BSON queries.
368-
Note: Support for bytes will be removed in the future, so using a dictionary is preferred.
367+
query (Union[List[bytes], List[Dict[str, Any]]]): "The MQL query to run, as a list of MongoDB aggregation pipeline stages.
368+
Note: Each stage can be provided as either a dictionary or raw BSON bytes, but support for bytes will be removed in the future,
369+
so using a dictionary is preferred.
369370
370371
Returns:
371372
List[Dict[str, Union[ValueTypes, datetime]]]: An array of decoded BSON data objects.

0 commit comments

Comments
 (0)