Interface DbDriver

packages/reltab/src/DataSource.ts:61–79

 * data catalog information
 */
export interface DbDriver {
  readonly sourceId: DataSourceId;
  readonly dialect: SQLDialect;

  runSqlQuery(sqlQuery: string): Promise<Row[]>;
  getTableSchema(tableName: string): Promise<Schema>;
  getSqlQuerySchema(sqlQuery: string): Promise<Schema>;

  getSqlQueryColumnStatsMap(sqlQuery: string): Promise<ColumnStatsMap>;

  getRootNode(): Promise<DataSourceNode>;
  getChildren(path: DataSourcePath): Promise<DataSourceNode[]>;

  // Get a table name that can be used in queries:
  getTableName(path: DataSourcePath): Promise<string>;

  // display name for this connection
  getDisplayName(): Promise<string>;
}

/**
 * A local or remote connection to a data source.