add execlastid implementation for mysql

sqlc-dev · Feb 17, 2024 · 456b2a5 · 456b2a5
1 parent daaf539
commit 456b2a5
Show file tree

Hide file tree

Showing 5 changed files with 176 additions and 8 deletions.
diff --git a/examples/authors/mysql/query.sql b/examples/authors/mysql/query.sql
@@ -10,7 +10,14 @@ ORDER BY name;
 INSERT INTO authors (
   name, bio
 ) VALUES (
-  ?, ? 
+  ?, ?
+);
+
+/* name: CreateAuthorReturnId :execlastid */
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ?
 );
 
 /* name: DeleteAuthor :exec */
@@ -19,4 +26,4 @@ WHERE id = ?;
 
 /* name: Test :one */
 SELECT * FROM node_mysql_types
-LIMIT 1;
+LIMIT 1;
diff --git a/examples/bun-mysql2/src/db/query_sql.ts b/examples/bun-mysql2/src/db/query_sql.ts
@@ -1,4 +1,4 @@
-import mysql, { RowDataPacket } from "mysql2/promise";
+import mysql, { RowDataPacket, ResultSetHeader } from "mysql2/promise";
 
 type Client = mysql.Connection | mysql.Pool;
 
@@ -62,7 +62,7 @@ export const createAuthorQuery = `-- name: CreateAuthor :exec
 INSERT INTO authors (
   name, bio
 ) VALUES (
-  ?, ? 
+  ?, ?
 )`;
 
 export interface CreateAuthorArgs {
@@ -77,6 +77,26 @@ export async function createAuthor(client: Client, args: CreateAuthorArgs): Prom
     });
 }
 
+export const createAuthorReturnIdQuery = `-- name: CreateAuthorReturnId :execlastid
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ?
+)`;
+
+export interface CreateAuthorReturnIdArgs {
+    name: string;
+    bio: string | null;
+}
+
+export async function createAuthorReturnId(client: Client, args: CreateAuthorReturnIdArgs): Promise<number> {
+    const [result] = await client.query<ResultSetHeader>({
+        sql: createAuthorReturnIdQuery,
+        values: [args.name, args.bio]
+    });
+    return result?.insertId ?? 0;
+}
+
 export const deleteAuthorQuery = `-- name: DeleteAuthor :exec
 DELETE FROM authors
 WHERE id = ?`;

diff --git a/examples/node-mysql2/src/db/query_sql.ts b/examples/node-mysql2/src/db/query_sql.ts
@@ -1,4 +1,4 @@
-import mysql, { RowDataPacket } from "mysql2/promise";
+import mysql, { RowDataPacket, ResultSetHeader } from "mysql2/promise";
 
 type Client = mysql.Connection | mysql.Pool;
 
@@ -62,7 +62,7 @@ export const createAuthorQuery = `-- name: CreateAuthor :exec
 INSERT INTO authors (
   name, bio
 ) VALUES (
-  ?, ? 
+  ?, ?
 )`;
 
 export interface CreateAuthorArgs {
@@ -77,6 +77,26 @@ export async function createAuthor(client: Client, args: CreateAuthorArgs): Prom
     });
 }
 
+export const createAuthorReturnIdQuery = `-- name: CreateAuthorReturnId :execlastid
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ?
+)`;
+
+export interface CreateAuthorReturnIdArgs {
+    name: string;
+    bio: string | null;
+}
+
+export async function createAuthorReturnId(client: Client, args: CreateAuthorReturnIdArgs): Promise<number> {
+    const [result] = await client.query<ResultSetHeader>({
+        sql: createAuthorReturnIdQuery,
+        values: [args.name, args.bio]
+    });
+    return result?.insertId ?? 0;
+}
+
 export const deleteAuthorQuery = `-- name: DeleteAuthor :exec
 DELETE FROM authors
 WHERE id = ?`;

diff --git a/src/app.ts b/src/app.ts
@@ -53,6 +53,12 @@ interface Driver {
     iface: string | undefined,
     params: Parameter[]
   ) => Node;
+  execlastidDecl: (
+    name: string,
+    text: string,
+    iface: string | undefined,
+    params: Parameter[]
+  ) => Node;
   manyDecl: (
     name: string,
     text: string,
@@ -77,10 +83,10 @@ function createNodeGenerator(driver?: string): Driver {
       return mysql2;
     }
     case "pg": {
-      return pg;
+      return pg as any;
     }
     case "postgres": {
-      return postgres;
+      return postgres as any;
     }
   }
   throw new Error(`unknown driver: ${driver}`);
@@ -156,6 +162,12 @@ ${query.text}`
           );
           break;
         }
+        case ":execlastid": {
+          nodes.push(
+            driver.execlastidDecl(lowerName, textName, argIface, query.params)
+          )
+          break;
+        }
         case ":one": {
           nodes.push(
             driver.oneDecl(

diff --git a/src/drivers/mysql2.ts b/src/drivers/mysql2.ts
@@ -178,6 +178,11 @@ export function preamble(queries: unknown) {
             undefined,
             factory.createIdentifier("RowDataPacket")
           ),
+          factory.createImportSpecifier(
+            false,
+            undefined,
+            factory.createIdentifier("ResultSetHeader")
+          ),
         ])
       ),
       factory.createStringLiteral("mysql2/promise"),
@@ -611,10 +616,114 @@ export function oneDecl(
   );
 }
 
+export function execlastidDecl(
+  funcName: string,
+  queryName: string,
+  argIface: string | undefined,
+  params: Parameter[]
+) {
+  const funcParams = funcParamsDecl(argIface, params);
+
+  return factory.createFunctionDeclaration(
+    [
+      factory.createToken(SyntaxKind.ExportKeyword),
+      factory.createToken(SyntaxKind.AsyncKeyword),
+    ],
+    undefined,
+    factory.createIdentifier(funcName),
+    undefined,
+    funcParams,
+    factory.createTypeReferenceNode(factory.createIdentifier("Promise"), [
+      factory.createTypeReferenceNode('number', undefined),
+    ]),
+    factory.createBlock(
+      [
+        factory.createVariableStatement(
+          undefined,
+          factory.createVariableDeclarationList(
+            [
+              factory.createVariableDeclaration(
+                factory.createArrayBindingPattern([
+                  factory.createBindingElement(
+                    undefined,
+                    undefined,
+                    factory.createIdentifier("result"),
+                    undefined
+                  ),
+                ]),
+                undefined,
+                undefined,
+                factory.createAwaitExpression(
+                  factory.createCallExpression(
+                    factory.createPropertyAccessExpression(
+                      factory.createIdentifier("client"),
+                      factory.createIdentifier("query")
+                    ),
+                    [
+                      factory.createTypeReferenceNode(
+                        factory.createIdentifier("ResultSetHeader"),
+                        undefined
+                      )
+                    ],
+                    [
+                      factory.createObjectLiteralExpression(
+                        [
+                          factory.createPropertyAssignment(
+                            factory.createIdentifier("sql"),
+                            factory.createIdentifier(queryName)
+                          ),
+                          factory.createPropertyAssignment(
+                            factory.createIdentifier("values"),
+                            factory.createArrayLiteralExpression(
+                              params.map((param, i) =>
+                                factory.createPropertyAccessExpression(
+                                  factory.createIdentifier("args"),
+                                  factory.createIdentifier(
+                                    argName(i, param.column)
+                                  )
+                                )
+                              ),
+                              false
+                            )
+                          ),
+                        ],
+                        true
+                      ),
+                    ]
+                  )
+                )
+              )
+            ],
+            NodeFlags.Const |
+              // NodeFlags.Constant |
+              NodeFlags.AwaitContext |
+              // NodeFlags.Constant |
+              NodeFlags.ContextFlags |
+              NodeFlags.TypeExcludesFlags
+          )
+        ),
+        factory.createReturnStatement(
+          factory.createBinaryExpression(
+            factory.createPropertyAccessChain(
+              factory.createIdentifier("result"),
+              factory.createToken(SyntaxKind.QuestionDotToken),
+              factory.createIdentifier("insertId")
+            ),
+            factory.createToken(SyntaxKind.QuestionQuestionToken),
+            factory.createNumericLiteral(0)
+          )
+        ),
+      ],
+      true
+    )
+  )
+}
+
 export default {
   columnType,
   preamble,
   execDecl,
   manyDecl,
   oneDecl,
+  execlastidDecl,
 };