# {py:mod}`bluesky_tiled_plugins.clients.bluesky_run`

```{py:module} bluesky_tiled_plugins.clients.bluesky_run
```

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`BlueskyRun <bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun
    :summary:
    ```
* - {py:obj}`BlueskyRunV2 <bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2
    :summary:
    ```
* - {py:obj}`BlueskyRunV2Mongo <bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo
    :summary:
    ```
* - {py:obj}`BlueskyRunV2SQL <bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2SQL>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2SQL
    :summary:
    ```
* - {py:obj}`BlueskyRunV3 <bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3
    :summary:
    ```
````

### API

`````{py:class} BlueskyRun(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun

Bases: {py:obj}`tiled.client.container.Container`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun
```

````{py:property} start
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.start

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.start
```

````

````{py:property} stop
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.stop

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.stop
```

````

````{py:method} descriptors()
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.descriptors

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.descriptors
```

````

````{py:method} describe()
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.describe

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.describe
```

````

````{py:method} read()
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.read
:abstractmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.read
```

````

````{py:property} base
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.base

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.base
```

````

````{py:attribute} to_dask
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.to_dask
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun.to_dask
```

````

`````

`````{py:class} BlueskyRunV2(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2

Bases: {py:obj}`bluesky_tiled_plugins.clients.bluesky_run.BlueskyRun`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2
```

````{py:property} v1
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2.v1

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2.v1
```

````

````{py:property} v2
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2.v2

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2.v2
```

````

````{py:property} v3
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2.v3

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2.v3
```

````

`````

`````{py:class} BlueskyRunV2Mongo(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo

Bases: {py:obj}`bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo
```

````{py:method} documents(fill=False)
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo.documents

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2Mongo.documents
```

````

`````

````{py:class} BlueskyRunV2SQL(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2SQL

Bases: {py:obj}`bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2`, {py:obj}`bluesky_tiled_plugins.clients.bluesky_run._BlueskyRunSQL`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV2SQL
```

````

`````{py:class} BlueskyRunV3(context, *, item, structure_clients, queries=None, sorting=None, structure=None, include_data_sources=False)
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3

Bases: {py:obj}`bluesky_tiled_plugins.clients.bluesky_run._BlueskyRunSQL`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3
```

````{py:property} v1
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3.v1

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3.v1
```

````

````{py:property} v2
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3.v2

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3.v2
```

````

````{py:property} v3
:canonical: bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3.v3

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_run.BlueskyRunV3.v3
```

````

`````