[release] add :execlastid support for SQLite (#178)

SockworkOrange · web-flow · commit cd954ce9e145 · 2025-01-06T13:45:34.000+01:00
diff --git a/Drivers/DbDriver.cs b/Drivers/DbDriver.cs
@@ -105,4 +105,23 @@ protected string GetConnectionStringField()
             ? Variable.ConnectionString.AsVarName()
             : Variable.ConnectionString.AsPropertyName();
     }
+
+    public string GetIdColumnType()
+    {
+        return options.DriverName switch
+        {
+            DriverName.Sqlite => "int",
+            _ => "long"
+        };
+    }
+
+    public virtual string[] GetLastIdStatement()
+    {
+        var convertFunc = GetIdColumnType() == "int" ? "ToInt32" : "ToInt64";
+        return
+        [
+            $"var {Variable.Result.AsVarName()} = await {Variable.Command.AsVarName()}.ExecuteScalarAsync();",
+            $"return Convert.{convertFunc}({Variable.Result.AsVarName()});"
+        ];
+    }
 }
diff --git a/Drivers/Generators/ExecLastIdDeclareGen.cs b/Drivers/Generators/ExecLastIdDeclareGen.cs
@@ -1,5 +1,6 @@
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Plugin;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
@@ -14,14 +15,13 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
     {
         var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
         return ParseMemberDeclaration($$"""
-                                        public async Task<long> {{query.Name}}({{parametersStr}})
+                                        public async Task<{{dbDriver.GetIdColumnType()}}> {{query.Name}}({{parametersStr}})
                                         {
                                             {{GetMethodBody(queryTextConstant, query)}}
                                         }
                                         """)!;
     }
 
-
     private string GetMethodBody(string queryTextConstant, Query query)
     {
         var (establishConnection, connectionOpen) = dbDriver.EstablishConnection(query);
@@ -34,7 +34,7 @@ string GetAsDapper()
             return $$"""
                      using ({{establishConnection}})
                      {
-                        return await connection.QuerySingleAsync<long>({{queryTextConstant}}{{args}});
+                        return await connection.QuerySingleAsync<{{dbDriver.GetIdColumnType()}}>({{queryTextConstant}}{{args}});
                      }
                      """;
         }
diff --git a/Drivers/MySqlConnectorDriver.cs b/Drivers/MySqlConnectorDriver.cs
@@ -78,7 +78,7 @@ public override string CreateSqlCommand(string sqlTextConstant)
     public override string TransformQueryText(Query query)
     {
         var counter = 0;
-        var queryText = options.UseDapper ? $"{query.Text}; SELECT LAST_INSERT_ID()" : query.Text;
+        var queryText = Options.UseDapper ? $"{query.Text}; SELECT LAST_INSERT_ID()" : query.Text;
         return QueryParamRegex().Replace(queryText, _ => "@" + query.Params[counter++].Column.Name);
     }
 
@@ -98,7 +98,7 @@ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, strin
         return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);
     }
 
-    public string[] GetLastIdStatement()
+    public override string[] GetLastIdStatement()
     {
         return
         [
@@ -107,7 +107,6 @@ public string[] GetLastIdStatement()
         ];
     }
 
-
     public override MemberDeclarationSyntax ManyDeclare(string queryTextConstant, string argInterface,
         string returnInterface, Query query)
     {
diff --git a/Drivers/NpgsqlDriver.cs b/Drivers/NpgsqlDriver.cs
@@ -159,13 +159,4 @@ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, strin
     {
         return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);
     }
-
-    public string[] GetLastIdStatement()
-    {
-        return
-        [
-            $"var {Variable.Result.AsVarName()} = await {Variable.Command.AsVarName()}.ExecuteScalarAsync();",
-            $"return (long)({Variable.Result.AsVarName()} ?? -1);"
-        ];
-    }
 }
diff --git a/Drivers/SqliteDriver.cs b/Drivers/SqliteDriver.cs
@@ -1,14 +1,15 @@
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Plugin;
 using SqlcGenCsharp.Drivers.Generators;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
 
 namespace SqlcGenCsharp.Drivers;
 
-public partial class SqliteDriver(Options options) : DbDriver(options), IOne, IMany, IExec, IExecRows
+public partial class SqliteDriver(Options options) : DbDriver(options), IOne, IMany, IExec, IExecRows, IExecLastId
 {
     protected override List<ColumnMapping> ColumnMappings { get; } = [
         new("byte[]", ordinal => $"Utils.GetBytes(reader, {ordinal})",
@@ -84,4 +85,9 @@ public MemberDeclarationSyntax ExecRowsDeclare(string queryTextConstant, string
     {
         return new ExecRowsDeclareGen(this).Generate(queryTextConstant, argInterface, query);
     }
+
+    public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, string argInterface, Query query)
+    {
+        return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);
+    }
 }
diff --git a/EndToEndTests/SqliteDapperTester.cs b/EndToEndTests/SqliteDapperTester.cs
@@ -6,7 +6,7 @@
 
 namespace SqlcGenCsharpTests;
 
-public class SqliteDapperTester : IOneTester, IManyTester, IExecTester, IExecRowsTester
+public class SqliteDapperTester : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
 {
     private QuerySql QuerySql { get; } = new(
         Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv)!);
@@ -114,4 +114,24 @@ public async Task TestExecRows()
         var affectedRows = await QuerySql.UpdateAuthors(updateAuthorsArgs);
         ClassicAssert.AreEqual(2, affectedRows);
     }
+
+    public async Task TestExecLastId()
+    {
+        var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
+        {
+            Name = DataGenerator.GenericAuthor,
+            Bio = DataGenerator.GenericQuote1
+        };
+        var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
+
+        var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
+        {
+            Id = insertedId
+        });
+        Assert.That(actual is
+        {
+            Name: DataGenerator.GenericAuthor,
+            Bio: DataGenerator.GenericQuote1
+        });
+    }
 }
diff --git a/EndToEndTests/SqliteTester.cs b/EndToEndTests/SqliteTester.cs
@@ -6,7 +6,7 @@
 
 namespace SqlcGenCsharpTests;
 
-public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester
+public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
 {
     private QuerySql QuerySql { get; } = new(
         Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv)!);
@@ -115,4 +115,24 @@ public async Task TestExecRows()
         var affectedRows = await QuerySql.UpdateAuthors(updateAuthorsArgs);
         ClassicAssert.AreEqual(2, affectedRows);
     }
+
+    public async Task TestExecLastId()
+    {
+        var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
+        {
+            Name = DataGenerator.GenericAuthor,
+            Bio = DataGenerator.GenericQuote1
+        };
+        var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
+
+        var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
+        {
+            Id = insertedId
+        });
+        Assert.That(actual is
+        {
+            Name: DataGenerator.GenericAuthor,
+            Bio: DataGenerator.GenericQuote1
+        });
+    }
 }
diff --git a/LegacyEndToEndTests/SqliteDapperTester.cs b/LegacyEndToEndTests/SqliteDapperTester.cs
@@ -8,7 +8,7 @@
 
 namespace SqlcGenCsharpTests
 {
-    public class SqliteDapperTests : IOneTester, IManyTester, IExecTester, IExecRowsTester
+    public class SqliteDapperTests : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
     {
         private QuerySql QuerySql { get; } = new QuerySql(
             Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv));
@@ -107,11 +107,40 @@ public async Task TestExecRows()
             ClassicAssert.AreEqual(2, affectedRows);
         }
 
+        [Test]
+        public async Task TestExecLastId()
+        {
+            var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
+            {
+                Name = DataGenerator.BojackAuthor,
+                Bio = DataGenerator.BojackTheme
+            };
+            var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
+
+            var expected = new QuerySql.GetAuthorByIdRow
+            {
+                Id = insertedId,
+                Name = DataGenerator.BojackAuthor,
+                Bio = DataGenerator.BojackTheme
+            };
+            var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
+            {
+                Id = insertedId
+            });
+            ClassicAssert.IsNotNull(actual);
+            Assert.That(Equals(expected, actual));
+        }
+
         private static bool Equals(QuerySql.GetAuthorRow x, QuerySql.GetAuthorRow y)
         {
             return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
         }
 
+        private static bool Equals(QuerySql.GetAuthorByIdRow x, QuerySql.GetAuthorByIdRow y)
+        {
+            return x.Id.Equals(y.Id) && x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
+        }
+
         private static bool Equals(QuerySql.ListAuthorsRow x, QuerySql.ListAuthorsRow y)
         {
             return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
diff --git a/LegacyEndToEndTests/SqliteTester.cs b/LegacyEndToEndTests/SqliteTester.cs
@@ -8,7 +8,7 @@
 
 namespace SqlcGenCsharpTests
 {
-    public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester
+    public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
     {
         private QuerySql QuerySql { get; } = new QuerySql(
             Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv));
@@ -107,11 +107,40 @@ public async Task TestExecRows()
             ClassicAssert.AreEqual(2, affectedRows);
         }
 
+        [Test]
+        public async Task TestExecLastId()
+        {
+            var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
+            {
+                Name = DataGenerator.BojackAuthor,
+                Bio = DataGenerator.BojackTheme
+            };
+            var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
+
+            var expected = new QuerySql.GetAuthorByIdRow
+            {
+                Id = insertedId,
+                Name = DataGenerator.BojackAuthor,
+                Bio = DataGenerator.BojackTheme
+            };
+            var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
+            {
+                Id = insertedId
+            });
+            ClassicAssert.IsNotNull(actual);
+            Assert.That(Equals(expected, actual));
+        }
+
         private static bool Equals(QuerySql.GetAuthorRow x, QuerySql.GetAuthorRow y)
         {
             return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
         }
 
+        private static bool Equals(QuerySql.GetAuthorByIdRow x, QuerySql.GetAuthorByIdRow y)
+        {
+            return x.Id.Equals(y.Id) && x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
+        }
+
         private static bool Equals(QuerySql.ListAuthorsRow x, QuerySql.ListAuthorsRow y)
         {
             return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
diff --git a/docs/03_Usage.md b/docs/03_Usage.md
@@ -27,7 +27,7 @@ Advanced functionality - varies between databases:
 | :many       | ✅          | ✅    | ✅     |
 | :exec       | ✅          | ✅    | ✅     |
 | :execrows   | ✅          | ✅    | ✅     |
-| :execlastid | ✅          | ✅    | ❌     |
+| :execlastid | ✅          | ✅    | ✅     |
 | :copyfrom   | ✅          | ❌    | 🚫     |
 
 - ✅ means the feature is fully supported.
diff --git a/examples/NpgsqlExample/QuerySql.cs b/examples/NpgsqlExample/QuerySql.cs
@@ -105,7 +105,7 @@ public async Task<long> CreateAuthorReturnId(CreateAuthorReturnIdArgs args)
                 command.Parameters.AddWithValue("@name", args.Name);
                 command.Parameters.AddWithValue("@bio", args.Bio!);
                 var result = await command.ExecuteScalarAsync();
-                return (long)(result ?? -1);
+                return Convert.ToInt64(result);
             }
         }
     }
diff --git a/examples/NpgsqlLegacyExample/QuerySql.cs b/examples/NpgsqlLegacyExample/QuerySql.cs
@@ -145,7 +145,7 @@ public async Task<long> CreateAuthorReturnId(CreateAuthorReturnIdArgs args)
                     command.Parameters.AddWithValue("@name", args.Name);
                     command.Parameters.AddWithValue("@bio", args.Bio);
                     var result = await command.ExecuteScalarAsync();
-                    return (long)(result ?? -1);
+                    return Convert.ToInt64(result);
                 }
             }
         }
diff --git a/examples/SqliteDapperExample/QuerySql.cs b/examples/SqliteDapperExample/QuerySql.cs
@@ -62,6 +62,44 @@ public async Task CreateAuthor(CreateAuthorArgs args)
         }
     }
 
+    private const string CreateAuthorReturnIdSql = "INSERT INTO authors (name, bio) VALUES (@name, @bio) RETURNING id";
+    public class CreateAuthorReturnIdRow
+    {
+        public int Id { get; set; }
+    };
+    public class CreateAuthorReturnIdArgs
+    {
+        public string Name { get; set; }
+        public string? Bio { get; set; }
+    };
+    public async Task<int> CreateAuthorReturnId(CreateAuthorReturnIdArgs args)
+    {
+        using (var connection = new SqliteConnection(connectionString))
+        {
+            return await connection.QuerySingleAsync<int>(CreateAuthorReturnIdSql, new { name = args.Name, bio = args.Bio });
+        }
+    }
+
+    private const string GetAuthorByIdSql = "SELECT id, name, bio FROM authors WHERE id = @id LIMIT 1";
+    public class GetAuthorByIdRow
+    {
+        public int Id { get; set; }
+        public string Name { get; set; }
+        public string? Bio { get; set; }
+    };
+    public class GetAuthorByIdArgs
+    {
+        public int Id { get; set; }
+    };
+    public async Task<GetAuthorByIdRow?> GetAuthorById(GetAuthorByIdArgs args)
+    {
+        using (var connection = new SqliteConnection(connectionString))
+        {
+            var result = await connection.QueryFirstOrDefaultAsync<GetAuthorByIdRow?>(GetAuthorByIdSql, new { id = args.Id });
+            return result;
+        }
+    }
+
     private const string UpdateAuthorsSql = "UPDATE authors  SET  bio  =  @bio  WHERE  bio  IS  NOT  NULL  ";  
     public class UpdateAuthorsArgs
     {
diff --git a/examples/SqliteDapperLegacyExample/QuerySql.cs b/examples/SqliteDapperLegacyExample/QuerySql.cs
diff --git a/examples/SqliteExample/QuerySql.cs b/examples/SqliteExample/QuerySql.cs
diff --git a/examples/SqliteLegacyExample/QuerySql.cs b/examples/SqliteLegacyExample/QuerySql.cs
diff --git a/examples/config/sqlite/query.sql b/examples/config/sqlite/query.sql

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using Microsoft.CodeAnalysis.CSharp.Syntax;`
`2`	`2`	`using Plugin;`
	`3`	`+using System;`
`3`	`4`	`using System.Collections.Generic;`
`4`	`5`	`using System.Linq;`
`5`	`6`	`using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;`
`@@ -14,14 +15,13 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte`
`14`	`15`	`{`
`15`	`16`	`var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);`
`16`	`17`	`return ParseMemberDeclaration($$"""`
`17`		`- public async Task<long> {{query.Name}}({{parametersStr}})`
	`18`	`+ public async Task<{{dbDriver.GetIdColumnType()}}> {{query.Name}}({{parametersStr}})`
`18`	`19`	`{`
`19`	`20`	`{{GetMethodBody(queryTextConstant, query)}}`
`20`	`21`	`}`
`21`	`22`	`""")!;`
`22`	`23`	`}`
`23`	`24`
`24`		`-`
`25`	`25`	`private string GetMethodBody(string queryTextConstant, Query query)`
`26`	`26`	`{`
`27`	`27`	`var (establishConnection, connectionOpen) = dbDriver.EstablishConnection(query);`
`@@ -34,7 +34,7 @@ string GetAsDapper()`
`34`	`34`	`return $$"""`
`35`	`35`	`using ({{establishConnection}})`
`36`	`36`	`{`
`37`		`- return await connection.QuerySingleAsync<long>({{queryTextConstant}}{{args}});`
	`37`	`+ return await connection.QuerySingleAsync<{{dbDriver.GetIdColumnType()}}>({{queryTextConstant}}{{args}});`
`38`	`38`	`}`
`39`	`39`	`""";`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public override string CreateSqlCommand(string sqlTextConstant)`
`78`	`78`	`public override string TransformQueryText(Query query)`
`79`	`79`	`{`
`80`	`80`	`var counter = 0;`
`81`		`- var queryText = options.UseDapper ? $"{query.Text}; SELECT LAST_INSERT_ID()" : query.Text;`
	`81`	`+ var queryText = Options.UseDapper ? $"{query.Text}; SELECT LAST_INSERT_ID()" : query.Text;`
`82`	`82`	`return QueryParamRegex().Replace(queryText, _ => "@" + query.Params[counter++].Column.Name);`
`83`	`83`	`}`
`84`	`84`
`@@ -98,7 +98,7 @@ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, strin`
`98`	`98`	`return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);`
`99`	`99`	`}`
`100`	`100`
`101`		`- public string[] GetLastIdStatement()`
	`101`	`+ public override string[] GetLastIdStatement()`
`102`	`102`	`{`
`103`	`103`	`return`
`104`	`104`	`[`
`@@ -107,7 +107,6 @@ public string[] GetLastIdStatement()`
`107`	`107`	`];`
`108`	`108`	`}`
`109`	`109`
`110`		`-`
`111`	`110`	`public override MemberDeclarationSyntax ManyDeclare(string queryTextConstant, string argInterface,`
`112`	`111`	`string returnInterface, Query query)`
`113`	`112`	`{`
Original file line number	Diff line number	Diff line change
`@@ -159,13 +159,4 @@ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, strin`
`159`	`159`	`{`
`160`	`160`	`return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);`
`161`	`161`	`}`
`162`		`-`
`163`		`- public string[] GetLastIdStatement()`
`164`		`- {`
`165`		`- return`
`166`		`- [`
`167`		`- $"var {Variable.Result.AsVarName()} = await {Variable.Command.AsVarName()}.ExecuteScalarAsync();",`
`168`		`- $"return (long)({Variable.Result.AsVarName()} ?? -1);"`
`169`		`- ];`
`170`		`- }`
`171`	`162`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,15 @@`
`1`	`1`	`using Microsoft.CodeAnalysis.CSharp.Syntax;`
`2`	`2`	`using Plugin;`
`3`	`3`	`using SqlcGenCsharp.Drivers.Generators;`
	`4`	`+using System;`
`4`	`5`	`using System.Collections.Generic;`
`5`	`6`	`using System.Linq;`
`6`	`7`	`using System.Text.RegularExpressions;`
`7`	`8`	`using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;`
`8`	`9`
`9`	`10`	`namespace SqlcGenCsharp.Drivers;`
`10`	`11`
`11`		`-public partial class SqliteDriver(Options options) : DbDriver(options), IOne, IMany, IExec, IExecRows`
	`12`	`+public partial class SqliteDriver(Options options) : DbDriver(options), IOne, IMany, IExec, IExecRows, IExecLastId`
`12`	`13`	`{`
`13`	`14`	`protected override List<ColumnMapping> ColumnMappings { get; } = [`
`14`	`15`	`new("byte[]", ordinal => $"Utils.GetBytes(reader, {ordinal})",`
`@@ -84,4 +85,9 @@ public MemberDeclarationSyntax ExecRowsDeclare(string queryTextConstant, string`
`84`	`85`	`{`
`85`	`86`	`return new ExecRowsDeclareGen(this).Generate(queryTextConstant, argInterface, query);`
`86`	`87`	`}`
	`88`	`+`
	`89`	`+ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, string argInterface, Query query)`
	`90`	`+ {`
	`91`	`+ return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);`
	`92`	`+ }`
`87`	`93`	`}`