Table of Contents

Class ArchetypeAccess

Namespace
Typhon.Engine
Assembly
Typhon.Engine.dll

The access path one archetype took during an explained run.

public sealed record ArchetypeAccess : IEquatable<ArchetypeAccess>
Inheritance
ArchetypeAccess
Implements
Inherited Members

Constructors

ArchetypeAccess(string, QueryAccessPath, string, IReadOnlyList<string>, IReadOnlyList<string>, long, int, string)

The access path one archetype took during an explained run.

public ArchetypeAccess(string Archetype, QueryAccessPath Path, string Index, IReadOnlyList<string> PushedDown, IReadOnlyList<string> EvaluatedPerEntity, long EstimatedRows, int ActualRows, string Note)

Parameters

Archetype string

The archetype's name.

Path QueryAccessPath

The path taken.

Index string

The index read, as Component.Field, or null when no tree was read.

PushedDown IReadOnlyList<string>

Predicates the index range enforced before any row was visited (the narrowing).

EvaluatedPerEntity IReadOnlyList<string>

Predicates evaluated per visited row or slot.

EstimatedRows long

The planner's estimate for its most selective predicate (not necessarily the indexed field shown), or -1 when it had no statistics (several archetypes match) or built no plan. One estimate per query, not per archetype.

ActualRows int

Rows this archetype contributed before any Where(Func) post-filter. A cluster or index scan counts the transaction's own pending destroys (they are removed from the result afterwards); a broad scan has already left them out.

Note string

Why the archetype was skipped, or another fact worth reading; null otherwise.

Properties

ActualRows

Rows this archetype contributed before any Where(Func) post-filter. A cluster or index scan counts the transaction's own pending destroys (they are removed from the result afterwards); a broad scan has already left them out.

public int ActualRows { get; init; }

Property Value

int

Archetype

The archetype's name.

public string Archetype { get; init; }

Property Value

string

EstimatedRows

The planner's estimate for its most selective predicate (not necessarily the indexed field shown), or -1 when it had no statistics (several archetypes match) or built no plan. One estimate per query, not per archetype.

public long EstimatedRows { get; init; }

Property Value

long

EvaluatedPerEntity

Predicates evaluated per visited row or slot.

public IReadOnlyList<string> EvaluatedPerEntity { get; init; }

Property Value

IReadOnlyList<string>

Index

The index read, as Component.Field, or null when no tree was read.

public string Index { get; init; }

Property Value

string

Note

Why the archetype was skipped, or another fact worth reading; null otherwise.

public string Note { get; init; }

Property Value

string

Path

The path taken.

public QueryAccessPath Path { get; init; }

Property Value

QueryAccessPath

PushedDown

Predicates the index range enforced before any row was visited (the narrowing).

public IReadOnlyList<string> PushedDown { get; init; }

Property Value

IReadOnlyList<string>

Methods

Deconstruct(out string, out QueryAccessPath, out string, out IReadOnlyList<string>, out IReadOnlyList<string>, out long, out int, out string)

public void Deconstruct(out string Archetype, out QueryAccessPath Path, out string Index, out IReadOnlyList<string> PushedDown, out IReadOnlyList<string> EvaluatedPerEntity, out long EstimatedRows, out int ActualRows, out string Note)

Parameters

Archetype string
Path QueryAccessPath
Index string
PushedDown IReadOnlyList<string>
EvaluatedPerEntity IReadOnlyList<string>
EstimatedRows long
ActualRows int
Note string

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(ArchetypeAccess?)

public bool Equals(ArchetypeAccess? other)

Parameters

other ArchetypeAccess

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(ArchetypeAccess?, ArchetypeAccess?)

public static bool operator ==(ArchetypeAccess? left, ArchetypeAccess? right)

Parameters

left ArchetypeAccess
right ArchetypeAccess

Returns

bool

operator !=(ArchetypeAccess?, ArchetypeAccess?)

public static bool operator !=(ArchetypeAccess? left, ArchetypeAccess? right)

Parameters

left ArchetypeAccess
right ArchetypeAccess

Returns

bool