Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jasonshin/sqlx-ts

node.js compile-time SQL validations & type generations
https://github.com/jasonshin/sqlx-ts

mysql nodejs postgresql rust sql sqlx typescript

Last synced: 2 days ago
JSON representation

node.js compile-time SQL validations & type generations

Awesome Lists containing this project

README 

        
sqlx-ts





 

   🧰 The Typescript/Javascript SQL Toolkit

 








SQLx-ts is a CLI application featuring compile-time checked queries without a DSL and generates types against SQLs to keep your code type-safe



- **Compile time checked queries** - never ship a broken SQL query to production (and [sqlx-ts is not an ORM](https://github.com/JasonShin/sqlx-ts#sqlx-ts-is-not-an-orm))

- **TypeScript type generations** - generates type definitions based on the raw SQLs and you can use them with any MySQL or PostgreSQL driver

- **Database Agnostic** - support for [PostgreSQL](http://postgresql.org/) and [MySQL](https://www.mysql.com/) (and more DB supports to come)

- **TypeScript and JavaScript** - supports for both [TypeScript](https://jasonshin.github.io/sqlx-ts/reference-guide/4.typescript-types-generation.html) and [JavaScript](https://github.com/JasonShin/sqlx-ts#using-sqlx-ts-in-vanilla-javascript)








    

    📔 Official Documentation

    

     | 

    

        🤓 Demo

    







### Installation



##### Install sqlx-ts npm module (recommended)



If you are using npm

```bash

$ npm install sqlx-ts

```



If you are using yarn

```bash

$ yarn add sqlx-ts

```



You can also install sqlx-ts globally

```bash

$ npm install -g sqlx-ts

```



Installing sqlx-ts using npm also installed `sqlx-ts` binary of the same version as the npm module.

Verify the installation by running



```bash

$ npx sqlx-ts --version

```



And to use sqlx-ts in your code



In TypeScript based projects:



```typescript

import { sql } from 'sqlx-ts'



// ...

const query = sql`SELECT * FROM some_table;`

// ...

```



In Babel based projects:



```javascript

import { sql } from 'sqlx-ts'

const query = sql`SELECT * FROM some_table;`



// ... or



const { sql } = require('sqlx-ts')

const query = sql`SELECT * FROM some_table;`

```



##### Installing binary separately



You may choose to install sqlx-ts separately instead of using `npm i`



###### Using install.sh



The binary name for sqlx-ts is `sqlx-ts`.



[Archives of precompiled binaries of sqlx-ts are available for windows, macOS and Linux](https://github.com/JasonShin/sqlx-ts/releases). Linux and Windows binaries are static executables. Users of platforms not explicitly mentioned below are advised to download one of these archives.



If you're a **macOS** user, then you can install sqlx-ts from via install.sh:



```bash

# macos & ARM CPU

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os darwin --cpu arm64

# macos & X64 CPU

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os darwin --cpu x64

```



If you're a **Windows** user, then you can install sqlx-ts from via install.sh:



```bash

# windows & x32

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os win32 --cpu x32

# windows & x64

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os win32 --cpu x32

```



If you're a **Linux** user, then you can install sqlx-ts from via install.sh:



```bash

# linux & x32

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os linux --cpu x32

# linux & x64

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os linux --cpu x64

# linux & arm

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os linux --cpu arm64

```



To install a specific artifact, [go to the release page to find the exact name of the artifact](https://github.com/JasonShin/sqlx-ts/releases)



```bash

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --artifact sqlx-ts-v0.1.0-macos-arm.zip

```



Upgrading to a new version can be done by grabbing the next version of the sqlx-ts artifact and use `--force` command from install.sh



```bash

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | \

    sh -s -- --artifact ssqlx-ts-v0.1.0-macos-arm.zip --force

```



For more advanced usage, please check `--help` command of install.sh



```bash

$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | \

    sh -s -- --help

```



### Roadmap



[Please check the public notion board for the current and future work items](https://foil-adasaurus-bba.notion.site/f1ca150c5b0141d69eaf136c596ae649?v=efc6af2aa3174f87a39bec8edc09c4a9)



### sqlx-ts is not an ORM!



sqlx-ts supports **compile-time checked queries** and **generated types against SQLs**. It does not, however, do this by providing DSL (domain-specific language) for building queries. Instead, it provides a macro (almost) that take regular SQL as input and ensures that it is valid against the target database. The way it works is that sqlx-ts connects to your local or development database at compile-time and have database itself to verify the queries, also generate types based on information_schema. This can have many benefits that typical ORMs cannot provide

- Since sqlx-ts simply sends the queries back to the DB, almost any SQL syntax can be used in sqlx-ts (including things added by database extensions)

- You can easily optimize the queries as the SQLs are not built using a query-builder or an ORM interface

- The generated types work well with almost any database driver or even ORMs if they have good typescript support (that allows you to override input and output types)



but it comes with some implications

- The amount of information that sqlx-ts retrieves depend on the type of the database (e.g. MySQL vs PostgreSQL)



If you are looking for an ORM, you can checkout [Sequelize](https://sequelize.org/) or [Prisma](https://www.prisma.io/).



### Using sqlx-ts in vanilla JavaScript



If you are trying to use sqlx-ts against vanilla JS, the [TypeScript type-generation](https://jasonshin.github.io/sqlx-ts/reference-guide/4.typescript-types-generation.html) feature wouldn't be helpful. You can simply use [SQL Check](https://jasonshin.github.io/sqlx-ts/reference-guide/1.sql-check.html) feature to keep your SQLs in JS code safe and compile-time checked.



### Motivation



I would like to bring the powerful compile-time safety ideas to Node.js. [sqlx](https://github.com/launchbadge/sqlx) is a great example of this, as it provides compile-time check of SQLs within your Rust code and Rust itself provides a great environment for tools like sqlx. sqlx-ts is greatly inspired by [sqlx](https://github.com/launchbadge/sqlx), but solves additional problems of generating TypeScript interfaces based on the SQL queries that are present in your code.