flowclient.api_query

Class APIQuery

APIQuery(*, connection: flowclient.connection.Connection, parameters: dict)

Source: flowclient/api_query.py

Representation of a FlowKit query.

Methods

get_result

get_result(self, format: str = 'pandas', poll_interval: int = 1, disable_progress: Union[bool, NoneType] = None) -> Union[ForwardRef('pandas.DataFrame'), dict]

Source: flowclient/api_query.py

Get the result of this query, as a pandas DataFrame or GeoJSON dict.

Parameters

• format: str, default pandas

  Result format. One of {'pandas', 'geojson'}

• poll_interval: int, default 1

  Number of seconds to wait between checks for the query being ready

• disable_progress: typing.Union[bool, NoneType], default None

  Set to True to disable progress bar display entirely, None to disable on non-TTY, or False to always enable

Returns

• typing.Union[ForwardRef('pandas.DataFrame'), dict]

  Query result

run

run(self) -> None

Source: flowclient/api_query.py

Set this query running in FlowKit

wait_until_ready

wait_until_ready(self, poll_interval: int = 1, disable_progress: Union[bool, NoneType] = None) -> None

Source: flowclient/api_query.py

Wait until this query has finished running.

Parameters

• poll_interval: int, default 1

  Number of seconds to wait between checks for the query being ready

• disable_progress: typing.Union[bool, NoneType], default None

  Set to True to disable progress bar display entirely, None to disable on non-TTY, or False to always enable

connection

connection

Source: flowclient/api_query.py

Connection that is used for running this query.

Returns

• flowclient.connection.Connection

  Connection to FlowKit API

status

status

Source: flowclient/api_query.py

Status of this query.

Returns

• str

  One of: - "not_running" - "queued" - "executing" - "completed"