Member Junction
    Preparing search index...

    Class ExploreDatabaseSchemaAction

    Action that retrieves comprehensive database schema information using MemberJunction's rich metadata layer instead of raw INFORMATION_SCHEMA queries.

    This action provides research agents with deep understanding of the data model including:

    • Business context (descriptions, display names)
    • Field metadata (types, defaults, value lists, related entities)
    • Semantic relationships (not just foreign keys)
    • Virtual entities (logical, not physical)
    • API permissions and settings
    • Audit configuration
    • UI display preferences

    Features:

    • Entity name pattern filtering with wildcards
    • Schema filtering (focus on specific schemas)
    • Optional field details with rich metadata
    • Optional relationship information with semantic meaning
    • Optional permission information
    • Virtual entity support
    • Scope-based filtering
    • Configurable output size limits
    // Get all customer-related entities with full metadata
    await runAction({
      ActionName: 'Explore Database Schema',
      Params: [{
        Name: 'EntityPattern',
        Value: '%Customer%'
      }, {
        Name: 'IncludeFields',
        Value: true
      }, {
        Name: 'IncludeRelationships',
        Value: true
      }]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Methods

    InternalRunAction Run

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods