roboto.query.specification
Module Contents
DEFAULT_PAGE_SIZE
Default page size for search.
MAX_PAGE_SIZE
Maximum allowable page size for search.
QuerySpecification
Bases: pydantic.BaseModel
Model for specifying a query to the Roboto Platform.
Usage
Specify a query with a single condition:
>>> from roboto import query >>> query_spec = query.QuerySpecification( … condition=query.Condition(field=“name”, comparator=query.Comparator.Equals, value=“Roboto”) … )
Specify a query with multiple conditions:
>>> from roboto import query >>> query_spec = query.QuerySpecification( … condition=query.ConditionGroup( … operator=query.ConditionOperator.And, … conditions=[ … query.Condition(field=“name”, comparator=query.Comparator.Equals, value=“Roboto”), … query.Condition(field=“age”, comparator=query.Comparator.GreaterThan, value=18), … ], … ) … )
Arbitrarily nest condition groups:
>>> from roboto import query >>> query_spec = query.QuerySpecification( … condition=query.ConditionGroup( … operator=query.ConditionOperator.And, … conditions=[ … query.Condition(field=“name”, comparator=query.Comparator.Equals, value=“Roboto”), … query.ConditionGroup( … operator=query.ConditionOperator.Or, … conditions=[ … query.Condition(field=“age”, comparator=query.Comparator.GreaterThan, value=18), … query.Condition(field=“age”, comparator=query.Comparator.LessThan, value=30), … ], … ), … ], … ) … )
Parameters
data AnyAttributes
QuerySpecification.condition
condition roboto.Query condition(s) to evaluate when looking up Roboto entities.
QuerySpecification.fields()
Return a set of all fields referenced in the query.
Return type
Attributes
QuerySpecification.limit
Page size for returned results. Optional, default is MAX_PAGE_SIZE.
QuerySpecification.max_results
Maximum number of results to return across all pages. Must be >= 1 when set. None (default) means no cap — pagination yields the full result set. Distinct from limit, which is the per-page size.
Only honored for queries executed via Roboto search (the QueryTarget resource types: collections, datasets, devices, files, sessions, topics, topic message paths, events). Other code paths that accept a QuerySpecification ignore this field.
QuerySpecification.model_config
model_config #Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
QuerySpecification.sort_by
Field to sort results by. Optional, defaults to created date (created).
QuerySpecification.sort_direction
Sort direction for query results. Optional, defaults to “descending”.
SortDirection
Bases: roboto.compat.StrEnum
The direction to sort the results of a query.
SortDirection.from_string()
Parameters
value strReturn type