Member Junction
    Preparing search index...

    Interface SchemaNameValidation

    Result of ValidateSchemaName. Carries which rule refused the name, and whether a caller option would have permitted it, so a caller can name a remedy instead of just quoting ErrorMessage back at the operator.

    interface SchemaNameValidation {
        ErrorMessage?: string;
        OverriddenBy?: "AllowDoubleUnderscoreSchema";
        Rule?: SchemaNameRule;
        Success: boolean;
        Warning?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ErrorMessage? OverriddenBy? Rule? Success Warning?

    Properties

    ErrorMessage?: string

    Error message if the operation failed

    OverriddenBy?: "AllowDoubleUnderscoreSchema"

    The caller option that would have permitted this name, when one exists — it is offered by the install, upgrade AND remove options alike. Absent means nothing unblocks it. Callers branch on OverriddenBy first, then on Rule for the classes OverriddenBy cannot distinguish (see BuildSchemaDropRefusalMessage in install-orchestrator.ts).

    Rule?: SchemaNameRule

    Which rule refused the name. Absent when Success.

    Success: boolean

    Whether the operation succeeded

    Warning?: string

    Non-fatal: the operation succeeded but not in the intended shape (e.g. the schema was created without the intended owner). Callers must surface it to the operator.

    Settings

    Member Visibility

    On This Page

    Properties