gajus/database-types

A generic type generator for various databases.

database-types

A generic type generator for various databases.

The current supported database backend is Postgres. Track #1 issue for MySQL support.

Use case

If you are developing applications in JavaScript and using either of the strict type systems, then you can use database-types to generate types describing the database.

Example usage

Generating Flow types

export DATABASE_TYPES_DATABASE_CONNECTION_URI=postgres://postgres:[email protected]/test
export DATABASE_TYPES_COLUMN_FILTER="return !['raster_overviews', 'raster_columns', 'geometry_columns', 'geography_columns', 'spatial_ref_sys'].includes(tableName)"
export DATABASE_TYPES_DIALECT=flow

database-types generate-types > ./types.js

This generates file containing Flow type declarations in the following format:

export type ReservationSeatRecordType = {|
  +createdAt: string,
  +id: number,
  +reservationId: number,
  +seatId: number
|};

export type TicketTypeRecordType = {|
  +cinemaId: number,
  +id: number,
  +name: string,
  +nid: string,
  +policy: string | null
|};

// ...

CLI

$ npm install database-types -g
$ database-types --help

database-types's Issues

Add TypeScript support

As discussed in https://news.ycombinator.com/item?id=14499286

Add MongoDB support

hi,

it would be nice to have support for mongodb. (in core or via a dedicated plugin)
is this architecture already supporting plugins?
if not you should define an interface to be implemented by plugins and leave the core agnostic to the db driver being used.

Add MySQL support

better handle of not null

current output:

updatedAt: string | null

it should be updatedAt?: string

Add Oracle support

bool is typed as any

CREATE TABLE card (
	id int8 NOT NULL DEFAULT,
	active bool NOT NULL DEFAULT true,
}

result

export type CardRecordType = {|
  +active: any,
  +id: number,
|};

add plugins support

hi,

it would be nice to define a common generic interface that has to be implemented by db plugins in order to facilitate the contributions from the community. the architecture should also be updated to support plugins. see #4 .