Class QueryProgress

Snapshot of the current phase of an in-flight SQL operation, suitable for binding to UI text near the busy indicator. The Agent emits its own 1Hz pulse over the DataChannel; this struct mirrors that into a single observable shape.

Inheritance
object
QueryProgress
Implements
Inherited Members
Namespace: Reportman.Hub.Client.DataChannel
Assembly: Reportman.DataChannel.dll
Syntax
public sealed record QueryProgress : IEquatable<QueryProgress>

Constructors

View Source

QueryProgress()

Declaration
public QueryProgress()

Fields

View Source

Idle

Declaration
public static readonly QueryProgress Idle
Field Value
Type Description
QueryProgress

Properties

View Source

BytesReceived

Bytes received / total during Delivering.

Declaration
public long BytesReceived { get; init; }
Property Value
Type Description
long
View Source

BytesTotal

Declaration
public long BytesTotal { get; init; }
Property Value
Type Description
long
View Source

ColumnCount

Declaration
public int ColumnCount { get; init; }
Property Value
Type Description
int
View Source

ElapsedSec

Seconds elapsed since the Agent received the request. Increases monotonically across all phases of a single query. Used to surface "Preparing 23 s" so the user knows the query is still alive even during long Plan/Execute phases with no row progress yet.

Declaration
public int ElapsedSec { get; init; }
Property Value
Type Description
int
View Source

Note

Free-form short status localized at the consumer site.

Declaration
public string? Note { get; init; }
Property Value
Type Description
string
View Source

Phase

Declaration
public QueryPhase Phase { get; init; }
Property Value
Type Description
QueryPhase
View Source

RowsRead

Live row count while Fetching.

Declaration
public int RowsRead { get; init; }
Property Value
Type Description
int

Methods

View Source

Compressing(int)

Declaration
public static QueryProgress Compressing(int elapsedSec)
Parameters
Type Name Description
int elapsedSec
Returns
Type Description
QueryProgress
View Source

Connecting(string?)

Declaration
public static QueryProgress Connecting(string? note = null)
Parameters
Type Name Description
string note
Returns
Type Description
QueryProgress
View Source

Decompressing(int)

Declaration
public static QueryProgress Decompressing(int elapsedSec)
Parameters
Type Name Description
int elapsedSec
Returns
Type Description
QueryProgress
View Source

Delivering(int, long, long)

Declaration
public static QueryProgress Delivering(int elapsedSec, long bytes, long total)
Parameters
Type Name Description
int elapsedSec
long bytes
long total
Returns
Type Description
QueryProgress
View Source

Deserializing(int)

Declaration
public static QueryProgress Deserializing(int elapsedSec)
Parameters
Type Name Description
int elapsedSec
Returns
Type Description
QueryProgress
View Source

Done()

Declaration
public static QueryProgress Done()
Returns
Type Description
QueryProgress
View Source

Equals(QueryProgress?)

Declaration
public bool Equals(QueryProgress? other)
Parameters
Type Name Description
QueryProgress other
Returns
Type Description
bool
View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

Executing(int)

Declaration
public static QueryProgress Executing(int elapsedSec)
Parameters
Type Name Description
int elapsedSec
Returns
Type Description
QueryProgress
View Source

Fetching(int, int, int)

Declaration
public static QueryProgress Fetching(int elapsedSec, int rows, int cols)
Parameters
Type Name Description
int elapsedSec
int rows
int cols
Returns
Type Description
QueryProgress
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

Preparing(int)

Declaration
public static QueryProgress Preparing(int elapsedSec)
Parameters
Type Name Description
int elapsedSec
Returns
Type Description
QueryProgress
View Source

Serializing(int)

Declaration
public static QueryProgress Serializing(int elapsedSec)
Parameters
Type Name Description
int elapsedSec
Returns
Type Description
QueryProgress
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(QueryProgress?, QueryProgress?)

Declaration
public static bool operator ==(QueryProgress? left, QueryProgress? right)
Parameters
Type Name Description
QueryProgress left
QueryProgress right
Returns
Type Description
bool
View Source

operator !=(QueryProgress?, QueryProgress?)

Declaration
public static bool operator !=(QueryProgress? left, QueryProgress? right)
Parameters
Type Name Description
QueryProgress left
QueryProgress right
Returns
Type Description
bool

Implements