roboto.query.client

Module Contents

type roboto.query.client.Query = Union[RoboQLQuery, QuerySpecification]

class roboto.query.client.QueryClient(roboto_client=None, owner_org_id=None, roboto_profile=None)

A low-level Roboto query client. Prefer RobotoSearch for a simpler, more curated query interface.

Parameters:

• roboto_client (Optional[roboto.http.RobotoClient])

• owner_org_id (Optional[str])

• roboto_profile (Optional[str])

are_query_results_available(query_id, owner_org_id=None)

Parameters:

• query_id (str)

• owner_org_id (Optional[str])

Return type:

bool

get_query_record(query_id, owner_org_id=None)

Parameters:

• query_id (str)

• owner_org_id (Optional[str])

Return type:

roboto.query.api.QueryRecord

get_query_results(query_id, owner_org_id=None)

Parameters:

• query_id (str)

• owner_org_id (Optional[str])

Return type:

collections.abc.Generator[dict[str, Any], None, None]

property roboto_client: roboto.http.RobotoClient

Return type:

roboto.http.RobotoClient

submit_query(query, target, timeout_seconds, owner_org_id=None)

Parameters:

• query (Optional[Query])

• target (roboto.query.api.QueryTarget)

• timeout_seconds (float)

• owner_org_id (Optional[str])

Return type:

collections.abc.Generator[dict[str, Any], None, None]

submit_roboql(request, owner_org_id=None)

Parameters:

• request (roboto.query.api.SubmitRoboqlQueryRequest)

• owner_org_id (Optional[str])

Return type:

roboto.query.api.QueryRecord

submit_roboql_and_await_results(request, timeout_seconds, owner_org_id=None)

Parameters:

• request (roboto.query.api.SubmitRoboqlQueryRequest)

• timeout_seconds (float)

• owner_org_id (Optional[str])

Return type:

collections.abc.Generator[dict[str, Any], None, None]

submit_structured(request, owner_org_id=None)

Parameters:

• request (roboto.query.api.SubmitStructuredQueryRequest)

• owner_org_id (Optional[str])

Return type:

roboto.query.api.QueryRecord

submit_structured_and_await_results(request, timeout_seconds, owner_org_id=None)

Parameters:

• request (roboto.query.api.SubmitStructuredQueryRequest)

• timeout_seconds (float)

• owner_org_id (Optional[str])

Return type:

collections.abc.Generator[dict[str, Any], None, None]

submit_term(request, owner_org_id=None)

Parameters:

• request (roboto.query.api.SubmitTermQueryRequest)

• owner_org_id (Optional[str])

Return type:

roboto.query.api.QueryRecord

submit_term_and_await_results(request, timeout_seconds=math.inf, owner_org_id=None)

Parameters:

• request (roboto.query.api.SubmitTermQueryRequest)

• timeout_seconds (float)

• owner_org_id (Optional[str])

Return type:

collections.abc.Generator[dict[str, Any], None, None]

type roboto.query.client.RoboQLQuery = str