SQL Server · Types · Preloading the schema

ArxMsSqlPreLoad

Definition

Namespace
ARX.SDK.SQL.Services
Package
ARX.SDK.SQL
C#
public static class ArxMsSqlPreLoad

Loads an ArxPreLoadTable from a SQL Server database.

Methods

  • static Task<ArxSchemaCatalog> LoadAsync(this ArxPreLoadTable preload, string connectionString, Action<ArxSchemaCatalogBuilder>? configure = null, CancellationToken cancellationToken = default)

    Reads the requested tables from the database once (call it at startup, at service registration) and returns the schema catalog for new ArxMsSqlDbService(connectionString, catalog): each table's id, business keys, lookups and, in DataTypes, its columns' types; the tables the loaded columns reference are added with the reason (Reason). Operations never read the catalog again.

    Parameter Type Description
    preloadthis ArxPreLoadTableThe tables to read, and how much of each (ArxPreLoadMode).
    connectionStringstringThe database to read them from; used for this call only.
    configureAction<ArxSchemaCatalogBuilder>?= nullAdds what the database can't say: display names, selection sets, hand-declared tables.
    cancellationTokenCancellationToken= defaultCancels the reads.