---
sidebar:
  hidden: true
title: roboto.query
---
## Submodules

- [roboto.query.api](/docs/reference/python-sdk/roboto/query/api)
- [roboto.query.client](/docs/reference/python-sdk/roboto/query/client)
- [roboto.query.conditions](/docs/reference/python-sdk/roboto/query/conditions)
- [roboto.query.filters](/docs/reference/python-sdk/roboto/query/filters)
- [roboto.query.roboql_literal](/docs/reference/python-sdk/roboto/query/roboql_literal)
- [roboto.query.specification](/docs/reference/python-sdk/roboto/query/specification)
- [roboto.query.visitor](/docs/reference/python-sdk/roboto/query/visitor)

## Package Contents

- [BaseVisitor](/reference/python-sdk/roboto/query/visitor#roboto.query.visitor.BaseVisitor) (class): Query base visitor

- [BooleanFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.BooleanFilter) (class): True or false, or unset.

- [Comparator](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.Comparator) (class): The comparator to use when comparing a field to a value.

- [Condition](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.Condition) (class): A filter for any arbitrary attribute for a Roboto resource.

- [ConditionGroup](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.ConditionGroup) (class): A group of conditions that are combined together.

- [ConditionOperator](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.ConditionOperator) (class): The operator to use when combining multiple conditions.

- [ConditionType](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.ConditionType) (data)

- [ConditionValue](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.ConditionValue) (data)

- [ConditionVisitor](/reference/python-sdk/roboto/query/visitor#roboto.query.visitor.ConditionVisitor) (class): Query condition visitor

- [DEFAULT_PAGE_SIZE](/reference/python-sdk/roboto/query/specification#roboto.query.specification.DEFAULT_PAGE_SIZE) (data): `DEFAULT_PAGE_SIZE: int = 50`. Default page size for search.

- [DateFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.DateFilter) (class): Instants and ranges. Values are ISO 8601 strings.

- [EnumFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.EnumFilter) (class): Equality against a closed set of options.

- [Field](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.Field) (class): A string-like field path that parses resource qualifiers and extracts the target path.

- [Filter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.Filter) (type alias): `type Filter = typing.Annotated[typing.Union[StringFilter, NumericFilter, MetricFilter, DateFilter, BooleanFilter, SetFilter, EnumFilter, IdentityFilter], pydantic.Field(discriminator='type')]`. One filter row. `type` selects the variant, and with it the operators on offer.

- [FilterMatchMode](/reference/python-sdk/roboto/query/filters#roboto.query.filters.FilterMatchMode) (class): How separate filters combine.

- [FilterOnlyComparator](/reference/python-sdk/roboto/query/filters#roboto.query.filters.FilterOnlyComparator) (class): Operators a saved filter needs that [`Comparator`](/reference/python-sdk/roboto/query/conditions#roboto.query.conditions.Comparator) cannot express.

- [IdentityComparator](/reference/python-sdk/roboto/query/filters#roboto.query.filters.IdentityComparator) (class): Operators over a principal-valued field, where the operator names a principal type.

- [IdentityFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.IdentityFilter) (class): A principal-valued field, filtered by principal type.

- [LabeledOption](/reference/python-sdk/roboto/query/filters#roboto.query.filters.LabeledOption) (class): One option as it was picked: the value a query is built from, plus what the picker showed.

- [MAX_PAGE_SIZE](/reference/python-sdk/roboto/query/specification#roboto.query.specification.MAX_PAGE_SIZE) (data): `MAX_PAGE_SIZE: int = 1000`. Maximum allowable page size for search.

- [METRIC_FIELD_PATTERN](/reference/python-sdk/roboto/query/filters#roboto.query.filters.METRIC_FIELD_PATTERN) (data): `METRIC_FIELD_PATTERN: Final[str] = '^metric\\..+'`

- [METRIC_FIELD_PREFIX](/reference/python-sdk/roboto/query/filters#roboto.query.filters.METRIC_FIELD_PREFIX) (data): `METRIC_FIELD_PREFIX: Final[str] = 'metric.'`. Prefix distinguishing a user-defined metric from an ordinary numeric property.

- [MetricFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.MetricFilter) (class): Ordering and equality over a user-defined metric.

- [NumericFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.NumericFilter) (class): Ordering and equality over a numeric property.

- [QualifiedRoboqlQuery](/reference/python-sdk/roboto/query/api#roboto.query.api.QualifiedRoboqlQuery) (class): A RoboQL query which has been qualified with a target.

- [Query](/reference/python-sdk/roboto/query/client#roboto.query.client.Query) (type alias): `type Query = typing.Union[RoboQLQuery, QuerySpecification]`

- [QueryClient](/reference/python-sdk/roboto/query/client#roboto.query.client.QueryClient) (class): A low-level Roboto query client. Prefer `RobotoSearch` for a simpler, more curated query interface.

- [QueryContentMode](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryContentMode) (class): Hint to query APIs on whether to return Roboto entities with custom metadata.

- [QueryContext](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryContext) (class): Context for a query

- [QueryRecord](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryRecord) (class): A wire-transmissible representation of a query.

- [QueryScheme](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryScheme) (class): A specific query format/schema which can be used in combination with some context JSON to provide all information required to execute a query.

- [QuerySpecification](/reference/python-sdk/roboto/query/specification#roboto.query.specification.QuerySpecification) (class): Model for specifying a query to the Roboto Platform.

- [QueryStatus](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryStatus) (class): The query lifecycle state of a given query.

- [QueryStorageContext](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryStorageContext) (class): Context for query storage

- [QueryStorageScheme](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryStorageScheme) (class): A specific query result storage format/schema which can be used in combination with some context JSON to provide all information required to vend query results

- [QueryTarget](/reference/python-sdk/roboto/query/api#roboto.query.api.QueryTarget) (class): The type of resource a specific query is requesting.

- [SavedFilters](/reference/python-sdk/roboto/query/filters#roboto.query.filters.SavedFilters) (class): A complete set of filter controls, as saved.

- [SetFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.SetFilter) (class): Membership in a collection-valued field, such as tags.

- [SortDirection](/reference/python-sdk/roboto/query/specification#roboto.query.specification.SortDirection) (class): The direction to sort the results of a query.

- [StringFilter](/reference/python-sdk/roboto/query/filters#roboto.query.filters.StringFilter) (class): Text matching.

- [SubmitRoboqlQueryRequest](/reference/python-sdk/roboto/query/api#roboto.query.api.SubmitRoboqlQueryRequest) (class): Request payload to submit a RoboQL query

- [SubmitStructuredQueryRequest](/reference/python-sdk/roboto/query/api#roboto.query.api.SubmitStructuredQueryRequest) (class): Request payload to submit a structured query

- [SubmitTermQueryRequest](/reference/python-sdk/roboto/query/api#roboto.query.api.SubmitTermQueryRequest) (class): Request payload to submit a simple term query