Member Junction
    Preparing search index...

    Class DBAutoDocAPI

    DBAutoDocAPI - Main API class

    Simple, type-safe interface for DBAutoDoc functionality:

    • analyze() - Run full analysis or resume from checkpoint
    • export() - Generate SQL and/or Markdown from analysis state
    • getStatus() - Check analysis progress and metrics
    Index

    Constructors

    constructor

    Methods

    analyze export getStatus resume

    Constructors

    Methods

    • Run database analysis

      Performs full or resumed database analysis, saving results to the output folder.

      Parameters

      Returns Promise<AnalysisExecutionResult>

      Analysis result with output folder path and metrics

      const result = await api.analyze({
        database: { provider: 'sqlserver', server: 'localhost', ... },
        ai: { provider: 'anthropic', model: 'claude-3-opus-20240229', ... },
        onProgress: (msg, data) => console.log(msg, data)
      });

      if (result.success) {
        console.log(`Analysis saved to: ${result.outputFolder}`);
        console.log(`Tokens used: ${result.summary.totalTokens}`);
      }

    • Export analysis results as SQL and/or Markdown

      Generates SQL extended properties script and/or Markdown documentation from an existing analysis state file.

      Parameters

      • stateFile: string

        Path to the state.json file to export from

      • Optionaloptions: {
            approvedOnly?: boolean;
            confidenceThreshold?: number;
            markdown?: boolean;
            outputDir?: string;
            sql?: boolean;
        }

        Export options

        • OptionalapprovedOnly?: boolean

          Only include approved items (default: false)

        • OptionalconfidenceThreshold?: number

          Minimum confidence threshold for inclusion (0-1, default: 0)

        • Optionalmarkdown?: boolean

          Generate Markdown documentation (default: true)

        • OptionaloutputDir?: string

          Output directory for generated files (default: same as state file directory)

        • Optionalsql?: boolean

          Generate SQL extended properties script (default: true)

      Returns Promise<ExportResult>

      Export result with paths to generated files

      // Generate both SQL and Markdown
      const result = await api.export('./output/run-5/state.json', {
        sql: true,
        markdown: true,
        outputDir: './docs'
      });

      if (result.success) {
        console.log(`SQL: ${result.sqlFile}`);
        console.log(`Markdown: ${result.markdownFile}`);
      }

    • Get analysis status and metrics

      Returns current analysis status and metrics from a state file. Useful for tracking progress or checking if analysis is complete.

      Parameters

      • stateFile: string

        Path to the state.json file

      Returns Promise<AnalysisStatus>

      Status information

      const status = await api.getStatus('./output/run-5/state.json');

      if (status.exists) {
        console.log(`Schemas: ${status.totalSchemas}`);
        console.log(`Tables: ${status.totalTables}`);
        console.log(`Tokens: ${status.totalTokens}`);
        console.log(`Cost: $${status.estimatedCost?.toFixed(2)}`);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods