Skip to content

StreamingQueryListener

Defined in: streaming/streaming-query-listener.ts:38

Callback interface for streaming-query lifecycle events. Implement any subset of the callbacks; the bus skips the ones you don’t define.

Callbacks dispatch serially per session, so a slow callback delays the next event. async callbacks are awaited; queue inside the callback if you need parallel work.

Spark source: StreamingQueryListener.scala

optional onQueryIdle(event): void | Promise<void>;

Defined in: streaming/streaming-query-listener.ts:41

Parameter Type
event QueryIdleEvent

void | Promise<void>


optional onQueryProgress(event): void | Promise<void>;

Defined in: streaming/streaming-query-listener.ts:40

Parameter Type
event StreamingQueryProgress

void | Promise<void>


optional onQueryStarted(event): void | Promise<void>;

Defined in: streaming/streaming-query-listener.ts:39

Parameter Type
event QueryStartedEvent

void | Promise<void>


optional onQueryTerminated(event): void | Promise<void>;

Defined in: streaming/streaming-query-listener.ts:42

Parameter Type
event QueryTerminatedEvent

void | Promise<void>