typesql-cli
v0.15.1
Published
**TypeSQL** generates typesafe Typescript APIs from your SQL statements. Write your queries in raw SQL and TypeSQL generates the type-safe APIs to execute those queries.
Downloads
1,264
Readme
TypeSQL
TypeSQL generates typesafe Typescript APIs from your SQL statements. Write your queries in raw SQL and TypeSQL generates the type-safe APIs to execute those queries.
Access your database directly without a heavy ORM, gain effortless type-safety, and make maintaining your SQL simple.
TypeSQL supports multiple SQL database backends:
PostgreSQL (Experimental)
- pg - PostgreSQL client for node.js.
MySQL / MariaDB
- mysql2 - the standard driver for mysql in NodeJS
SQLite
- better-sqlite3 - the fastest SQLite driver for NodeJS
- bun:sqlite - Bun's official high-performance SQLite driver
LibSQL
Cloudflare D1
- @cloudflare/d1 - Serverless SQLite-compatible database from Cloudflare.
Example
Having the following query in select-products.sql
file.
SELECT
id,
product_name,
list_price
FROM products
WHERE discontinued = 0
AND list_price BETWEEN :minPrice AND :maxPrice
TypeSQL will generate the types and function in the file select-products.ts
.
Then you can import the generate code and execute as following:
deno syntax:
Some features:
Do not restrict the use of SQL You dont need to learn any new query language, you can use SQL with all its power and expressiveness.
Infer parameters and columns types.
SELECT DATEDIFF(:date1, :date2) as days_stayed
will resolve thedate1
anddate2
parameters to the typeDate
and the function return type asnumber
.Infer parameter and column nullability. The nullable database column
email
will generate a nullable field for the querySELECT email FROM mytable
, but will generate a non-nullable field for the querySELECT email FROM mytable WHERE email is not null
;Infer the query return type (single row vs multiple rows). If the
id
is a primary key or unique key, then function for the querySELECT * FROM Books where id = :id
will returnBook|null
, instead ofBook[]
. The same is true for filters with LIMIT 1;Allow the use of dynamic ORDER BY with auto-completion and compile-time verification. See here.
Usage
npm install -g typesql-cli
Add the
typesql.json
configuration file in project root folder. You can generate an template with cli commandtypesql init
. The client option can be: 'pg', 'mysql2', 'better-sqlite3', 'libsql', 'bun:sqlite' or 'd1'. TheauthToken
configuration is used only for the libsql client.
{
"databaseUri": "mysql://root:password@localhost/mydb",
"sqlDir": "./sqls",
"client": "mysql2",
"authToken": "authtoken",
"includeCrudTables": []
}
- Write your queries in the folder specified in the configuration file. You can also use the cli to scaffold the queries.
sqls\
select-products.sql
insert-product.sql
update-product.sql
- Then run
typesql compile --watch
to start typesql in watch mode. After that you will have one Typescript file for each query file.
sqls\
select-products.sql
select-products.ts
insert-product.sql
insert-product.ts
update-product.sql
update-product.ts
- Now you can import and use the generated code.
const products = await selectProducts(...
const updateResult = await updateProduct(...
Examples
Project Status: Under Active Development
WARNING: This is a work-in-progress experimental project. It is under active development and its API might change.
Issues reports and feature requests are welcome.