Member Junction
    Preparing search index...

    Interface SubagentTableSpec

    Minimum entity specification passed by a calling agent in subagent mode. Schema Designer uses this as the starting point when FunctionalRequirements is not available.

    interface SubagentTableSpec {
        columns?: {
            description?: string;
            foreignKeyTarget?: string;
            name: string;
            required?: boolean;
            type: string;
        }[];
        description: string;
        existingEntityId?: string;
        modificationType?: "create"
        | "alter";
        name: string;
        schemaName?: string;
    }
    Index

    Properties

    columns? description existingEntityId? modificationType? name schemaName?

    Properties

    columns?: {
        description?: string;
        foreignKeyTarget?: string;
        name: string;
        required?: boolean;
        type: string;
    }[]

    Column hints from the calling agent.

    • For 'create': the full proposed column list (Schema Designer refines these).
    • For 'alter': ONLY the new columns to add — do not include existing columns. Omit entirely to let Schema Designer infer columns from name + description.

    Type Declaration

    • Optionaldescription?: string
    • OptionalforeignKeyTarget?: string

      e.g. "__mj.User.ID" — Schema Designer resolves to a proper FK definition.

    • name: string
    • Optionalrequired?: boolean
    • type: string
    description: string

    One-paragraph description of what each row represents (create) or what changes are being made (alter).

    existingEntityId?: string

    UUID of the entity to modify. Required when modificationType === 'alter'. Must be obtained from Database Research Agent before invoking Database Designer.

    modificationType?: "create" | "alter"

    Operation type. Defaults to 'create' when omitted.

    • 'create': design and create a brand-new entity
    • 'alter': add columns to an existing entity (requires existingEntityId)
    name: string

    Proposed entity display name — human-readable, title-cased with spaces (e.g. "Customer Orders").

    schemaName?: string

    Target SQL schema. Defaults to the UDT sandbox schema when omitted. Will be validated by the Schema Validator — blocked schemas are rejected.

    Settings

    Member Visibility

    On This Page

    Properties