Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wsporto/typesql
TypeSQL - Generate Typescript API from raw SQL. Supports MySQL, Sqlite and LibSQL (Turso)
https://github.com/wsporto/typesql
deno mysql node raw-sql sql sqlite typesafe typescript
Last synced: 3 months ago
JSON representation
TypeSQL - Generate Typescript API from raw SQL. Supports MySQL, Sqlite and LibSQL (Turso)
- Host: GitHub
- URL: https://github.com/wsporto/typesql
- Owner: wsporto
- License: mit
- Created: 2020-07-04T00:47:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T00:51:38.000Z (3 months ago)
- Last Synced: 2024-08-04T02:54:33.297Z (3 months ago)
- Topics: deno, mysql, node, raw-sql, sql, sqlite, typesafe, typescript
- Language: TypeScript
- Homepage: https://typesql.pages.dev
- Size: 2.1 MB
- Stars: 184
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-typesafe - wsporto/typesql - Generate Typescript API from raw MySQL queries. Supports MySQL, Sqlite and LibSQL (Turso). (**1. Libraries** / Database)
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:
##### MySQL / MariaDB
- [mysql2](https://www.npmjs.com/package/mysql2) - the standard driver for mysql in NodeJS
##### SQLite
- [better-sqlite3](https://www.npmjs.com/package/better-sqlite3) - the fastest SQLite driver for NodeJS
- [bun:sqlite](https://bun.sh/docs/api/sqlite) - Bun's official high-performance SQLite driver
##### LibSQL
- [libsql](https://www.npmjs.com/package/libsql) - the NodeJS driver for libSQL, the open-source fork of SQLite powering [Turso](https://turso.tech/)
## Example
Having the following query in `select-products.sql` file.
```sql
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 the `date1` and `date2` parameters to the type `Date` and the function return type as `number`.
- **Infer parameter and column nullability.** The nullable database column `email` will generate a nullable field for the query `SELECT email FROM mytable`, but will generate a non-nullable field for the query `SELECT 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 query `SELECT * FROM Books where id = :id` will return `Book|null`, instead of `Book[]`. 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](/docs/orderBy_limit.md).
## Usage
1. _npm install -g typesql-cli_
2. Add the `typesql.json` configuration file in project root folder. You can generate an template with cli command `typesql init`. The client option can be: 'mysql2', 'better-sqlite3', 'libsql' or 'bun:sqlite'. The `authToken` configuration is used only for the libsql client.
```json
{
"databaseUri": "mysql://root:password@localhost/mydb",
"sqlDir": "./sqls",
"client": "mysql2",
"authToken": "authtoken",
"includeCrudTables": []
}
```
3. 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
```
4. 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
```
5. Now you can import and use the generated code.
```
const products = await selectProducts(...
const updateResult = await updateProduct(...
```
## Examples
[Query scaffolding](/docs/query_scaffolding.md)
[INSERT](/docs/insert.md)
[IN/NOT IN Clause](/docs/in_clause.md)
[MySQL FUNCTIONS](/docs/functions.md)
[ORDER BY and LIMIT clauses](/docs/orderBy_limit.md)
[LIKE](/docs/like.md)
[Nested Query Result](/docs/nested-query-result.md)
## 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.