fixed SQLCommonParam handling in clickhouse

Author: OleksiiKH0240

integration-tests/tests/clickhouse/clickhouse-core.ts

@@ -184,37 +184,37 @@ export const commonClickHouseTests = () => {
 		test('base test with number param', (ctx) => {
 			const res = ctx.sql`select ${1};`.toSQL();
 
-			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [1] });
+			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [['val1', 1]] });
 		});
 
 		test('base test with bigint param', (ctx) => {
 			const res = ctx.sql`select ${BigInt(10)};`.toSQL();
 
-			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [10n] });
+			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [['val1', 10n]] });
 		});
 
 		test('base test with string param', (ctx) => {
 			const res = ctx.sql`select ${'hello world.'};`.toSQL();
 
-			expect(res).toStrictEqual({ query: `select {val1:String};`, params: ['hello world.'] });
+			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [['val1', 'hello world.']] });
 		});
 
 		test('base test with boolean param', (ctx) => {
 			const res = ctx.sql`select ${true};`.toSQL();
 
-			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [true] });
+			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [['val1', true]] });
 		});
 
 		test('base test with Date param', (ctx) => {
 			const res = ctx.sql`select ${new Date('10.04.2025')};`.toSQL();
 
-			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [new Date('10.04.2025')] });
+			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [['val1', new Date('10.04.2025')]] });
 		});
 
 		test('base test with null param', (ctx) => {
 			const res = ctx.sql`select ${null};`.toSQL();
 
-			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [null] });
+			expect(res).toStrictEqual({ query: `select {val1:String};`, params: [['val1', null]] });
 		});
 
 		// sql.append
@@ -227,7 +227,7 @@ export const commonClickHouseTests = () => {
 			const res = query.toSQL();
 			expect(res).toStrictEqual({
 				query: 'select * from users where id = {val1:String} or id = {val2:String} or id = {val3:String};',
-				params: [1, 3, 4],
+				params: [['val1', 1], ['val2', 3], ['val3', 4]],
 			});
 		});
 

integration-tests/tests/clickhouse/waddler.test.ts

@@ -1077,3 +1077,55 @@ test('sql.stream test', async () => {
 		expect(predicate).toBe(true);
 	}
 });
+
+test('query database test from documentation', async () => {
+	await sql.unsafe(`create table users(
+    id    Int32,
+    name  String,
+    age   Int32,
+    email String
+)
+engine = MergeTree
+order by id;
+  `).command();
+
+	const user = [
+		'John',
+		30,
+		'john@example.com',
+	];
+	await sql`insert into ${sql.identifier('users')} values ${sql.values([[sql.default, ...user]])};`.command();
+	// console.log('New user created!');
+	const _users = await sql`select * from ${sql.identifier('users')};`.query();
+	// console.log('Getting all users from the database:', users);
+	/*
+  const users: {
+    id: number;
+    name: string;
+    age: number;
+    email: string;
+  }[]
+  */
+	await sql`alter table ${sql.identifier('users')} update age = ${31} where email = ${user[2]};`.command();
+	// console.log('User info updated!');
+
+	const stream = sql`select * from ${sql.identifier('users')};`.query().stream();
+
+	// console.log('Streaming users one at a time from the database.');
+	for await (const _user of stream) {
+		// console.log(user);
+		/*
+    const user: {
+      id: number;
+      name: string;
+      age: number;
+      email: string;
+    }
+    */
+	}
+
+	await sql`alter table ${sql.identifier('users')} delete where email = ${user[2]};`.command();
+	// console.log('User deleted!');
+
+	await sql.unsafe(`drop table users;`).command();
+});

waddler/src/clickhouse-core/dialect.ts

@@ -9,6 +9,10 @@ export class ClickHouseDialect extends Dialect {
 		return `{val${lastParamIdx}:${typeToCast || 'String'}}`;
 	}
 
+	override formParam(param: any, lastParamIdx: number) {
+		return [`val${lastParamIdx}`, param];
+	}
+
 	escapeIdentifier(identifier: string): string {
 		return `\`${identifier}\``;
 	}

waddler/src/sql-template-params.ts

@@ -3,6 +3,9 @@ import type { Identifier, IdentifierObject, Raw, UnsafeParamType, Value } from '
 
 export abstract class Dialect implements BuildQueryConfig {
 	abstract escapeParam(lastParamIdx: number): string;
+	formParam(param: any, _lastParamIdx: number): any {
+		return param;
+	}
 	abstract escapeIdentifier(identifier: string): string;
 	abstract checkIdentifierObject(object: IdentifierObject): void;
 
@@ -37,7 +40,7 @@ export class SQLCommonParam extends SQLChunk {
 	) {
 		return {
 			sql: dialect.escapeParam(lastParamIdx + 1),
-			params: [this.value],
+			params: [dialect.formParam(this.value, lastParamIdx + 1)],
 		};
 	}
 }

waddler/src/sql.ts

@@ -30,6 +30,7 @@ export interface Query {
 export interface BuildQueryConfig {
 	escapeIdentifier(identifier: string): string;
 	escapeParam(lastParamIdx: number): string;
+	formParam(param: any, lastParamIdx: number): any;
 	checkIdentifierObject(object: IdentifierObject): void;
 	valueToSQL(
 		{ value, lastParamIdx, params }: {