Skip to content

PgExplainWriter

Namespace: Ankus

Assembly: Ankus.Runtime.dll

Adds properties to an EXPLAIN plan node, in every EXPLAIN format.

public readonly ref struct PgExplainWriter

The writer is valid only during the call that receives it. Text output shows each property as Label: value under the node; JSON, XML and YAML output use the label as the property name.

Adds a Boolean property.

public void Add(string label, bool value)

Parameters:

label — string

The property label.

value — bool

The value.

Adds a floating-point property.

public void Add(string label, double value, int digits, string? unit = null)

Parameters:

label — string

The property label.

value — double

The value.

digits — int

The digits shown after the decimal point, from 0 to 15.

unit — string

An optional unit shown after the value in text output.

Adds an integer property.

public void Add(string label, long value, string? unit = null)

Parameters:

label — string

The property label.

value — long

The value.

unit — string

An optional unit, such as kB, shown after the value in text output.

Adds a text property.

public void Add(string label, string value)

Parameters:

label — string

The property label.

value — string

The value.