Merge pull request #26 from reload/backquotes

fix: escape backquotes in a query

#minor

Author: arnested

examples/authors/mysql/query.sql

@@ -27,3 +27,6 @@ WHERE id = ?;
 /* name: Test :one */
 SELECT * FROM node_mysql_types
 LIMIT 1;
+
+/* name: GetReservedWords :many */
+SELECT `id`, `key`, `value` FROM reserved_words;

examples/authors/mysql/schema.sql

@@ -50,3 +50,10 @@ CREATE TABLE node_mysql_types (
 
   c_json JSON
 );
+
+/* https://dev.mysql.com/doc/refman/8.4/en/keywords.html#keywords-8-4-detailed-I */
+CREATE TABLE reserved_words (
+  `id` BIGINT PRIMARY KEY AUTO_INCREMENT,
+  `key` TEXT,
+  `value` TEXT
+);

examples/bun-mysql2/src/db/query_sql.ts

@@ -215,3 +215,27 @@ export async function test(client: Client): Promise<TestRow | null> {
     };
 }
 
+export const getReservedWordsQuery = `-- name: GetReservedWords :many
+SELECT \`id\`, \`key\`, \`value\` FROM reserved_words`;
+
+export interface GetReservedWordsRow {
+    id: number;
+    key: string | null;
+    value: string | null;
+}
+
+export async function getReservedWords(client: Client): Promise<GetReservedWordsRow[]> {
+    const [rows] = await client.query<RowDataPacket[]>({
+        sql: getReservedWordsQuery,
+        values: [],
+        rowsAsArray: true
+    });
+    return rows.map(row => {
+        return {
+            id: row[0],
+            key: row[1],
+            value: row[2]
+        };
+    });
+}
+

examples/node-mysql2/src/db/query_sql.ts

@@ -215,3 +215,27 @@ export async function test(client: Client): Promise<TestRow | null> {
     };
 }
 
+export const getReservedWordsQuery = `-- name: GetReservedWords :many
+SELECT \`id\`, \`key\`, \`value\` FROM reserved_words`;
+
+export interface GetReservedWordsRow {
+    id: string;
+    key: string | null;
+    value: string | null;
+}
+
+export async function getReservedWords(client: Client): Promise<GetReservedWordsRow[]> {
+    const [rows] = await client.query<RowDataPacket[]>({
+        sql: getReservedWordsQuery,
+        values: [],
+        rowsAsArray: true
+    });
+    return rows.map(row => {
+        return {
+            id: row[0],
+            key: row[1],
+            value: row[2]
+        };
+    });
+}
+

src/app.ts

@@ -225,6 +225,8 @@ function readInput(): GenerateRequest {
 }
 
 function queryDecl(name: string, sql: string) {
+  const escaped = sql.replace(/`/g, '\\`');
+
   return factory.createVariableStatement(
     [factory.createToken(SyntaxKind.ExportKeyword)],
     factory.createVariableDeclarationList(
@@ -233,7 +235,7 @@ function queryDecl(name: string, sql: string) {
           factory.createIdentifier(name),
           undefined,
           undefined,
-          factory.createNoSubstitutionTemplateLiteral(sql, sql)
+          factory.createNoSubstitutionTemplateLiteral(escaped, escaped)
         ),
       ],
       NodeFlags.Const //| NodeFlags.Constant | NodeFlags.Constant