Class MysqlIntrospector

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

Hierarchy

MysqlIntrospector

Implements

DatabaseIntrospector

Index

Constructors

Methods

getMetadata getSchemas getTables

Constructors

constructor

new MysqlIntrospector(db): MysqlIntrospector
Parameters
- db: Kysely<any>
Returns MysqlIntrospector
- Defined in kysely/src/dialect/mysql/mysql-introspector.ts:19

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.
Implementation of DatabaseIntrospector.getMetadata
- Defined in kysely/src/dialect/mysql/mysql-introspector.ts:70

getSchemas

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

Returns Promise<SchemaMetadata[]>
Implementation of DatabaseIntrospector.getSchemas
- Defined in kysely/src/dialect/mysql/mysql-introspector.ts:23

getTables

getTables(options?): Promise<TableMetadata[]>
Get tables and views metadata.
Parameters
- options: DatabaseMetadataOptions = ...
Returns Promise<TableMetadata[]>
Implementation of DatabaseIntrospector.getTables
- Defined in kysely/src/dialect/mysql/mysql-introspector.ts:33

Generated using TypeDoc