Class Introspector

Database introspector Retrieves schema and table information from the database

Index

Constructors

Methods

getExistingDescriptions getSchemas

Constructors

constructor

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

Methods

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

getSchemas

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