Member Junction
    Preparing search index...

    Interface DatabaseDocumentation

    interface DatabaseDocumentation {
        database: DatabaseInfo;
        organicKeyClusters?: OrganicKeyCluster[];
        phases: AnalysisPhases;
        plugins?: Record<string, AutoDocPluginStateSection>;
        resumedFromFile?: string;
        sampleQueries?: SampleQueriesDeliverable;
        schemas: SchemaDefinition[];
        seedContext?: SeedContext;
        summary: AnalysisSummary;
        version: string;
    }
    Index

    Properties

    database organicKeyClusters? phases plugins? resumedFromFile? sampleQueries? schemas seedContext? summary version

    Properties

    database: DatabaseInfo
    organicKeyClusters?: OrganicKeyCluster[]

    Deliverable: organic-key clusters detected by the optional organic-key detection phase. Empty/absent when that phase didn't run.

    phases: AnalysisPhases
    plugins?: Record<string, AutoDocPluginStateSection>

    Per-plugin sections, keyed by plugin registration name. Each holds the plugin's hook-run history and whatever data the plugin chose to persist. Absent in state files from runs that loaded no plugins.

    resumedFromFile?: string
    sampleQueries?: SampleQueriesDeliverable
    schemas: SchemaDefinition[]
    seedContext?: SeedContext
    summary: AnalysisSummary
    version: string

    Settings

    Member Visibility

    On This Page

    Properties