@rmp135/sql-ts

sql-ts

Generate TypeScript types for tables and views in a SQL database.

Includes comments from tables, views and columns for supported providers.

Highly configurable: choose your own naming and casing schemes, add types, extend base types, and more.

Supports the following database providers: MySQL, Microsoft SQL Server, SQLite and Postgres.

CREATE TABLE [dbo].[Employees](
	[EmployeeID] [int] IDENTITY(1,1) NOT NULL,
	[Name] [nvarchar](20) NOT NULL,
	[BirthDate] [datetime] NULL,
	[Photo] [image] NULL
)

export interface EmployeesEntity {
  'EmployeeID'?: number;
  'Name': string;
  'BirthDate'?: Date | null;
  'Photo'?: Buffer | null;
}

Documentation

Full documentation with all configuration options and node APIs are available at https://rmp135.github.io/sql-ts/.

Installation

Install into your project using npm / yarn.

npm install @rmp135/sql-ts

Install your relevant SQL driver. Refer to the knex documentation to determine which driver you should install. For example npm install mysql2.

Create a configuration file, for example mysql.json. This will mirror connection details from knex. The client property will determine the SQL provider.

The most basic MySQL setup is below, modify as appropriate. Additional options can be applied by referring to the Config.

{
  "client": "mysql2",
  "connection": {
    "host": "localhost",
    "user": "user",
    "password": "password",
    "database" : "my_database"
  }
}

Usage

CLI

Run npx @rmp135/sql-ts with the path of the configuration file created above.

npx @rmp135/sql-ts -c ./mysql.json

The file will be exported with the filename Database.ts (or with the name specified via the filename config option) at the current working directory.

Node Module

For finer grained control of the exported types, you can use the node API. See how in the documentation.