Interface DatabaseIntrospector

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

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

Implemented by

Methods

getMetadata getSchemas getTables

Methods

getMetadata

  • getMetadata(options?): Promise<DatabaseMetadata>

  • Get the database metadata such as table and column names.

    Parameters

    Returns Promise<DatabaseMetadata>

    Deprecated

    Use getTables() instead.

getSchemas

  • getSchemas(): Promise<SchemaMetadata[]>

  • Get schema metadata.

    Returns Promise<SchemaMetadata[]>

getTables

  • getTables(options?): Promise<TableMetadata[]>

  • Get tables and views metadata.

    Parameters

    Returns Promise<TableMetadata[]>

Settings

Member Visibility

Theme

On This Page

getMetadatagetSchemasgetTables