yr.delete_stream

Contents

yr.delete_stream#

yr.delete_stream(stream_name: str) → None[source]#

Delete the data stream. When the global count of producers and consumers is 0, the data stream is no longer in use, and the metadata related to the data stream on each worker and master is cleaned up. This function can be called on any Host node.

Parameters:

stream_name (str) – The name of the stream. The length must be less than 256 characters and contain only the following characters (a-zA-Z0-9~.-/_!@#%^&*()+=;:) .

Returns:

None.

Raises:

RuntimeError – If the stream fails to be deleted in the data system, an exception will be thrown.

Examples

>>> try:
...     yr.delete_stream("streamName")
... except RuntimeError as exp:
...     pass
Contents