mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-22 09:35:38 -05:00
209 lines
13 KiB
HTML
209 lines
13 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>Namespace Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Namespace Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
|
|
">
|
|
<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_Contracts" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts">Namespace Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
|
|
</h1>
|
|
<div class="markdown level0 summary"></div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="markdown level0 remarks"></div>
|
|
<h3 id="classes">Classes
|
|
</h3>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.BatchSummary.html">BatchSummary</a></h4>
|
|
<section><p>Summary of a batch within a query</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue.html">DbCellValue</a></h4>
|
|
<section><p>Class used for internally passing results from a cell around.</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbColumnWrapper.html">DbColumnWrapper</a></h4>
|
|
<section><p>Wrapper around a DbColumn, which provides extra functionality, but can be used as a
|
|
regular DbColumn</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelParams.html">QueryCancelParams</a></h4>
|
|
<section><p>Parameters for the query cancellation request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelRequest.html">QueryCancelRequest</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryCancelResult.html">QueryCancelResult</a></h4>
|
|
<section><p>Parameters to return as the result of a query dispose request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeParams.html">QueryDisposeParams</a></h4>
|
|
<section><p>Parameters for the query dispose request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeRequest.html">QueryDisposeRequest</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryDisposeResult.html">QueryDisposeResult</a></h4>
|
|
<section><p>Parameters to return as the result of a query dispose request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteBatchCompleteEvent.html">QueryExecuteBatchCompleteEvent</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteBatchNotificationParams.html">QueryExecuteBatchNotificationParams</a></h4>
|
|
<section><p>Parameters to be sent back as part of a QueryExecuteBatchCompleteEvent to indicate that a
|
|
batch of a query completed.</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteBatchStartEvent.html">QueryExecuteBatchStartEvent</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteCompleteEvent.html">QueryExecuteCompleteEvent</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteCompleteParams.html">QueryExecuteCompleteParams</a></h4>
|
|
<section><p>Parameters to be sent back with a query execution complete event</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteParams.html">QueryExecuteParams</a></h4>
|
|
<section><p>Parameters for the query execute request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteRequest.html">QueryExecuteRequest</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteResult.html">QueryExecuteResult</a></h4>
|
|
<section><p>Parameters for the query execute result</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteResultSetCompleteEvent.html">QueryExecuteResultSetCompleteEvent</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteResultSetCompleteParams.html">QueryExecuteResultSetCompleteParams</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetParams.html">QueryExecuteSubsetParams</a></h4>
|
|
<section><p>Parameters for a query result subset retrieval request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetRequest.html">QueryExecuteSubsetRequest</a></h4>
|
|
<section></section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.QueryExecuteSubsetResult.html">QueryExecuteSubsetResult</a></h4>
|
|
<section><p>Parameters for the result of a subset retrieval request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.ResultMessage.html">ResultMessage</a></h4>
|
|
<section><p>Result message object with timestamp and actual message</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.ResultSetSubset.html">ResultSetSubset</a></h4>
|
|
<section><p>Class used to represent a subset of results from a query for transmission across JSON RPC</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.ResultSetSummary.html">ResultSetSummary</a></h4>
|
|
<section><p>Represents a summary of information about a result without returning any cells of the results</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultRequestError.html">SaveResultRequestError</a></h4>
|
|
<section><p>Error object for save result </p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultRequestResult.html">SaveResultRequestResult</a></h4>
|
|
<section><p>Parameters for the save results result</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultsAsCsvRequest.html">SaveResultsAsCsvRequest</a></h4>
|
|
<section><p>Request type to save results as CSV</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultsAsCsvRequestParams.html">SaveResultsAsCsvRequestParams</a></h4>
|
|
<section><p>Parameters to save results as CSV</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultsAsJsonRequest.html">SaveResultsAsJsonRequest</a></h4>
|
|
<section><p>Request type to save results as JSON</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultsAsJsonRequestParams.html">SaveResultsAsJsonRequestParams</a></h4>
|
|
<section><p>Parameters to save results as JSON</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SaveResultsRequestParams.html">SaveResultsRequestParams</a></h4>
|
|
<section><p>Parameters for the save results request</p>
|
|
</section>
|
|
<h4><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.SelectionData.html">SelectionData</a></h4>
|
|
<section><p>Container class for a selection range from file </p>
|
|
</section>
|
|
</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_Contracts.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts%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>
|
|
</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>
|