Interface DatabaseIntrospector

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

Hierarchy

DatabaseIntrospector

Implemented by

Index

Methods

getMetadata getSchemas getTables

Methods

getMetadata

getMetadata(options?): Promise<DatabaseMetadata>
Get the database metadata such as table and column names.
Parameters
- Optional options: 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?): Promise<TableMetadata[]>
Get tables and views metadata.
Parameters
- Optional options: DatabaseMetadataOptions
Returns Promise<TableMetadata[]>
- Defined in kysely/src/dialect/database-introspector.ts:13

Generated using TypeDoc