bluesky_tiled_plugins.clients.bluesky_run

Module Contents

Classes

BlueskyRun	A Mapping is a generic container for associating key/value pairs.
BlueskyRunV2	A MongoDB-native layout of BlueskyRuns
BlueskyRunV2Mongo	A MongoDB-native layout of BlueskyRuns
BlueskyRunV2SQL	A MongoDB-native layout of BlueskyRuns
BlueskyRunV3	A BlueskyRun that is backed by a SQL database.

API

class bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

Bases: tiled.client.container.Container

A Mapping is a generic container for associating key/value pairs.

This class provides concrete generic implementations of all methods except for getitem, iter, and len.

property start

The Run Start document. A convenience alias:

run.start is run.metadata[“start”] True

property stop

The Run Stop document. A convenience alias:

run.stop is run.metadata[“stop”] True

descriptors()

describe()

For back-compat with intake-based BlueskyRun

abstractmethod read()

property base

Return the base Container client instead of a BlueskyRun client

to_dask

None

class bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

Bases: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun

A MongoDB-native layout of BlueskyRuns

This layout has been in use prior to the introduction of SQL backend in May 2025.

property v1

Accessor to legacy interface.

property v2

property v3

class bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

Bases: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2

A MongoDB-native layout of BlueskyRuns

This layout has been in use prior to the introduction of SQL backend in May 2025.

documents(fill=False)

class bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2SQL(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

Bases: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2, bluesky_tiled_plugins.clients.bluesky_run._BlueskyRunSQL

A MongoDB-native layout of BlueskyRuns

This layout has been in use prior to the introduction of SQL backend in May 2025.

class bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)

Bases: bluesky_tiled_plugins.clients.bluesky_run._BlueskyRunSQL

A BlueskyRun that is backed by a SQL database.

property v1

Access to legacy interface

property v2

property v3