mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-22 09:35:38 -05:00
464 lines
32 KiB
HTML
464 lines
32 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class QueryExecutionService
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class QueryExecutionService
|
|
">
|
|
<meta name="generator" content="docfx 1.0.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content">
|
|
|
|
|
|
<h1 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService">Class QueryExecutionService
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Service for executing queries</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">QueryExecutionService</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.QueryExecution</h6>
|
|
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
|
<h5 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class QueryExecutionService : IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Instance.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Instance%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Instance_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Instance*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Instance" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Instance">Instance</h4>
|
|
<div class="markdown level1 summary"><p>Singleton instance of the query execution service</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static QueryExecutionService Instance { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.html">QueryExecutionService</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Dispose.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L503">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Dispose_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Dispose*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
<h5 class="implements">Implements</h5>
|
|
<div><span class="xref">System.IDisposable.Dispose()</span></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Finalize.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Finalize%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L541">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Finalize_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Finalize*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_Finalize" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.Finalize">Finalize()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void Finalize()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleCancelRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryCancelParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryCancelResult__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleCancelRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BMicrosoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelResult%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L216">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleCancelRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleCancelRequest*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleCancelRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryCancelParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryCancelResult__" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleCancelRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelResult})">HandleCancelRequest(QueryCancelParams, RequestContext<QueryCancelResult>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task HandleCancelRequest(QueryCancelParams cancelParams, RequestContext<QueryCancelResult> requestContext)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelParams.html">QueryCancelParams</a></td>
|
|
<td><span class="parametername">cancelParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelResult.html">QueryCancelResult</a>></td>
|
|
<td><span class="parametername">requestContext</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleDisposeRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryDisposeParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryDisposeResult__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleDisposeRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BMicrosoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeResult%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L185">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleDisposeRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleDisposeRequest*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleDisposeRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryDisposeParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryDisposeResult__" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleDisposeRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeResult})">HandleDisposeRequest(QueryDisposeParams, RequestContext<QueryDisposeResult>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task HandleDisposeRequest(QueryDisposeParams disposeParams, RequestContext<QueryDisposeResult> requestContext)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeParams.html">QueryDisposeParams</a></td>
|
|
<td><span class="parametername">disposeParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeResult.html">QueryDisposeResult</a>></td>
|
|
<td><span class="parametername">requestContext</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleExecuteRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteResult__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleExecuteRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BMicrosoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteResult%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L127">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleExecuteRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleExecuteRequest*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleExecuteRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteResult__" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleExecuteRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteResult})">HandleExecuteRequest(QueryExecuteParams, RequestContext<QueryExecuteResult>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task HandleExecuteRequest(QueryExecuteParams executeParams, RequestContext<QueryExecuteResult> requestContext)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteParams.html">QueryExecuteParams</a></td>
|
|
<td><span class="parametername">executeParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteResult.html">QueryExecuteResult</a>></td>
|
|
<td><span class="parametername">requestContext</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleResultSubsetRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteSubsetParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteSubsetResult__.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleResultSubsetRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetParams%2CMicrosoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext%7BMicrosoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetResult%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L137">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleResultSubsetRequest_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleResultSubsetRequest*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_HandleResultSubsetRequest_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteSubsetParams_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_QueryExecuteSubsetResult__" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.HandleResultSubsetRequest(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetParams,Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext{Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetResult})">HandleResultSubsetRequest(QueryExecuteSubsetParams, RequestContext<QueryExecuteSubsetResult>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task HandleResultSubsetRequest(QueryExecuteSubsetParams subsetParams, RequestContext<QueryExecuteSubsetResult> requestContext)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetParams.html">QueryExecuteSubsetParams</a></td>
|
|
<td><span class="parametername">subsetParams</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.RequestContext-1.html">RequestContext</a><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetResult.html">QueryExecuteSubsetResult</a>></td>
|
|
<td><span class="parametername">requestContext</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L100">View Source</a>
|
|
</span>
|
|
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_InitializeService_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.InitializeService*"></a>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService_InitializeService_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService.InitializeService(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost)">InitializeService(ServiceHost)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes the service with the service host, registers request handlers and shutdown
|
|
event handler.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void InitializeService(ServiceHost serviceHost)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.html">ServiceHost</a></td>
|
|
<td><span class="parametername">serviceHost</span></td>
|
|
<td><p>The service host instance to register with</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_QueryExecutionService.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs/#L24" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|