bluesky_tiled_plugins.queries#

This module defines objects designed to make queries on CatalogOfBlueskyRuns convenient.

Older clients used these query object to issue custom query types. This requires servers to register custom implementations of those query types.

Newer clients use these object as pure client-side conveniences. In CatalogOfBlueskyRuns.search method, they are decomposed into standard Tiled queries, requiring no custom counterpart on the server.

The registration and serialization aspects are (temporarily) retained in order to support older clients querying against MongoDB-backed servers.

Module Contents#

Classes#

Duplicates

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

ScanIDRange

Find scans in the range.

TimeRange

Functions#

API#

class bluesky_tiled_plugins.queries.Duplicates#

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

latest#

‘latest’

all#

‘all’

error#

‘error’

bluesky_tiled_plugins.queries.ScanID(*scan_ids, duplicates='latest')#
class bluesky_tiled_plugins.queries.ScanIDRange(start_id, end_id, duplicates='latest')#

Find scans in the range.

start_id: int#

None

end_id: int#

None

duplicates: bluesky_tiled_plugins.queries.Duplicates#

None

encode()#
classmethod decode(*, start_id, end_id, duplicates='latest')#
bluesky_tiled_plugins.queries.PartialUID(*partial_uids)#
bluesky_tiled_plugins.queries.RawMongo(start)#

DEPRECATED

Raw MongoDB queries are no longer supported. If it is possible to express the import as a supported query, we transform it and warn. If not, we raise an error.

class bluesky_tiled_plugins.queries.TimeRange(*, timezone=None, since=None, until=None)#
timezone: str#

None

since: float | None#

None

until: float | None#

None

encode()#
classmethod decode(*, timezone, since=None, until=None)#