Skip to content

Update TabularDataByMQL documentation #837

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.

Sign up for GitHub

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

Merged
dmhilly merged 3 commits into from
Feb 6, 2025
Merged

Update TabularDataByMQL documentation #837

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc8265e
Update TabularDataByMQL documentation
dmhilly Feb 5, 2025
0dde751
Tweak the language
dmhilly Feb 6, 2025
34367a2
Make dictionary come first in comment
dmhilly Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/viam/app/data_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,8 @@ async def tabular_data_by_mql(
Args:
organization_id (str): The ID of the organization that owns the data.
You can obtain your organization ID from the Viam app's organization settings page.
query (Union[List[bytes], List[Dict[str, Any]]]): The MQL query to run as a list of BSON queries.
query (Union[List[bytes], List[Dict[str, Any]]]): "The MQL query to run, as a list of MongoDB aggregation pipeline stages.
The stages can be provided either as raw BSON bytes, or as dictionaries.
Copy link
Member

@purplenicole730 purplenicole730 Feb 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would argue that because support for bytes will be removed, we shouldn't include bytes in the comment. We know that we want users to use dictionaries, so we shouldn't encourage alternatives, even if there is a note added below.

Copy link
Member Author

@dmhilly dmhilly Feb 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense! I tweaked the language a bit so this section is now in the note. I can also just remove that part altogether and keep the note as it was before. LMK what you prefer

Note: Support for bytes will be removed in the future, so using a dictionary is preferred.

Returns:
Expand Down