Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.query.client

Module Contents

Query

type roboto.query.client.Query = typing.Union[RoboQLQuery, QuerySpecification]#View Source

QueryClient

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

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]

QueryClient.are_query_results_available()

are_query_results_available(query_id, owner_org_id=None)#View Source

Parameters

query_id str
owner_org_id Optional[str]

Return type

bool

QueryClient.get_query_record()

get_query_record(query_id, owner_org_id=None)#View Source

Parameters

query_id str
owner_org_id Optional[str]

QueryClient.get_query_results()

get_query_results(query_id, owner_org_id=None)#View Source

Parameters

query_id str
owner_org_id Optional[str]

Return type

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

Properties

QueryClient.roboto_client

QueryClient.submit_query()

submit_query(query, target, timeout_seconds, content_mode=QueryContentMode.RecordWithMeta, owner_org_id=None)#View Source

Parameters

query Optional[Query]
timeout_seconds float
owner_org_id Optional[str]

Return type

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

QueryClient.submit_roboql()

submit_roboql(request, owner_org_id=None)#View Source

Parameters

owner_org_id Optional[str]

QueryClient.submit_roboql_and_await_results()

submit_roboql_and_await_results(request, timeout_seconds, owner_org_id=None)#View Source

Parameters

timeout_seconds float
owner_org_id Optional[str]

Return type

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

QueryClient.submit_structured()

submit_structured(request, owner_org_id=None)#View Source

Parameters

owner_org_id Optional[str]

QueryClient.submit_structured_and_await_results()

submit_structured_and_await_results(request, timeout_seconds, owner_org_id=None)#View Source

Parameters

timeout_seconds float
owner_org_id Optional[str]

Return type

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

QueryClient.submit_term()

submit_term(request, owner_org_id=None)#View Source

Parameters

owner_org_id Optional[str]

QueryClient.submit_term_and_await_results()

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

Parameters

timeout_seconds float
owner_org_id Optional[str]

Return type

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

RoboQLQuery

type roboto.query.client.RoboQLQuery = str#View Source

Was this page helpful?