sql-embedder

About sql-embedder

How It Works

.sql

.sql.ts

books.sql       →  books.sql.ts
queries.sql     →  queries.sql.ts

Identifying Generated Files

// This file was generated by sql-embedder. Do not edit manually.

Critical Rule

.sql.ts

.sql

.ts

Correct Workflow

1. Edit the source

   .sql

   file (e.g.,

   books.sql

   )
2. Identify the generation command by checking the project's task runner config:

   • deno.json

     → look for a

     generate

     task

   • package.json

     → look for a

     generate

     script in

     scripts

   • Makefile

     → look for a

     generate

     target

   • justfile

     → look for a

     generate

     recipe
3. Run the identified command to regenerate the TypeScript files

Example

findBooksByAuthor

1. Edit

   books.sql

   :
   sql

   -- findBooksByAuthor finds all books by a given author.
   SELECT * FROM books WHERE author_id = ?;

2. Check the project config (e.g.,

   deno.json

   ,

   package.json

   ) for the generate command
3. Run the generation command

books.sql.ts