Member Junction
    Preparing search index...

    Class SqlLoggingComponent

    Angular component for managing SQL logging sessions in MemberJunction.

    This component provides a user interface for:

    • Viewing SQL logging configuration and status
    • Starting and stopping SQL logging sessions
    • Managing session options (filtering, formatting, etc.)
    • Real-time monitoring of active sessions

    Security: Only users with 'Owner' type can access SQL logging features.

    <mj-sql-logging></mj-sql-logging>

    Owner-level user privileges

    SQL logging enabled in server configuration

    Hierarchy (View Summary)

    Implements

    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    _config activeSessions autoRefresh configEnabled destroy$ error Error filterTypeOptions Interaction isLogViewerExpanded isOwner isStartDialogFullscreen isStoppingAll loading logContent navigationService newSessionOptions OpenEntityRecord ParentTabId Provider refreshInterval selectedSession sessionToStop showStartSessionDialog showStats showStopConfirmDialog sqlLoggingConfig statementTypeOptions UserStateChanged ɵdir ɵfac

    Accessors

    Config Data DisplayNameChangedEvent LoadComplete LoadCompleteEvent LoadStarted LoadStartedEvent ProviderToUse ResourceCloseRequestedEvent ResourceRecordSavedEvent RunQueryToUse RunViewToUse

    Methods

    cancelStopConfirm confirmStopSession debugUserEmail getFileName GetQueryParams GetResourceDisplayName GetResourceIconClass getSessionDuration getTabId getTotalStatementCount initDashboard IsEditing loadData loadSessionLog ngOnDestroy ngOnInit NotifyCloseRequested NotifyDisplayNameChanged NotifyLoadComplete NotifyLoadStarted onEscapeKey OnQueryParamsChanged onTabIdRebound openStartSessionDialog openStopAllSessionsConfirm openStopSessionConfirm RebindTabId Refresh refreshUserPermissions RefreshView rehomeChildToTab ResourceRecordSaved selectSession SetVisible startNewSession toggleLogViewerExpand toggleStartDialogFullscreen UpdateQueryParams

    Constructors

    Properties

    Protected_config

    _config: DashboardConfig | null
    activeSessions: SqlLoggingSession[] = []

    List of currently active SQL logging sessions

    autoRefresh: boolean = false

    Whether to automatically refresh session data

    configEnabled: boolean = false

    Whether SQL logging is enabled in the server configuration

    destroy$: Subject<void> = ...
    error: string | null = null

    Current error message to display to the user, if any

    Error: EventEmitter<Error>

    Subclasses can emit anytime an error occurs.

    filterTypeOptions: { text: string; value: string }[] = ...

    Options for Regex filter

    Interaction: EventEmitter<any>

    Subclasses can emit this event anytime they want to communicate with the container to let it know that something has happened of significance.

    isLogViewerExpanded: boolean = false

    Whether the log viewer is in expanded (fullscreen) mode

    isOwner: boolean = false

    Whether the current user has Owner privileges to access SQL logging

    isStartDialogFullscreen: boolean = false

    Whether the start session dialog is in fullscreen mode

    isStoppingAll: boolean = false

    Whether stopping all sessions (vs single session)

    loading: boolean = false

    Whether the component is currently performing an async operation

    logContent: string = ''

    Content of the currently viewed log file

    navigationService: NavigationService
    newSessionOptions: {
        defaultSchemaName: string;
        fileName: string;
        filterPatterns: string;
        filterToCurrentUser: boolean;
        filterType: "exclude" | "include";
        formatAsMigration: boolean;
        prettyPrint: boolean;
        sessionName: string;
        statementTypes: "both" | "queries" | "mutations";
        verboseOutput: boolean;
    } = ...

    Options for creating a new SQL logging session

    Type Declaration

    • defaultSchemaName: string
    • fileName: string

      Custom filename for the log file

    • filterPatterns: string

      Regex filter options

    • filterToCurrentUser: boolean

      Whether to filter SQL statements to current user only

    • filterType: "exclude" | "include"
    • formatAsMigration: boolean

      Whether to format output as migration file

    • prettyPrint: boolean

      Whether to format SQL with proper indentation

    • sessionName: string

      Human-readable name for the session

    • statementTypes: "both" | "queries" | "mutations"

      Types of SQL statements to capture

    • verboseOutput: boolean
    OpenEntityRecord: EventEmitter<{ EntityName: string; RecordPKey: CompositeKey }>

    Subclasses can emit this event anytime they want to open a record within a particular entity. The container should handle this event and open the record.

    ParentTabId: string | null

    Tab ID for query param notification scoping. Set by resource wrappers that render child dashboards, so the child knows which tab it belongs to. If not set, falls back to Data.Configuration.tabId.

    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.

    refreshInterval: number = 5000

    Interval in milliseconds for auto-refresh functionality

    selectedSession: SqlLoggingSession | null = null

    Currently selected session for viewing logs

    sessionToStop: SqlLoggingSession | null = null

    Session pending stop confirmation (single session or null for all)

    showStartSessionDialog: boolean = false

    Whether the start session dialog is currently visible

    showStats: boolean = false

    Whether to show the statistics cards section

    showStopConfirmDialog: boolean = false

    Whether the stop session confirmation dialog is visible

    sqlLoggingConfig: SqlLoggingConfig | null = null

    Current SQL logging configuration from the server

    statementTypeOptions: { text: string; value: string }[] = ...

    Available options for SQL statement type filtering

    UserStateChanged: EventEmitter<any>

    Subclasses should emit this event anytime their internal state changes in a way that they'd like to persist.

    "ɵdir": unknown
    "ɵfac": ɵɵFactoryDeclaration<BaseDashboard, never>

    Accessors

    • get Config(): DashboardConfig | null

      Returns DashboardConfig | null

    • set Config(value: DashboardConfig): void

      Set or change the dashboard configuration. Changing this property will NOT cause the dashboard to reload. Call Refresh() to do that.

      Parameters

      Returns void

    • get Data(): ResourceData

      Returns ResourceData

    • set Data(value: ResourceData): void

      Parameters

      Returns void

    • get DisplayNameChangedEvent(): ((newName: string) => void) | null

      Returns ((newName: string) => void) | null

    • set DisplayNameChangedEvent(value: ((newName: string) => void) | null): void

      Parameters

      • value: ((newName: string) => void) | null

      Returns void

    • get LoadComplete(): boolean

      Returns boolean

    • get LoadCompleteEvent(): any

      Returns any

    • set LoadCompleteEvent(value: any): void

      Parameters

      • value: any

      Returns void

    • get LoadStarted(): boolean

      Returns boolean

    • get LoadStartedEvent(): any

      Returns any

    • set LoadStartedEvent(value: any): void

      Parameters

      • value: any

      Returns void

    • get ProviderToUse(): IMetadataProvider

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

      Returns IMetadataProvider

    • get ResourceCloseRequestedEvent(): (() => void) | null

      Returns (() => void) | null

    • set ResourceCloseRequestedEvent(value: (() => void) | null): void

      Parameters

      • value: (() => void) | null

      Returns void

    • get ResourceRecordSavedEvent(): any

      Returns any

    • set ResourceRecordSavedEvent(value: any): void

      Parameters

      • value: any

      Returns void

    • 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

    • Read current query params from tab configuration. Use in initDashboard() / ngOnInit() to get initial URL state.

      Returns Record<string, string>

    • Get this component's tab ID. Checks ParentTabId input first (set by resource wrappers for child dashboards), then falls back to Data.Configuration.tabId.

      Returns string

    • True when this resource holds in-progress user edits that a silent replacement would destroy. Consulted by the shell before consuming a temporary record tab under the preview-tab model (see TabRequest.TempScope): an editing tab is never replaced — the next open lands in its own tab instead, so the edit survives.

      Default false: most resources are read-only surfaces with nothing to lose. Resources that host an editable form override it.

      Returns boolean

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns Promise<void>

    • Ask the host shell to close/dismiss this resource (typically: close the tab). Called by subclasses that hosted a form that emitted a 'dismiss' navigation event — most often, a brand-new record where the user clicked Discard. The record was never saved, the form is empty, and leaving it open serves no purpose. The tab-container listens for this and closes the workspace tab.

      Returns void

    • Call this to notify the tab system that the resource's display name has changed. The tab container will update the tab title and browser title accordingly.

      Parameters

      • newName: string

      Returns void

    • Returns void

    • Called by the framework when query params change from an external source (browser back/forward, deep link navigation). Override in subclasses to react to query param changes.

      Parameters

      • params: Record<string, string>

        The new query params from the URL

      • source: "popstate" | "deeplink"

        'popstate' for back/forward, 'deeplink' for external URL entry

      Returns void

    • Hook for a host that instantiates CHILD resource components: re-home them here.

      A host stamps its children with its tab id when it creates them, which is a SNAPSHOT. A cache reattach moves the host to a different tab without recreating anything, so a child left holding the birth tab's id would go on reading and — worse — writing that tab's params from inside a tab it no longer belongs to. That is the same cross-tab corruption this class refuses elsewhere, just arriving by a slower route, so the stamp has to move when the host does.

      Default is a no-op: a component with no children has nothing to re-home.

      Parameters

      • _tabId: string

      Returns void

    • Re-home this component to a different tab (cache reattach across tab ids). Replaces the reactive param subscription with one bound to the new tab and resets the duplicate-delivery key so the new tab's CURRENT params apply as a fresh mount would — the replay-on-subscribe delivers them immediately.

      Parameters

      • tabId: string

      Returns void

    • This method will result in the dashboard being reloaded.

      NOTE — this promise does NOT reject when the reload fails. A load error is caught, logged via LogError and surfaced on the Error output (see runGuardedLoad), and the promise then RESOLVES. That is deliberate: callers invoke Refresh() fire-and-forget (the container does), so rejecting here would produce an unhandled rejection rather than reaching anyone. If you need to know whether a refresh succeeded, subscribe to Error — do not rely on await Refresh() throwing.

      Returns Promise<void>

    • Marks this component's view (and its ancestors) as needing change detection and schedules a tick — the reliable way for a resource component to re-render after updating state from async work (RunView/RunQuery continuations, timers, websocket pushes, RxJS subscriptions).

      WHY THIS EXISTS: the Explorer shell hosts resource components dynamically — createComponent()

      • ApplicationRef.attachView() — because tab content mounts into Golden Layout / cached DOM containers, not into an Angular template. Since Angular 18's change-detection scheduler rework (Explorer is on Angular 21), ApplicationRef.tick() only refreshes attached views that are FLAGGED dirty; a root-level attached view whose component mutates plain fields from an async continuation is never flagged, so the view silently never re-renders — even though the component uses default (non-OnPush) change detection (issue #3106).

      The framework calls this automatically from NotifyLoadStarted() / NotifyLoadComplete(), so the standard load lifecycle re-renders without any subclass action. Call it yourself after any LATER async state change that must reach the DOM outside those signals.

      Returns void

    • Re-homes a child this component created to tabId.

      The ParentTabId stamp is cleared FIRST and deliberately: getTabId() prefers it over the rebound id, so leaving the old stamp in place would make the child's own RebindTabId a no-op — it early-returns when getTabId() already matches — and the child would keep answering with the tab it was born in. Clearing it lets the rebind be the authority, and the child re-delivers the NEW tab's current params exactly as a fresh mount would.

      Parameters

      Returns void

    • This method can be used by a container to let the dashboard know that it is being opened/closed. Base class just sets a flag.

      Parameters

      • visible: boolean

      Returns void

    • Push query param changes to the URL. Creates a browser history entry. Safe to call during OnQueryParamsChanged — auto-suppressed to prevent loops.

      The write is ALWAYS scoped to this component's own tab. A component that cannot identify its tab does not write at all — see the guard below.

      Parameters

      • params: Record<string, string | null>

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods