MigsLab SDKARX.SDK documentation
Ctrl K

SQL Server · Types · Other public types

ArxServerCheck

Definition

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

What the connected server allows, from CheckServerAsync(): the server's version, the provider's capabilities on this server, and for each one the server removes, why. service.Capabilities says what the provider can do anywhere; this says what it can do here. Call it once at startup, beside ValidateSchemaAsync.

Constructor

  • ArxServerCheck(IArxProviderCapabilities provider, string serverVersion, IEnumerable<ArxServerLimit>? limits = null, IEnumerable<string>? problems = null)

    A check: the provider's capabilities, less those the server removes.

    Parameter Type Description
    providerIArxProviderCapabilitiesThe provider's capabilities.
    serverVersionstringThe server's version, as it reports it.
    limitsIEnumerable<ArxServerLimit>?= nullThe capabilities the server removes, with the reason.
    problemsIEnumerable<string>?= nullAnything else the check found wrong (a table of the model that doesn't exist); empty when none.

Properties

  • string ProviderName { get; }

    The provider's name, as messages show it.

  • string ServerVersion { get; }

    The server's version, as it reports it ("16.4", "8.4.3", "7.0.12", …).

  • ArxCapability Supported { get; }

    The provider's capabilities on this server.

  • IReadOnlyList<ArxServerLimit> Limits { get; }

    The capabilities the provider has that this server doesn't allow, each with the reason.

  • IReadOnlyList<string> Problems { get; }

    Anything else the check found wrong; empty when the server is ready.

  • bool IsReady { get; }

    True when the check found nothing wrong (limits are allowed: they only remove capabilities).

Methods

  • bool Supports(ArxCapability capability)

    True when every flag in capability works on this server.

    Parameter Type Description
    capabilityArxCapabilityOne capability, or several combined with |: all must be supported.

Usage

C#

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

ArxServerCheck check = await data.CheckServerAsync();

Set the service up for production, scenario 2

Used in: