Member Junction
    Preparing search index...

    Interface SchemaDesignEntry

    Design artefacts for a single table within a multi-table (or single-table) SchemaDesignSection. All fields except TableDefinition are optional for alter operations where the entity already has a description.

    interface SchemaDesignEntry {
        Description?: string;
        ERDMermaid?: string;
        ExistingEntityID?: string;
        ModificationType: "create" | "alter";
        Prototype?: string;
        TableDefinition: TableDefinition;
    }
    Index

    Properties

    Description? ERDMermaid? ExistingEntityID? ModificationType Prototype? TableDefinition

    Properties

    Description?: string

    One-paragraph human-readable description of what this table stores. Required for create; optional for alter.

    ERDMermaid?: string

    Per-table mermaid erDiagram showing this table's FK relationships. Injected server-side alongside SchemaDesignSection.ERDMermaid. Omitted when the table has no FK relationships.

    ExistingEntityID?: string

    Entity ID of the entity being modified. Required when ModificationType === 'alter'.

    ModificationType: "create" | "alter"

    Whether this is a new table or an ALTER to an existing one.

    Prototype?: string

    Human-readable markdown prototype table shown to the user for approval. Format: | Column | SQL Type | Required | Default | Description |

    TableDefinition: TableDefinition

    Fully typed input to SchemaEngine.GenerateMigration(). Required.

    Settings

    Member Visibility

    On This Page

    Properties