Member Junction
    Preparing search index...

    Interface VirtualEntityConfig

    Configuration for a virtual entity in the additionalSchemaInfo config file. Virtual entities are backed by SQL views with no physical table.

    interface VirtualEntityConfig {
        Description?: string;
        EntityName?: string;
        ForeignKeys?: SoftFKFieldConfig[];
        PrimaryKey?: string[];
        SchemaName?: string;
        ViewName: string;
    }
    Index

    Properties

    Description? EntityName? ForeignKeys? PrimaryKey? SchemaName? ViewName

    Properties

    Description?: string

    Optional description for the entity

    EntityName?: string

    The display name for the entity. If not provided, derived from ViewName

    ForeignKeys?: SoftFKFieldConfig[]

    Optional soft foreign key definitions for the virtual entity

    PrimaryKey?: string[]

    Primary key field name(s). If not provided, defaults to 'ID'

    SchemaName?: string

    The schema containing the view

    ViewName: string

    The name of the SQL view backing this virtual entity

    Settings

    Member Visibility

    On This Page

    Properties