Update tabular data examples #611
Conversation
src/viam/app/data_client.py
Outdated
| @@ -255,10 +255,14 @@ async def tabular_data_by_sql(self, organization_id: str, sql_query: str) -> Lis | |||
|
|
|||
| async def tabular_data_by_mql(self, organization_id: str, mql_binary: List[bytes]) -> List[Dict[str, ValueTypes]]: | |||
| """Obtain unified tabular data and metadata, queried with MQL. | |||
| You must install the `pymongo` package and `import bson` to use the `tabular_data_by_mql` method. | |||
There was a problem hiding this comment.
Is this accurate? I don't think this is strictly necessary -- you can use any bson serialization library. I would change this to be more of a suggestion, something like:
mql_binaryis an array of encodedbsonqueries. You can encode yourbsonqueries using a library likepymongo.
There was a problem hiding this comment.
well you cannot use the regular bson library that I first had installed. hyperopt/hyperopt#547
There was a problem hiding this comment.
What happens when you try to use the bson library? I was just able to do this:
import bson
bson.dumps({ '$match': { 'location_id': '<location-id>' }})And that outputs a valid bson binary. I'm curious as to the functionality you are seeing.
There was a problem hiding this comment.
that does indeed work. You can't call encode on that. I think that's what I was trying before and it has just a varietey of encode_* methods
|
tested both, yes |
src/viam/app/data_client.py
Outdated
| @@ -255,10 +255,14 @@ async def tabular_data_by_sql(self, organization_id: str, sql_query: str) -> Lis | |||
|
|
|||
| async def tabular_data_by_mql(self, organization_id: str, mql_binary: List[bytes]) -> List[Dict[str, ValueTypes]]: | |||
| """Obtain unified tabular data and metadata, queried with MQL. | |||
| You must `import bson` to create valid bson binary objects as input for the `tabular_data_by_mql` method. | |||
There was a problem hiding this comment.
Again, I don't want to prescribe a library, particularly given that the bson library hasn't been updated in 3 years. Further, a library isn't even technically required -- you could encode the bson by hand.
My suggestion would be to remove the must, and then provide an example of using a library:
async def tabular_data_by_mql(...):
"""Obtain unified tabular data and metadata, queried with MQL.
`mql_binary` is an array of encoded `bson` queries. You can encode your bson queries using a library like `pymongo` or `bson`.
::
# using bson
import bson
data = ...(..., mql_binary=[bosn.dumps(...)])
# using pymongo
import bson
data = ...(..., mql_binary=[bosn.encode(...)])
"""There was a problem hiding this comment.
You didn't actually say that before. I'm ok using your proposal.
No description provided.