mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-13 17:23:02 -05:00
6dd9a4b5f1
This changes adds the following two notifications from the results processing within a batch. These new notifications allows a consumer to stream results from a resultset instead of getting them all at once after the entire resultset has been fetched. ResultsAvailable This is issued after at least 1 row has been fetched for this resultset. ResultsUpdated This is issued periodically as more rows are available on this resultset. The final send of this notification when all rows have been fetched has the property 'Complete' set to true in the ResultSummary object. Detailed Change Log: * Initial completed implementation of QueryResults stream feature. 3 unittests still need fixing * Fix for the 3 failing test. I will look into making MockBehavior strict again for the three tests later * Making GetReader/GetWriter use filestream objects in FileShare.ReadWrite mode so the file can be concurrently read and written * Changing resultsAvailable also to fire off on a timer instead of after 1st row * adding a project for clr TableValuedFunction to produce result set with delays after each row. This is helpful in end to end testing. * Fixing up some tests and simplifying implementation of result update timer * Address review comments * Some test fixes * Disabled flaky test verification
47 lines
1.6 KiB
C#
47 lines
1.6 KiB
C#
//
|
|
// Copyright (c) Microsoft. All rights reserved.
|
|
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
//
|
|
|
|
namespace Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts
|
|
{
|
|
/// <summary>
|
|
/// Represents a summary of information about a result without returning any cells of the results
|
|
/// </summary>
|
|
public class ResultSetSummary
|
|
{
|
|
/// <summary>
|
|
/// The ID of the result set within the batch results
|
|
/// </summary>
|
|
public int Id { get; set; }
|
|
|
|
/// <summary>
|
|
/// The ID of the batch set within the query
|
|
/// </summary>
|
|
public int BatchId { get; set; }
|
|
|
|
/// <summary>
|
|
/// The number of rows that are available for the resultset thus far
|
|
/// </summary>
|
|
public long RowCount { get; set; }
|
|
|
|
/// <summary>
|
|
/// If true it indicates that all rows have been fetched and the RowCount being sent across is final for this ResultSet
|
|
/// </summary>
|
|
public bool Complete { get; set; }
|
|
|
|
/// <summary>
|
|
/// Details about the columns that are provided as solutions
|
|
/// </summary>
|
|
public DbColumnWrapper[] ColumnInfo { get; set; }
|
|
|
|
/// <summary>
|
|
/// The special action definition of the result set
|
|
/// </summary>
|
|
public SpecialAction SpecialAction { get; set; }
|
|
|
|
public override string ToString() => $"Result Summary Id:{Id}, Batch Id:'{BatchId}', RowCount:'{RowCount}', Complete:'{Complete}', SpecialAction:'{SpecialAction}'";
|
|
|
|
}
|
|
}
|