Skip to content

Commit f895b90

Browse files
committed
readme
1 parent ffb8704 commit f895b90

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# sqlc-typescript 🚀
1+
# sqlc-typescript
22

3-
A super lightweight TypeScript SQL query builder that respects your laziness and love for raw SQL. Zero runtime dependencies, just types. This is just a super thin wrapper around sqlc and a file generator - all the real magic is in sqlc. It just makes it more convenient to use in TypeScript projects.
3+
A super lightweight TypeScript types generator that respects your laziness and love for raw SQL.
44

5-
## Demo
5+
Zero runtime dependencies, just types. This is just a super thin wrapper around [sqlc](https://sqlc.dev/) and a file generator - all the real magic is in sqlc. It just makes it more convenient to use in TypeScript projects.
66

7-
<img width="1122" alt="image" src="https://github.com/user-attachments/assets/0556e61c-72ab-465e-86b7-3013e1b82c6f" />
7+
## Demo 🚀
8+
9+
<img alt="image" src="https://github.com/user-attachments/assets/0556e61c-72ab-465e-86b7-3013e1b82c6f" />
810

911
<details>
1012
<summary>Video</summary>
@@ -123,9 +125,9 @@ Unfortunately, we can't use tagged template literals like `` sql`SELECT * FROM u
123125

124126
### Comparison with Other Tools 🔍
125127

126-
- **pgTyped**: Requires separate SQL files and function imports. It uses PostgreSQL wire protocol for type inference which requires a database connection and can't handle nullability well.
127-
- **Prisma TypedSQL**: SQL files are separate and require function imports and it's Prisma 🫠.
128-
- **SafeQL**: Great tool but requires ESLint and database connection for type inference.
128+
- [pgTyped](https://github.com/adelsz/pgtyped): Requires separate SQL files and function imports. It uses PostgreSQL wire protocol for type inference which requires a database connection and can't handle nullability well.
129+
- [Prisma TypedSQL](https://www.prisma.io/docs/orm/prisma-client/using-raw-sql/typedsql): SQL files are separate and require function imports and it's Prisma 🫠.
130+
- [SafeQL](https://github.com/ts-safeql/safeql): Great tool but requires ESLint and database connection for type inference.
129131

130132
The key difference: We use sqlc's SQL parser instead of PostgreSQL wire protocol for type inference, which means:
131133

0 commit comments

Comments
 (0)