Class StateManager

Exports for state module

Index

Constructors

Methods

createAnalysisRun createInitialState delete findTable getLowConfidenceTables getUnapprovedTables getUnprocessedTables load save updateColumnDescription updateSchemaDescription updateSummary updateTableDescription

Constructors

constructor

new StateManager(stateFilePath: string): StateManager
Parameters
- stateFilePath: string
Returns StateManager
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:18

Methods

createAnalysisRun

createAnalysisRun(
    state: DatabaseDocumentation,
    modelUsed: string,
    vendor: string,
    temperature: number,
    topP?: number,
    topK?: number,
): AnalysisRun
Start a new analysis run
Parameters
- state: DatabaseDocumentation
- modelUsed: string
- vendor: string
- temperature: number
- OptionaltopP: number
- OptionaltopK: number
Returns AnalysisRun
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:136

createInitialState

createInitialState(
databaseName: string,
serverName: string,
): DatabaseDocumentation
Create initial empty state
Parameters
- databaseName: string
- serverName: string
Returns DatabaseDocumentation
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:101

delete

delete(): Promise<void>
Delete state file

Returns Promise<void>
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:408

findTable

findTable(
    state: DatabaseDocumentation,
    schemaName: string,
    tableName: string,
): TableDefinition
Find a table in the state
Parameters
- state: DatabaseDocumentation
- schemaName: string
- tableName: string
Returns TableDefinition
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:241

getLowConfidenceTables

getLowConfidenceTables(
    state: DatabaseDocumentation,
    threshold: number,
): {
    confidence: number;
    description: string;
    reasoning: string;
    schema: string;
    table: string;
}[]
Get low-confidence tables
Parameters
- state: DatabaseDocumentation
- threshold: number
Returns {
    confidence: number;
    description: string;
    reasoning: string;
    schema: string;
    table: string;
}[]
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:274

getUnapprovedTables

getUnapprovedTables(state: DatabaseDocumentation): TableDefinition[]
Get all unapproved tables
Parameters
- state: DatabaseDocumentation
Returns TableDefinition[]
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:257

getUnprocessedTables

getUnprocessedTables(
state: DatabaseDocumentation,
): { schema: string; table: string }[]
Get tables that need processing (no descriptions yet)
Parameters
- state: DatabaseDocumentation
Returns { schema: string; table: string }[]
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:321

load

load(): Promise<DatabaseDocumentation>
Load state from file

Returns Promise<DatabaseDocumentation>
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:23

save

save(state: DatabaseDocumentation): Promise<void>
Save state to file
Parameters
- state: DatabaseDocumentation
Returns Promise<void>
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:81

updateColumnDescription

updateColumnDescription(
    column: ColumnDefinition,
    description: string,
    reasoning: string,
    modelUsed: string,
): void
Update column description with new iteration
Parameters
- column: ColumnDefinition
- description: string
- reasoning: string
- modelUsed: string
Returns void
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:200

updateSchemaDescription

updateSchemaDescription(
    schema: SchemaDefinition,
    description: string,
    reasoning: string,
    modelUsed: string,
): void
Update schema description
Parameters
- schema: SchemaDefinition
- description: string
- reasoning: string
- modelUsed: string
Returns void
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:220

updateSummary

updateSummary(state: DatabaseDocumentation): void
Update summary statistics from current state and analysis runs
Parameters
- state: DatabaseDocumentation
Returns void
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:360

updateTableDescription

updateTableDescription(
    table: TableDefinition,
    description: string,
    reasoning: string,
    confidence: number,
    modelUsed: string,
    triggeredBy:
        | "initial"
        | "backpropagation"
        | "refinement"
        | "dependency_sanity_check"
        | "schema_sanity_check"
        | "cross_schema_sanity_check"
        | "ground_truth"
        | "existing_db_description",
): void
Update table description with new iteration
Parameters
- table: TableDefinition
- description: string
- reasoning: string
- confidence: number
- modelUsed: string
- triggeredBy:
      | "initial"
      | "backpropagation"
      | "refinement"
      | "dependency_sanity_check"
      | "schema_sanity_check"
      | "cross_schema_sanity_check"
      | "ground_truth"
      | "existing_db_description"
Returns void
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:175

Class StateManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns StateManager

Methods

createAnalysisRun

Parameters

Returns AnalysisRun

createInitialState

Parameters

Returns DatabaseDocumentation

delete

Returns Promise<void>

findTable

Parameters

Returns TableDefinition

getLowConfidenceTables

Parameters

Returns { confidence: number; description: string; reasoning: string; schema: string; table: string;}[]

getUnapprovedTables

Parameters

Returns TableDefinition[]

getUnprocessedTables

Parameters

Returns { schema: string; table: string }[]

load

Returns Promise<DatabaseDocumentation>

save

Parameters

Returns Promise<void>

updateColumnDescription

Parameters

Returns void

updateSchemaDescription

Parameters

Returns void

updateSummary

Parameters

Returns void

updateTableDescription

Parameters

Returns void

Settings

On This Page

Returns {
confidence: number;
description: string;
reasoning: string;
schema: string;
table: string;
}[]