Member Junction
    Preparing search index...

    Interface DBAutoDocAPIConfig

    API Configuration subset Only includes the essential configuration options for programmatic use

    interface DBAutoDocAPIConfig {
        ai: AIConfig;
        analysis?: Partial<AnalysisConfig>;
        database: DatabaseConfig;
        outputDir?: string;
        schemas?: { exclude?: string[]; include?: string[] };
        seedContext?: {
            businessDomains?: string[];
            customInstructions?: string;
            industryContext?: string;
            keyPassMaxChars?: number;
            overallPurpose?: string;
        };
        tables?: { exclude?: string[] };
    }
    Index

    Properties

    ai analysis? database outputDir? schemas? seedContext? tables?

    Properties

    ai: AIConfig

    AI provider configuration

    analysis?: Partial<AnalysisConfig>

    Optional analysis configuration (uses sensible defaults if not provided)

    database: DatabaseConfig

    Database connection configuration

    outputDir?: string

    Optional output directory (default: ./output)

    schemas?: { exclude?: string[]; include?: string[] }

    Schema filtering

    seedContext?: {
        businessDomains?: string[];
        customInstructions?: string;
        industryContext?: string;
        keyPassMaxChars?: number;
        overallPurpose?: string;
    }

    Optional seed context for better analysis results

    Type Declaration

    • OptionalbusinessDomains?: string[]
    • OptionalcustomInstructions?: string
    • OptionalindustryContext?: string
    • OptionalkeyPassMaxChars?: number

      Cap on the customInstructions text sent to each PK/FK inference prompt. Default 6000; 0 sends none.

    • OptionaloverallPurpose?: string
    tables?: { exclude?: string[] }

    Table filtering

    Settings

    Member Visibility

    On This Page

    Properties