Interface DatabaseDocumentation

interface DatabaseDocumentation {
    database: DatabaseInfo;
    organicKeyClusters?: OrganicKeyCluster[];
    phases: AnalysisPhases;
    resumedFromFile?: string;
    sampleQueries?: SampleQueriesDeliverable;
    schemas: SchemaDefinition[];
    seedContext?: SeedContext;
    summary: AnalysisSummary;
    version: string;
}

Index

Properties

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

Properties

database

database: DatabaseInfo

`Optional`organicKeyClusters

organicKeyClusters?: OrganicKeyCluster[]

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

phases

phases: AnalysisPhases

`Optional`resumedFromFile

resumedFromFile?: string

`Optional`sampleQueries

sampleQueries?: SampleQueriesDeliverable

schemas

schemas: SchemaDefinition[]

`Optional`seedContext

seedContext?: SeedContext

summary

summary: AnalysisSummary

version

version: string