feat(sql.raw): Allow parameters in raw sql (kysely-org#512)

* feat(sql.raw): Allow parameters in raw sql * use pre-compiled query * Apply suggestions from code review Co-authored-by: Igal Klebanov <[email protected]> --------- Co-authored-by: Igal Klebanov <[email protected]>
Gaspero · Oct 2, 2023 · c19206d · c19206d
1 parent 1abac75
commit c19206d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/src/query-compiler/compiled-query.ts b/src/query-compiler/compiled-query.ts
@@ -9,11 +9,11 @@ export interface CompiledQuery<O = unknown> {
 }
 
 export const CompiledQuery = freeze({
-  raw(sql: string): CompiledQuery {
+  raw(sql: string, parameters: unknown[] = []): CompiledQuery {
     return freeze({
       sql,
       query: RawNode.createWithSql(sql),
-      parameters: freeze([]),
+      parameters: freeze(parameters),
     })
   },
 })
diff --git a/test/node/src/raw-sql.test.ts b/test/node/src/raw-sql.test.ts
@@ -1,4 +1,4 @@
-import { sql } from '../../../'
+import { sql, CompiledQuery } from '../../../'
 
 import {
   DIALECTS,
@@ -268,6 +268,18 @@ for (const dialect of DIALECTS) {
       })
     }
 
+    if (dialect === 'postgres') {
+      it('CompiledQuery should support raw query with parameters', async () => {
+        const query = CompiledQuery.raw(
+          'select * from "person" where "public"."person"."first_name" between $1 and $2',
+          ['A', 'B']
+        )
+        expect(query.sql).to.equal('select * from "person" where "public"."person"."first_name" between $1 and $2');
+        expect(query.parameters).to.deep.equal(['A', 'B']);
+        await ctx.db.executeQuery(query)
+      })
+    }
+
     it('raw sql kitchen sink', async () => {
       const result = await sql`insert into ${sql.table('toy')} (${sql.join([
         sql.ref('name'),