Improve this Doc View Source

Class QueryExecutionService

Service for executing queries

Inheritance

System.Object

QueryExecutionService

Namespace:Microsoft.SqlTools.ServiceLayer.QueryExecution

Assembly:Microsoft.SqlTools.ServiceLayer.dll

Syntax

public sealed class QueryExecutionService : IDisposable

Properties

| Improve this Doc View Source

Instance

Singleton instance of the query execution service

Declaration

public static QueryExecutionService Instance { get; }

Type	Description
QueryExecutionService

Methods

| Improve this Doc View Source

Dispose()

Declaration

public void Dispose()

| Improve this Doc View Source

Finalize()

Declaration

protected void Finalize()

| Improve this Doc View Source

HandleCancelRequest(QueryCancelParams, RequestContext<QueryCancelResult>)

Handles a request to cancel this query if it is in progress

Declaration

public Task HandleCancelRequest(QueryCancelParams cancelParams, RequestContext<QueryCancelResult> requestContext)

Parameters

Type	Name	Description
QueryCancelParams	cancelParams
RequestContext<QueryCancelResult>	requestContext

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

HandleDisposeRequest(QueryDisposeParams, RequestContext<QueryDisposeResult>)

Handles a request to dispose of this query

Declaration

public Task HandleDisposeRequest(QueryDisposeParams disposeParams, RequestContext<QueryDisposeResult> requestContext)

Parameters

Type	Name	Description
QueryDisposeParams	disposeParams
RequestContext<QueryDisposeResult>	requestContext

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

HandleExecuteRequest(QueryExecuteParams, RequestContext<QueryExecuteResult>)

Handles request to execute the query

Declaration

public Task HandleExecuteRequest(QueryExecuteParams executeParams, RequestContext<QueryExecuteResult> requestContext)

Parameters

Type	Name	Description
QueryExecuteParams	executeParams
RequestContext<QueryExecuteResult>	requestContext

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

HandleResultSubsetRequest(QueryExecuteSubsetParams, RequestContext<QueryExecuteSubsetResult>)

Handles a request to get a subset of the results of this query

Declaration

public Task HandleResultSubsetRequest(QueryExecuteSubsetParams subsetParams, RequestContext<QueryExecuteSubsetResult> requestContext)

Parameters

Type	Name	Description
QueryExecuteSubsetParams	subsetParams
RequestContext<QueryExecuteSubsetResult>	requestContext

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

InitializeService(ServiceHost)

Initializes the service with the service host, registers request handlers and shutdown event handler.

Declaration

public void InitializeService(ServiceHost serviceHost)

Parameters

Type	Name	Description
ServiceHost	serviceHost	The service host instance to register with