roboto.query.api

Module Contents

QualifiedRoboqlQuery

class roboto.query.api.QualifiedRoboqlQuery(/, **data)#

Bases: pydantic.BaseModel

A RoboQL query which has been qualified with a target.

Parameters

data Any

Attributes

QualifiedRoboqlQuery.query

query str = None #

QualifiedRoboqlQuery.target

target QueryTarget = None #

QueryContentMode

class roboto.query.api.QueryContentMode#

Bases: roboto.compat.StrEnum

Hint to query APIs on whether to return Roboto entities with custom metadata.

In RecordOnly mode, Roboto entities are returned without custom metadata, ensuring a smaller and more predictable response size. Use this mode when you need lower query latency, larger result page sizes, or both.

In RecordWithMeta mode, Roboto entities are returned with all available custom metadata. Use this mode if you need immediate access to metadata fields.

Note: content mode support is initially available for dataset queries, and will be added incrementally for other entity types.

Attributes

QueryContentMode.RecordOnly

RecordOnly = 'record_only' #

Query results are returned with core Roboto data attributes only.

Those attributes establish the identity and function of Roboto entities.

QueryContentMode.RecordWithMeta

RecordWithMeta = 'record_with_meta' #

Query results are returned with all available entity attributes.

This includes core Roboto data attributes as well as custom metadata.

QueryContext

class roboto.query.api.QueryContext(/, **data)#

Bases: pydantic.BaseModel

Context for a query

Parameters

data Any

Attributes

QueryContext.query

query dict[str, Any] = None #

QueryContext.query_scheme

query_scheme QueryScheme #

QueryRecord

class roboto.query.api.QueryRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a query.

Parameters

data Any

Attributes

QueryRecord.modified

modified datetime.datetime = None #

QueryRecord.org_id

org_id str = None #

QueryRecord.query_ctx

query_ctx QueryContext = None #

QueryRecord.query_id

query_id str = None #

QueryRecord.result_count

result_count int = None #

QueryRecord.status

status QueryStatus = None #

QueryRecord.submitted

submitted datetime.datetime = None #

QueryRecord.submitted_by

submitted_by str = None #

QueryRecord.target

target QueryTarget = None #

QueryScheme

class roboto.query.api.QueryScheme#

Bases: roboto.compat.StrEnum

A specific query format/schema which can be used in combination with some context JSON to provide all information required to execute a query.

Attributes

QueryScheme.QuerySpecV1

QuerySpecV1 = 'query_spec_v1' #

The initial variant of roboto.query.QuerySpecification which powered search since mid 2023.

QueryStatus

class roboto.query.api.QueryStatus(*args, **kwds)#

Bases: enum.Enum

The query lifecycle state of a given query.

Attributes

QueryStatus.Failed

Failed = 'failed' #

Indicates the query failed to execute.

QueryStatus.ResultsAvailable

ResultsAvailable = 'results_available' #

Indicates that query results are available for clients to retrieve.

Results might be available immediately, such as in paginated database search, or once a (potentially expensive) calculation completes for more advanced search modalities.

QueryStatus.Scheduled

Scheduled = 'scheduled' #

Indicates the query is scheduled for execution.

QueryStorageContext

class roboto.query.api.QueryStorageContext(/, **data)#

Bases: pydantic.BaseModel

Context for query storage

Parameters

data Any

Attributes

QueryStorageContext.storage_ctx

storage_ctx dict[str, Any] = None #

QueryStorageContext.storage_scheme

storage_scheme QueryStorageScheme #

QueryStorageScheme

class roboto.query.api.QueryStorageScheme#

Bases: roboto.compat.StrEnum

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

Attributes

QueryStorageScheme.S3ManifestV1

S3ManifestV1 = 's3_manifest_v1' #

Query results are in S3, and a manifest file enumerates the result parts and how to resolve them into rows.

QueryTarget

class roboto.query.api.QueryTarget#

Bases: roboto.compat.StrEnum

The type of resource a specific query is requesting.

Attributes

QueryTarget.Collections

Collections = 'collections' #

QueryTarget.Datasets

Datasets = 'datasets' #

QueryTarget.Devices

Devices = 'devices' #

QueryTarget.Events

Events = 'events' #

QueryTarget.Files

Files = 'files' #

QueryTarget.Sessions

Sessions = 'sessions' #

QueryTarget.TopicMessagePaths

TopicMessagePaths = 'topic_message_paths' #

QueryTarget.Topics

Topics = 'topics' #

SubmitRoboqlQueryRequest

class roboto.query.api.SubmitRoboqlQueryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to submit a RoboQL query

Parameters

data Any

Attributes

SubmitRoboqlQueryRequest.content_mode

content_mode QueryContentMode = None #

SubmitRoboqlQueryRequest.query

query str | None = None #

SubmitRoboqlQueryRequest.target

target QueryTarget = None #

SubmitStructuredQueryRequest

class roboto.query.api.SubmitStructuredQueryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to submit a structured query

Parameters

data Any

Attributes

SubmitStructuredQueryRequest.content_mode

content_mode QueryContentMode = None #

SubmitStructuredQueryRequest.query

query roboto.query.specification.QuerySpecification = None #

SubmitStructuredQueryRequest.target

target QueryTarget = None #

SubmitTermQueryRequest

class roboto.query.api.SubmitTermQueryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to submit a simple term query

Parameters

data Any

Attributes

SubmitTermQueryRequest.content_mode

content_mode QueryContentMode = None #

SubmitTermQueryRequest.target

target QueryTarget = None #

SubmitTermQueryRequest.term

term str = None #