Skip to content

Validate and auto-generate TypeScript types from raw SQL queries in PostgreSQL.

License

Notifications You must be signed in to change notification settings

ts-safeql/safeql

Repository files navigation

SafeQL - Automatic Type Inference & Validation for PostgreSQL Queries • Get started

npm version

demo.mp4

Features

  • ⚡️ Automatic Type Inference & Validation:

    SafeQL automatically infers the type of the query result based on the query itself.

  • 🖖 Compatible With Popular SQL Libraries:

    SafeQL works with any PostgreSQL client, including Prisma, Sequelize, pg, Postgres.js, and more.

  • 🛠️ Easy To Use

    SafeQL was built in mind to be easy to use and integrate with your existing codebase.

  • 📦 Built with Monorepos & Microservices in mind:

    SafeQL was built with monorepos and microservices in mind, and it's easy to use with multiple databases.

Install

I would first recommend follow the instructions in the documentation.

Prerequisites

  1. Set up ESLint following the typescript-eslint Getting Started docs, to enable TypeScript language support in ESLint
  2. Install the node-gyp prerequisites for your operating system
npm install --save-dev @ts-safeql/eslint-plugin libpg-query

Sponsors