blaanteam / ts-sql-builder Goto Github PK

Issue Type

enhancement

Description

Seperate code in /lib/query-builder.ts

• put interfaces & enums in different files
• move createQueryBuilder() to functions

Issue Type

enhancement

Description

Add unit & e2e tests, as well as usage examples

Issue Type

enhancement / feature request

Description

Here, instead of having fields as an array of column names, allow optional alias for selected columns

Update these methods and this part accordingly.

Is your feature request related to a problem? Please describe.

It's a better idea to create an automated schema builder.

Describe the solution you'd like

Kind of like ORMs (typeorm entities for instane), I'd like to automatically generate sql table schemas just from a class. This way, when I fetch data from a table I know for sure it can fit into a class (from which I generated the table schema).

Describe alternatives you've considered

None, the main solution seems doable & perfect!

Additional context

Idea:
This code:

@Table('users')
class User {
  @PrimaryKey()
  @Column({ type: 'SERIAL' })
  id!: number;

  @Column({ type: 'VARCHAR(255)', nullable: false })
  name!: string;

  @Column({ type: 'VARCHAR(65)', nullable: false, unique: true })
  username!: string;

  @Column({ type: 'INTEGER', check: 'age >= 18' })
  age!: number;

  @Column({ type: 'VARCHAR(255)', unique: true })
  email!: string;

  @Column({
    name: 'created_at',
    type: 'TIMESTAMP',
    default: () => 'CURRENT_TIMESTAMP',
  })
  createdAt!: Date;

  @Column({ type: 'BOOLEAN', default: true })
  activated!: boolean;
}

Generates this schema:

CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255) NOT NULL,
  username VARCHAR(65) UNIQUE NOT NULL,
  age INTEGER CHECK (age >= 18),
  email VARCHAR(255) UNIQUE,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  activated BOOLEAN DEFAULT true
);

Description

• implement builder
• add formatter

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Issue Type

Docs

Description

• Add README.md
• Add JSDoc comments
• Generate documentation (may use typedoc for that)

Example

  /**
   * Add columns to the SELECT clause of the SQL query.
   * @param selection A column name, a record of columns-aliases, or an array containing a mix both.
   * @param fromTable Optional. If specified, all selected columns are prefixed with 'fromTable.'.
   * @returns The current instance of the QueryBuilder for method chaining.
   */
  select(...)

Issue Type

enhancement / feature request

Description

Add sub queries
Add ALL and ANY operators
Support subqueries for IN operator

Issue Type

Feature request

Description

Support other crud queries:

• INSERT INTO
• UPDATE
• DELETE