AutoBE
    Preparing search index...

    Interface AutoBeDatabaseComponentTableDesign

    Table design with name and description.

    Represents a single table identified during the component extraction phase, pairing the table name with a description of its purpose. This type formalizes the table design structure for database schema generation.

    The description provides business context that helps:

    • Review agents validate that the table fulfills actual requirements
    • Schema generation create appropriate models with proper documentation
    • Future developers understand the table's role in the system

    Michael

    interface AutoBeDatabaseComponentTableDesign {
        description: string;
        name: string & SnakeCasePattern;
    }
    Index

    Properties

    description name

    Properties

    description: string

    Brief, concise description of what this table stores and why it's needed.

    Should explain:

    • What business concept this table represents
    • What data it stores
    • Why this table is necessary for the component's domain

    IMPORTANT:

    • Keep it concise - one or two sentences maximum
    • Description must be written in English
    "Stores customer profile information including authentication
      credentials, contact details, and preferences for the shopping platform."
    name: string & SnakeCasePattern

    Name of the database table.

    Must follow snake_case naming convention with appropriate domain prefix. Examples: shopping_customers, bbs_articles, order_items

    Settings

    Member Visibility

    On This Page

    Properties