Interface SchemaIntrospectionSQL

Schema introspection queries for a given database platform. Each dialect provides platform-specific catalog queries.

interface SchemaIntrospectionSQL {
    listColumns: string;
    listConstraints: string;
    listForeignKeys: string;
    listIndexes: string;
    listTables: string;
    objectExists: string;
}

Properties

listColumns: string

Query that returns all columns for a given table

listConstraints: string

Query that returns constraints (PK, UNIQUE, CHECK)

listForeignKeys: string

Query that returns foreign key relationships

listIndexes: string

Query that returns indexes

listTables: string

Query that returns all user tables in a schema

objectExists: string

Template for checking if a database object exists