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

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

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

## Module Contents

### Classes

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

* - {py:obj}`BlueskyEventStream <bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream
    :summary:
    ```
* - {py:obj}`BlueskyEventStreamV2Mongo <bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo
    :summary:
    ```
* - {py:obj}`BlueskyEventStreamV2SQL <bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL
    :summary:
    ```
* - {py:obj}`ConfigDatasetClient <bluesky_tiled_plugins.clients.bluesky_event_stream.ConfigDatasetClient>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.ConfigDatasetClient
    :summary:
    ```
* - {py:obj}`CompositeSubsetClient <bluesky_tiled_plugins.clients.bluesky_event_stream.CompositeSubsetClient>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.CompositeSubsetClient
    :summary:
    ```
* - {py:obj}`VirtualContainer <bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualContainer>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualContainer
    :summary:
    ```
* - {py:obj}`VirtualArrayClient <bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient
    :summary:
    ```
* - {py:obj}`BlueskyEventStreamV3 <bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3
    :summary:
    ```
````

### Data

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

* - {py:obj}`DATAVALUES <bluesky_tiled_plugins.clients.bluesky_event_stream.DATAVALUES>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.DATAVALUES
    :summary:
    ```
* - {py:obj}`TIMESTAMPS <bluesky_tiled_plugins.clients.bluesky_event_stream.TIMESTAMPS>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.TIMESTAMPS
    :summary:
    ```
````

### API

````{py:data} DATAVALUES
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.DATAVALUES
:value: >
   'Sentinel(...)'

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.DATAVALUES
```

````

````{py:data} TIMESTAMPS
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.TIMESTAMPS
:value: >
   'Sentinel(...)'

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.TIMESTAMPS
```

````

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

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

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream
```

````{py:attribute} _repr_mimebundle__
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream._repr_mimebundle__
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream._repr_mimebundle__
```

````

`````

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

Bases: {py:obj}`bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo
```

````{py:property} descriptors
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo.descriptors

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo.descriptors
```

````

````{py:method} read(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo.read

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo.read
```

````

````{py:method} to_dask()
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo.to_dask

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2Mongo.to_dask
```

````

`````

`````{py:class} BlueskyEventStreamV2SQL(internal_dict, metadata=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL

Bases: {py:obj}`tiled.utils.OneShotCachedMap`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL
```

````{py:method} from_stream_client(stream_client, metadata=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL.from_stream_client
:classmethod:

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL.from_stream_client
```

````

````{py:method} descriptors()
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL.descriptors

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL.descriptors
```

````

````{py:method} read(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL.read

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV2SQL.read
```

````

`````

`````{py:class} ConfigDatasetClient(d: collections.abc.Mapping[tiled.utils.K, tiled.utils.V])
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.ConfigDatasetClient

Bases: {py:obj}`tiled.utils.DictView`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.ConfigDatasetClient
```

````{py:method} read()
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.ConfigDatasetClient.read

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.ConfigDatasetClient.read
```

````

`````

`````{py:class} CompositeSubsetClient(client, keys=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.CompositeSubsetClient

Bases: {py:obj}`tiled.client.composite.CompositeClient`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.CompositeSubsetClient
```

````{py:method} read(variables=None, dim0=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.CompositeSubsetClient.read

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.CompositeSubsetClient.read
```

````

`````

````{py:class} VirtualContainer(d: collections.abc.Mapping[tiled.utils.K, tiled.utils.V])
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualContainer

Bases: {py:obj}`tiled.utils.DictView`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualContainer
```

````

`````{py:class} VirtualArrayClient(data, dims=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient
```

````{py:method} read(slice=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.read

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.read
```

````

````{py:property} size
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.size

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.size
```

````

````{py:property} shape
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.shape

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.shape
```

````

````{py:property} dtype
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.dtype

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.dtype
```

````

````{py:property} dims
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.dims

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.VirtualArrayClient.dims
```

````

`````

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

Bases: {py:obj}`bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStream`, {py:obj}`tiled.client.composite.CompositeClient`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3
```

````{py:method} read(variables=(DATAVALUES, ), dim0=None)
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3.read

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3.read
```

````

````{py:method} descriptors()
:canonical: bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3.descriptors

```{autodoc2-docstring} bluesky_tiled_plugins.clients.bluesky_event_stream.BlueskyEventStreamV3.descriptors
```

````

`````