felpereira / queryforge Goto Github PK

QueryForge is a TypeScript library that provides a flexible and type-safe way to compose SQL queries dynamically. With QueryForge, you can easily construct SELECT, INSERT, UPDATE, and DELETE queries using TypeScript code.

Link: https://playcode.io/1817024

import QueryComposer from 'queryforge';

interface Casa {
  quartos: number;
  bairro: string;
  rua: string;
}

// Create an instance of QueryComposer with the desired type
const queryComposer = new QueryComposer<Casa>();

// Example: Generating a SELECT query
const selectQuery = queryComposer
  .startSelection('Casa')
  .Select('quartos', 'bairro', 'rua')
  .Where((item) => {
    return item.quartos > 2 && item.bairro === '1';
  })
  .toString();
console.log(selectQuery);
// Output: SELECT quartos, bairro, rua FROM Casa WHERE quartos > 2 AND bairro = '1';

// Example: Generating an INSERT query
const insertQuery = queryComposer
  .startInsertion('Casa')
  .Insert('bairro', 'Paulista')
  .Insert('quartos', 3)
  .toString();
console.log(insertQuery);
// Output: INSERT INTO Casa SET (bairro, quartos) VALUES ('Paulista',3);

// Other examples for UPDATE and DELETE queries are also available.

The main class responsible for composing SQL queries. It accepts a type parameter T representing the schema of the table.

• startSelection(entity: string): ConstructorQuerySelectable<T>: Initialize a SELECT query for the specified entity.
• startUpdation(entity: string): ConstructorQueryUpdatable<T>: Initialize an UPDATE query for the specified entity.
• startDeletion(entity: string): ConstructorQueryDeletable<T>: Initialize a DELETE query for the specified entity.
• startInsertion(entity: string): ConstructorQueryInsertable<T>: Initialize an INSERT query for the specified entity.

This library is licensed under the MIT License. See the LICENSE file for details.

Contributions are welcome! If you find any issues or have suggestions, feel free to open an issue or create a pull request on GitHub.

• cb.felipe

For any inquiries or support, please contact [email protected].

Special thanks to the developers and contributors of TypeScript, Jest, and other dependencies used in this project.

• 1.0.0 (YYYY-MM-DD): Initial release.

TypeScript, SQL, Query Builder, Dynamic Queries, Database, Jest

• Link to Related Project

Feel free to add any additional sections or modify the content according to your project's specific requirements.