Member Junction
    Preparing search index...

    Class QueryRefreshDialogComponent

    <mj-query-refresh-dialog> — refreshes saved queries' metadata (fields, parameters, entities, dependencies) from their SQL and the database server, through the Query.RefreshExtraction remote operation.

    Opening it always starts with a dry run: the operation reports what would change and writes nothing, live progress shows as each query is checked, and the report is shown for review. The user then applies it, which runs the refresh for real and shows what was written. When AllowSkipDryRun is set, the review offers a user setting, "skip the dry run for future query refreshes"; with it on, a later opening applies straight away.

    Composite (L2): it calls the operation on ProviderToUse and reads and writes the user setting, but never navigates: a query the user asks to open is emitted as OpenQuery.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AllowOpenQuery AllowSkipDryRun Applied Closed ErrorMessage OpenQuery Phase Processed ProgressMessage Provider Report Scope ScopeLabel SkipDryRun Title Total ɵdir ɵfac

    Accessors

    CanApply IsRunning Percent ProviderToUse RunQueryToUse RunViewToUse Visible

    Methods

    Apply Close OnSkipDryRunChange OnSkipDryRunToggled RunDryRunAgain Start

    Constructors

    Properties

    AllowOpenQuery: boolean = false

    Whether query names in the report are buttons that emit OpenQuery.

    AllowSkipDryRun: boolean = false

    Whether the user may turn on "skip the dry run for future query refreshes".

    Applied: EventEmitter<QueryRefreshExtractionOutput> = ...

    A refresh was applied; carries its report.

    Closed: EventEmitter<void> = ...

    The dialog was closed.

    ErrorMessage: string | null = null
    OpenQuery: EventEmitter<string> = ...

    The ID of a query the user asked to open from the report.

    Phase: QueryRefreshPhase = 'Idle'
    Processed: number = 0
    ProgressMessage: string = ''
    Provider: IMetadataProvider | null

    If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

    Report: QueryRefreshExtractionOutput | null = null
    Scope: QueryRefreshScope | null = null

    Which queries to refresh.

    ScopeLabel: string = ''

    Names the scope in the dialog, e.g. Query "Sales by Region" or Category "Reports".

    SkipDryRun: boolean = false
    Title: string = 'Refresh query metadata'
    Total: number | undefined = undefined
    "ɵdir": unknown
    "ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

    Accessors

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods