AutoBE
    Preparing search index...

    Interface representing a regular data field that stores business information.

    These fields contain the actual business data like names, amounts, timestamps, flags, descriptions, and other domain-specific information.

    interface IPlainField {
        description: string;
        name: string & SnakePattern;
        nullable: boolean;
        type: "string" | "boolean" | "uuid" | "uri" | "int" | "double" | "datetime";
    }
    Index

    Properties

    description: string

    Description explaining the business purpose and usage of this field.

    Should clearly explain:

    • What business concept this field represents
    • Valid values or constraints if applicable
    • How it relates to business processes
    • Any special behavioral notes

    IMPORTANT: Description must be written in English. Example: "Amount of cash payment." or "Whether the unit is required or not."

    name: string & SnakePattern

    Name of the field in the database table.

    MUST use snake_case naming convention. Common patterns from uploaded schemas:

    • Timestamps: created_at, updated_at, deleted_at, opened_at, closed_at
    • Identifiers: code, name, nickname, title
    • Business data: value, quantity, price, volume, balance
    • Flags: primary, required, exclusive, secret, multiplicative
    nullable: boolean

    Whether this field can contain null values.

    True: Field is optional and can be null (e.g., middle name, description) false: Field is required and cannot be null (e.g., creation timestamp, name) Reflects business rules about mandatory vs optional data.

    type: "string" | "boolean" | "uuid" | "uri" | "int" | "double" | "datetime"

    Data type of the field for Prisma schema generation.

    Maps to appropriate Prisma/PostgreSQL types:

    • Boolean: Boolean flags and yes/no values
    • Int: Integer numbers, quantities, sequences
    • Double: Decimal numbers, prices, monetary values, percentages
    • String: Text data, names, descriptions, codes
    • Uri: URL/URI fields for links and references
    • Uuid: UUID fields (for non-foreign-key UUIDs)
    • Datetime: Timestamp fields with date and time