Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adelsz/pgtyped
pgTyped - Typesafe SQL in TypeScript
https://github.com/adelsz/pgtyped
generator postgres postgresql query sql type-safety types typescript
Last synced: 4 days ago
JSON representation
pgTyped - Typesafe SQL in TypeScript
- Host: GitHub
- URL: https://github.com/adelsz/pgtyped
- Owner: adelsz
- License: mit
- Created: 2019-09-23T20:52:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-29T06:26:54.000Z (15 days ago)
- Last Synced: 2024-11-29T08:03:21.186Z (15 days ago)
- Topics: generator, postgres, postgresql, query, sql, type-safety, types, typescript
- Language: TypeScript
- Homepage: https://pgtyped.dev
- Size: 10.2 MB
- Stars: 2,985
- Watchers: 16
- Forks: 99
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - pgtyped - Typesafe SQL in TypeScript | adelsz | 1626 | (TypeScript)
README
# [PgTyped](https://pgtyped.dev/)
[](https://github.com/adelsz/pgtyped/actions) [](https://gitter.im/pgtyped/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
PgTyped makes it possible to use raw SQL in TypeScript with guaranteed type-safety.
No need to map or translate your DB schema to TypeScript, PgTyped automatically generates types and interfaces for your SQL queries by using your running Postgres database as the source of type information.
---
## Features:
1. Automatically generates TS types for parameters/results of SQL queries of any complexity.
2. Supports extracting and typing queries from both SQL and TS files.
3. Generate query types as you write them, using watch mode.
4. Useful parameter interpolation helpers for arrays and objects.
5. No need to define your DB schema in TypeScript, your running DB is the live source of type data.
6. Prevents SQL injections by not doing explicit parameter substitution. Instead, queries and parameters are sent separately to the DB driver, allowing parameter substitution to be safely done by the PostgreSQL server.
7. Native ESM support. Runtime dependencies are also provided as CommonJS.
### Documentation
Visit our documentation page at [https://pgtyped.dev/](https://pgtyped.dev/)
### Getting started
1. `npm install -D @pgtyped/cli typescript` (typescript is a required peer dependency for pgtyped)
2. `npm install @pgtyped/runtime` (`@pgtyped/runtime` is the only required runtime dependency of pgtyped)
3. Create a PgTyped `config.json` file.
4. Run `npx pgtyped -w -c config.json` to start PgTyped in watch mode.
More info on getting started can be found in the [Getting Started](https://pgtyped.dev/docs/getting-started) page.
You can also refer to the [example app](./packages/example/README.md) for a preconfigured example.
### Example
Lets save some queries in `books.sql`:
```sql
/* @name FindBookById */
SELECT * FROM books WHERE id = :bookId;
```
PgTyped parses the SQL file, extracting all queries and generating strictly typed TS queries in `books.queries.ts`:
```ts
/** Types generated for queries found in "books.sql" */
//...
/** 'FindBookById' parameters type */
export interface IFindBookByIdParams {
bookId: number | null;
}
/** 'FindBookById' return type */
export interface IFindBookByIdResult {
id: number;
rank: number | null;
name: string | null;
author_id: number | null;
}
/**
* Query generated from SQL:
* SELECT * FROM books WHERE id = :bookId
*/
export const findBookById = new PreparedQuery<
IFindBookByIdParams,
IFindBookByIdResult
>(...);
```
Query `findBookById` is now statically typed, with types inferred from the PostgreSQL schema.
This generated query can be imported and executed as follows:
```ts
import { Client } from 'pg';
import { findBookById } from './books.queries';
export const client = new Client({
host: 'localhost',
user: 'test',
password: 'example',
database: 'test',
});
async function main() {
await client.connect();
const books = await findBookById.run(
{
bookId: 5,
},
client,
);
console.log(`Book name: ${books[0].name}`);
await client.end();
}
main();
```
### Resources
1. [Configuring pgTyped](https://pgtyped.dev/docs/cli)
2. [Writing queries in SQL files](https://pgtyped.dev/docs/sql-file-intro)
3. [Advanced queries and parameter expansions in SQL files](https://pgtyped.dev/docs/sql-file)
4. [Writing queries in TS files](https://pgtyped.dev/docs/ts-file-intro)
5. [Advanced queries and parameter expansions in TS files](https://pgtyped.dev/docs/ts-file)
### Project state:
This project is being actively developed and its APIs might change.
All issue reports, feature requests and PRs appreciated.
### License
[MIT](https://github.com/adelsz/pgtyped/tree/master/LICENSE)
Copyright (c) 2019-present, Adel Salakh