Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A handle to a query that is executing continuously in the background as new data arrives.
public sealed class StreamingQuery
type StreamingQuery = class
Public NotInheritable Class StreamingQuery
Returns the unique id of this query that persists across restarts from checkpoint data. That is, this id is generated when a query is started for the first time, and will be the same every time it is restarted from checkpoint data. Also see RunId.
Returns the user-specified name of the query, or null if not specified.
Returns the unique id of this run of the query. That is, every start/restart of a query will generated a unique runId. Therefore, every time a query is restarted from checkpoint, it will have the same Id but different RunIds.
Waits for the termination of this query, either by Stop() or by an exception.
Returns true if this query is terminated within the timeout in milliseconds.
The StreamingQueryException if the query was terminated by an exception, null otherwise.
Prints the physical plan to the console for debugging purposes.
Returns true if this query is actively running.
Blocks until all available data in the source has been processed and committed to the
sink. This method is intended for testing. Note that in the case of continually
arriving data, this method may block forever. Additionally, this method is only
guaranteed to block until data that has been synchronously appended data to a
Stops the execution of this query if it is running. This method blocks until the threads performing execution stop.