MigsLab SDKARX.SDK documentation
Ctrl K

MySQL · Types · Preloading the schema

ArxPreLoadTable

Definition

Namespace
ARX.SDK.Services
Package
ARX.SDK
C#
public sealed class ArxPreLoadTable

A preload into a schema catalog at service setup: the registered tables, and what to read of them. Tables their loaded columns reference are added, with the reason. The provider loads it (for example await preload.LoadAsync(connectionString)).

Constructor

  • ArxPreLoadTable(ArxPreLoadTableRegister tables, ArxPreLoadMode mode = ArxPreLoadMode.DataTypes)

    A preload of the registered tables. Nothing is read until the provider's LoadAsync runs.

    Parameter Type Description
    tablesArxPreLoadTableRegisterThe tables to read, each with its columns (none for every column). The preload keeps a copy.
    modeArxPreLoadMode= ArxPreLoadMode.DataTypesDataTypes (the default) reads the keys and every loaded column's type; KeysOnly reads the id, business keys and lookups only.

Properties

  • IReadOnlyDictionary<string, IReadOnlyList<string>> Tables { get; }

    Each requested table and its columns (empty: all of them).

  • ArxPreLoadMode Mode { get; }

    What the preload reads: DataTypes or KeysOnly.

  • int ReferenceDepth { get; init; }

    How many references deep referenced tables are added (3 by default; 0 adds none).

Usage

C#

A line from a verified sample; the full, runnable code is on its page.

var preload = new ArxPreLoadTable(tables);

Preload the schema at service setup: keys only, data types, Strict, scenario 1

Used in: