Class Introspector

Database introspector Retrieves schema and table information from the database

Index

Constructors

Methods

getExistingDescriptions GetExistingDescriptions getSchemas GetSchemas LoadIndexes

Constructors

constructor

new Introspector(driver: BaseAutoDocDriver): Introspector
Parameters
- driver: BaseAutoDocDriver
Returns Introspector
- Defined in packages/DBAutoDoc/src/database/Database.ts:112

Methods

getExistingDescriptions

getExistingDescriptions(
schemaName: string,
tableName: string,
): Promise<Map<string, string>>
Parameters
- schemaName: string
- tableName: string
Returns Promise<Map<string, string>>
Deprecated
Use GetExistingDescriptions.
- Defined in packages/DBAutoDoc/src/database/Database.ts:230

GetExistingDescriptions

GetExistingDescriptions(
schemaName: string,
tableName: string,
): Promise<Map<string, string>>
Parameters
- schemaName: string
- tableName: string
Returns Promise<Map<string, string>>
- Defined in packages/DBAutoDoc/src/database/Database.ts:214

getSchemas

getSchemas(
schemaFilter: SchemaFilterConfig,
tableFilter: TableFilterConfig,
): Promise<SchemaDefinition[]>
Parameters
- schemaFilter: SchemaFilterConfig
- tableFilter: TableFilterConfig
Returns Promise<SchemaDefinition[]>
Deprecated
Use GetSchemas.
- Defined in packages/DBAutoDoc/src/database/Database.ts:207

GetSchemas

GetSchemas(
schemaFilter: SchemaFilterConfig,
tableFilter: TableFilterConfig,
): Promise<SchemaDefinition[]>
Parameters
- schemaFilter: SchemaFilterConfig
- tableFilter: TableFilterConfig
Returns Promise<SchemaDefinition[]>
- Defined in packages/DBAutoDoc/src/database/Database.ts:114

LoadIndexes

LoadIndexes(
schemas: SchemaDefinition[],
): Promise<{ Error: string; SchemaName: string }[]>
Reads each schema's indexes and stores them on its tables (TableDefinition.indexes). A schema whose catalog read fails is left without indexes and reported in the result.
Parameters
- schemas: SchemaDefinition[]
Returns Promise<{ Error: string; SchemaName: string }[]>
- Defined in packages/DBAutoDoc/src/database/Database.ts:194