Skip to content

Query result

QueryResult

Bases: Resource

Implementation of a resource for query result. This resource defines the data model used by its resource container(model.container.DataLakeMeasures). It inherits from Pydantic's BaseModel to get all its superpowers, which are used to parse, validate the API response and to easily switch between the Python representation (both serialized and deserialized) and Java representation (serialized only).

convert_to_pandas_representation()

Returns the dictionary representation of a data lake series to be used when creating a pandas Dataframe.

It contains only the "header rows" (the column names) and "rows" that contain the actual data.

RETURNS DESCRIPTION
dict

Dictionary with the keys headers and rows

RAISES DESCRIPTION
StreamPipesUnsupportedDataLakeSeries

If the query result returned by the StreamPipes API cannot be converted to the pandas representation

to_pandas()

Returns the data lake series in representation of a Pandas Dataframe.

RETURNS DESCRIPTION
df

Pandas df containing the query result

TYPE: DataFrame