Table of Contents

Class ScriptVpa

Inheritance
ScriptVpa
Inherited Members
Namespace
TabularEditor.Shared.Scripting
Assembly
TabularEditor3.Shared.dll

Script-accessible VPA (VertiPaq Analyzer) read helper. Exposed as ScriptHost.Vpa. Provides read access to previously collected VPA statistics. Call CollectVertiPaqAnalyzerStats() first to populate the data.

public class ScriptVpa
Extension Methods

Remarks

The data-source delegates are wired by the host (CLI or TE3 UI) during startup. In environments where no provider has been wired, properties return empty results.

Constructors

ScriptVpa()

public ScriptVpa()

Properties

Columns

Per-column statistics. Empty list if stats not yet collected.

public List<ColumnStats> Columns { get; }

Property Value

Type Description
List<ColumnStats>

ColumnsDelegate

Delegate that returns per-column VPA statistics.

public static Func<List<ColumnStats>> ColumnsDelegate { get; set; }

Property Value

Type Description
Func<List<ColumnStats>>

IsCollected

Whether VPA statistics have been collected for the current model.

public bool IsCollected { get; }

Property Value

Type Description
bool

IsCollectedDelegate

Lightweight delegate that checks if VPA stats have been collected.

public static Func<bool> IsCollectedDelegate { get; set; }

Property Value

Type Description
Func<bool>

Partitions

Per-partition statistics. Empty list if stats not yet collected.

public List<PartitionStats> Partitions { get; }

Property Value

Type Description
List<PartitionStats>

PartitionsDelegate

Delegate that returns per-partition VPA statistics.

public static Func<List<PartitionStats>> PartitionsDelegate { get; set; }

Property Value

Type Description
Func<List<PartitionStats>>

Relationships

Relationship statistics. Empty list if stats not yet collected.

public List<RelationshipStats> Relationships { get; }

Property Value

Type Description
List<RelationshipStats>

RelationshipsDelegate

Delegate that returns relationship VPA statistics.

public static Func<List<RelationshipStats>> RelationshipsDelegate { get; set; }

Property Value

Type Description
Func<List<RelationshipStats>>

Summary

Model-level VPA summary (size, counts, dates). Null if stats not yet collected.

public VertipaqSummary Summary { get; }

Property Value

Type Description
VertipaqSummary

SummaryDelegate

Delegate that returns the VPA summary. Returns null if not collected.

public static Func<VertipaqSummary> SummaryDelegate { get; set; }

Property Value

Type Description
Func<VertipaqSummary>

Tables

Per-table statistics. Empty list if stats not yet collected.

public List<TableStats> Tables { get; }

Property Value

Type Description
List<TableStats>

TablesDelegate

Delegate that returns per-table VPA statistics.

public static Func<List<TableStats>> TablesDelegate { get; set; }

Property Value

Type Description
Func<List<TableStats>>