Class StateManager

Exports for state module

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
Parameters
- state: DatabaseDocumentation
- modelUsed: string
- vendor: string
- temperature: number
- OptionaltopP: number
- OptionaltopK: number
Returns AnalysisRun
Deprecated
Use CreateAnalysisRun.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:191

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:154

createInitialState

createInitialState(
databaseName: string,
serverName: string,
): DatabaseDocumentation
Parameters
- databaseName: string
- serverName: string
Returns DatabaseDocumentation
Deprecated
Use CreateInitialState.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:144

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:111

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
Use Delete.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:514

Delete

Delete(): Promise<void>
Delete state file

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

findTable

findTable(
    state: DatabaseDocumentation,
    schemaName: string,
    tableName: string,
): TableDefinition
Parameters
- state: DatabaseDocumentation
- schemaName: string
- tableName: string
Returns TableDefinition
Deprecated
Use FindTable.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:317

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:303

getLowConfidenceTables

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

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:350

getUnapprovedTables

getUnapprovedTables(state: DatabaseDocumentation): TableDefinition[]
Parameters
- state: DatabaseDocumentation
Returns TableDefinition[]
Deprecated
Use GetUnapprovedTables.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:343

GetUnapprovedTables

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

getUnprocessedTables

getUnprocessedTables(
state: DatabaseDocumentation,
): { schema: string; table: string }[]
Parameters
- state: DatabaseDocumentation
Returns { schema: string; table: string }[]
Deprecated
Use GetUnprocessedTables.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:423

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:405

load

load(): Promise<DatabaseDocumentation>
Returns Promise<DatabaseDocumentation>
Deprecated
Use Load.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:79

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>
Parameters
- state: DatabaseDocumentation
Returns Promise<void>
Deprecated
Use Save.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:104

Save

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

updateColumnDescription

updateColumnDescription(
    column: ColumnDefinition,
    description: string,
    reasoning: string,
    modelUsed: string,
): void
Parameters
- column: ColumnDefinition
- description: string
- reasoning: string
- modelUsed: string
Returns void
Deprecated
Use UpdateColumnDescription.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:260

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:242

updateSchemaDescription

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

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:272

updateSummary

updateSummary(state: DatabaseDocumentation): void
Parameters
- state: DatabaseDocumentation
Returns void
Deprecated
Use UpdateSummary.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:495

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:449

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
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
Deprecated
Use UpdateTableDescription.
- Defined in packages/DBAutoDoc/src/state/StateManager.ts:228

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:205

Class StateManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns StateManager

Methods

createAnalysisRun

Parameters

Returns AnalysisRun

Deprecated

CreateAnalysisRun

Parameters

Returns AnalysisRun

createInitialState

Parameters

Returns DatabaseDocumentation

Deprecated

CreateInitialState

Parameters

Returns DatabaseDocumentation

delete

Returns Promise<void>

Deprecated

Delete

Returns Promise<void>

findTable

Parameters

Returns TableDefinition

Deprecated

FindTable

Parameters

Returns TableDefinition

getLowConfidenceTables

Parameters

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

Deprecated

GetLowConfidenceTables

Parameters

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

getUnapprovedTables

Parameters

Returns TableDefinition[]

Deprecated

GetUnapprovedTables

Parameters

Returns TableDefinition[]

getUnprocessedTables

Parameters

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

Deprecated

GetUnprocessedTables

Parameters

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

load

Returns Promise<DatabaseDocumentation>

Deprecated

Load

Returns Promise<DatabaseDocumentation>

save

Parameters

Returns Promise<void>

Deprecated

Save

Parameters

Returns Promise<void>

updateColumnDescription

Parameters

Returns void

Deprecated

UpdateColumnDescription

Parameters

Returns void

updateSchemaDescription

Parameters

Returns void

Deprecated

UpdateSchemaDescription

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

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