knex-schema-inspector/lib/types/schema-inspector.ts

Utility for extracting information about existing DB schema

import { Knex } from 'knex';
import { Table } from './table';
import { Column } from './column';
import { ForeignKey } from './foreign-key';

export interface SchemaInspector {
  knex: Knex;

  tables(): Promise<string[]>;

  tableInfo(): Promise<Table[]>;
  tableInfo(table: string): Promise<Table>;

  hasTable(table: string): Promise<boolean>;

  columns(table?: string): Promise<{ table: string; column: string }[]>;

  columnInfo(): Promise<Column[]>;
  columnInfo(table?: string): Promise<Column[]>;
  columnInfo(table: string, column: string): Promise<Column>;

  hasColumn(table: string, column: string): Promise<boolean>;
  primary(table: string): Promise<string | null>;

  foreignKeys(table?: string): Promise<ForeignKey[]>;

  // Not in MySQL
  withSchema?(schema: string): void;
}

export interface SchemaInspectorConstructor {
  new (knex: Knex): SchemaInspector;
}