Interface DatabaseIntrospector

An interface for getting the database metadata (names of the tables and columns etc.)

interface DatabaseIntrospector {
    getMetadata(
        options?: DatabaseMetadataOptions,
    ): Promise<DatabaseMetadata>;
    getSchemas(): Promise<SchemaMetadata[]>;
    getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
}

Implemented by

Index

Methods

getMetadata getSchemas getTables

Methods

getMetadata

getMetadata(options?: DatabaseMetadataOptions): Promise<DatabaseMetadata>
Get the database metadata such as table and column names.
Parameters
- Optionaloptions: DatabaseMetadataOptions
Returns Promise<DatabaseMetadata>
Deprecated
Use getTables() instead.
- Defined in kysely/src/dialect/database-introspector.ts:20

getSchemas

getSchemas(): Promise<SchemaMetadata[]>
Get schema metadata.

Returns Promise<SchemaMetadata[]>
- Defined in kysely/src/dialect/database-introspector.ts:8

getTables

getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>
Get tables and views metadata.
Parameters
- Optionaloptions: DatabaseMetadataOptions
Returns Promise<TableMetadata[]>
- Defined in kysely/src/dialect/database-introspector.ts:13