mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-23 09:35:38 -05:00
670 lines
42 KiB
HTML
670 lines
42 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 Batch
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class Batch
|
|
">
|
|
|
|
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/style.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
<!--
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-63735192-1', 'auto');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
-->
|
|
</head> <body data-spy="scroll" data-target="#affix">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav class="navbar navbar-inverse">
|
|
<div class="container">
|
|
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
|
|
<div class="navbar-header ">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="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="../"><span class="dotnet">SQL Tools Service</span></a>
|
|
</div>
|
|
<div id="navbar" class="collapse navbar-collapse">
|
|
</div><!--/.nav-collapse -->
|
|
</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">
|
|
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch%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="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L24" class="pull-right mobile-hide">View Source</a>
|
|
<h1 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch">Class Batch
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class represents a batch within a query</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">Batch</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_Batch_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class Batch : 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_Batch_BatchText.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchText%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/Batch.cs/#L109">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_BatchText" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchText">BatchText</h4>
|
|
<div class="markdown level1 summary"><p>The text of batch that will be executed</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string BatchText { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.String</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_Batch_ExecutionElapsedTime.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionElapsedTime%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/Batch.cs/#L120">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionElapsedTime" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionElapsedTime">ExecutionElapsedTime</h4>
|
|
<div class="markdown level1 summary"><p>Localized timestamp for how long it took for the execution to complete</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ExecutionElapsedTime { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.String</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_Batch_ExecutionEndTimeStamp.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionEndTimeStamp%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/Batch.cs/#L115">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionEndTimeStamp" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionEndTimeStamp">ExecutionEndTimeStamp</h4>
|
|
<div class="markdown level1 summary"><p>Localized timestamp for when the execution completed.
|
|
Stored in UTC ISO 8601 format; should be localized before displaying to any user</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ExecutionEndTimeStamp { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.String</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_Batch_ExecutionStartTimeStamp.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionStartTimeStamp%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/Batch.cs/#L133">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionStartTimeStamp" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionStartTimeStamp">ExecutionStartTimeStamp</h4>
|
|
<div class="markdown level1 summary"><p>Localized timestamp for when the execution began.
|
|
Stored in UTC ISO 8601 format; should be localized before displaying to any user</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string ExecutionStartTimeStamp { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.String</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_Batch_HasError.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasError%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/Batch.cs/#L138">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_HasError" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasError">HasError</h4>
|
|
<div class="markdown level1 summary"><p>Whether or not this batch has an error</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool HasError { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Boolean</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_Batch_HasExecuted.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasExecuted%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/Batch.cs/#L143">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_HasExecuted" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasExecuted">HasExecuted</h4>
|
|
<div class="markdown level1 summary"><p>Whether or not this batch has been executed, regardless of success or failure </p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool HasExecuted { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Boolean</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_Batch_Id.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Id%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/Batch.cs/#L148">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Id" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Id">Id</h4>
|
|
<div class="markdown level1 summary"><p>Ordinal of the batch in the query</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int Id { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Int32</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_Batch_ResultMessages.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultMessages%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/Batch.cs/#L153">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultMessages" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultMessages">ResultMessages</h4>
|
|
<div class="markdown level1 summary"><p>Messages that have come back from the server</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IEnumerable<ResultMessage> ResultMessages { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Collections.Generic.IEnumerable</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.ResultMessage.html">ResultMessage</a>></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_Batch_ResultSets.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSets%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/Batch.cs/#L161">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSets" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSets">ResultSets</h4>
|
|
<div class="markdown level1 summary"><p>The result sets of the batch execution</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IList<ResultSet> ResultSets { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Collections.Generic.IList</span><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.html">ResultSet</a>></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_Batch_ResultSummaries.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSummaries%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/Batch.cs/#L169">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSummaries" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSummaries">ResultSummaries</h4>
|
|
<div class="markdown level1 summary"><p>Property for generating a set result set summaries from the result sets</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ResultSetSummary[] ResultSummaries { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Contracts.ResultSetSummary.html">ResultSetSummary</a>[]</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_Batch_Summary.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Summary%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/Batch.cs/#L183">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Summary" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Summary">Summary</h4>
|
|
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.BatchSummary.html">BatchSummary</a> based on the batch instance</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public BatchSummary Summary { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue"></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.Contracts.BatchSummary.html">BatchSummary</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_Batch_Dispose.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.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/Batch.cs/#L453">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.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>
|
|
<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_Batch_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose(System.Boolean)%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/Batch.cs/#L459">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose(System.Boolean)">Dispose(Boolean)</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 virtual void Dispose(bool disposing)</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><span class="xref">System.Boolean</span></td>
|
|
<td><em>disposing</em></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_Batch_Execute_System_Data_Common_DbConnection_System_Threading_CancellationToken_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Execute(System.Data.Common.DbConnection%2CSystem.Threading.CancellationToken)%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/Batch.cs/#L223">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Execute_System_Data_Common_DbConnection_System_Threading_CancellationToken_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Execute(System.Data.Common.DbConnection,System.Threading.CancellationToken)">Execute(DbConnection, CancellationToken)</h4>
|
|
<div class="markdown level1 summary"><p>Executes this batch and captures any server messages that are returned.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task Execute(DbConnection conn, CancellationToken cancellationToken)</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><span class="xref">System.Data.Common.DbConnection</span></td>
|
|
<td><em>conn</em></td>
|
|
<td><p>The connection to use to execute the batch</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Threading.CancellationToken</span></td>
|
|
<td><em>cancellationToken</em></td>
|
|
<td><p>Token for cancelling the execution</p>
|
|
</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_Batch_GetSubset_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.GetSubset(System.Int32%2CSystem.Int32%2CSystem.Int32)%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/Batch.cs/#L352">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_GetSubset_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.GetSubset(System.Int32,System.Int32,System.Int32)">GetSubset(Int32, Int32, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Generates a subset of the rows from a result set of the batch</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task<ResultSetSubset> GetSubset(int resultSetIndex, int startRow, int rowCount)</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><span class="xref">System.Int32</span></td>
|
|
<td><em>resultSetIndex</em></td>
|
|
<td><p>The index for selecting the result set</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><em>startRow</em></td>
|
|
<td><p>The starting row of the results</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><em>rowCount</em></td>
|
|
<td><p>How many rows to retrieve</p>
|
|
</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><<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.ResultSetSubset.html">ResultSetSubset</a>></td>
|
|
<td><p>A subset of results</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="events">Events
|
|
</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_Batch_BatchCompletion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchCompletion%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/Batch.cs/#L89">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_BatchCompletion" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchCompletion">BatchCompletion</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be called when the batch has completed execution</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Batch.BatchAsyncEventHandler BatchCompletion</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_Batch_BatchStart.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchStart%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/Batch.cs/#L94">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_BatchStart" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchStart">BatchStart</h4>
|
|
<div class="markdown level1 summary"><p>Event to call when the batch has started execution</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Batch.BatchAsyncEventHandler BatchStart</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_Batch_ResultSetCompletion.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSetCompletion%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/Batch.cs/#L100">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSetCompletion" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSetCompletion">ResultSetCompletion</h4>
|
|
<div class="markdown level1 summary"><p>Event that will be called when the resultset has completed execution. It will not be
|
|
called from the Batch but from the ResultSet instance</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event ResultSet.ResultSetAsyncEventHandler ResultSetCompletion</code></pre>
|
|
</div>
|
|
</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_Batch.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch%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/Batch.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="inner-footer">
|
|
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
|
</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>
|