Skip to content

Commit cd954ce

Browse files
SockworkOrangeSockworkOrange
authored
[release] add :execlastid support for SQLite (#178)
1 parent 475464b commit cd954ce

File tree

17 files changed

+327
-23
lines changed

17 files changed

+327
-23
lines changed

‎Drivers/DbDriver.cs

+19
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,23 @@ protected string GetConnectionStringField()
105105
? Variable.ConnectionString.AsVarName()
106106
: Variable.ConnectionString.AsPropertyName();
107107
}
108+
109+
public string GetIdColumnType()
110+
{
111+
return options.DriverName switch
112+
{
113+
DriverName.Sqlite => "int",
114+
_ => "long"
115+
};
116+
}
117+
118+
public virtual string[] GetLastIdStatement()
119+
{
120+
var convertFunc = GetIdColumnType() == "int" ? "ToInt32" : "ToInt64";
121+
return
122+
[
123+
$"var {Variable.Result.AsVarName()} = await {Variable.Command.AsVarName()}.ExecuteScalarAsync();",
124+
$"return Convert.{convertFunc}({Variable.Result.AsVarName()});"
125+
];
126+
}
108127
}

‎Drivers/Generators/ExecLastIdDeclareGen.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
using Microsoft.CodeAnalysis.CSharp.Syntax;
22
using Plugin;
3+
using System;
34
using System.Collections.Generic;
45
using System.Linq;
56
using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
@@ -14,14 +15,13 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
1415
{
1516
var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
1617
return ParseMemberDeclaration($$"""
17-
public async Task<long> {{query.Name}}({{parametersStr}})
18+
public async Task<{{dbDriver.GetIdColumnType()}}> {{query.Name}}({{parametersStr}})
1819
{
1920
{{GetMethodBody(queryTextConstant, query)}}
2021
}
2122
""")!;
2223
}
2324

24-
2525
private string GetMethodBody(string queryTextConstant, Query query)
2626
{
2727
var (establishConnection, connectionOpen) = dbDriver.EstablishConnection(query);
@@ -34,7 +34,7 @@ string GetAsDapper()
3434
return $$"""
3535
using ({{establishConnection}})
3636
{
37-
return await connection.QuerySingleAsync<long>({{queryTextConstant}}{{args}});
37+
return await connection.QuerySingleAsync<{{dbDriver.GetIdColumnType()}}>({{queryTextConstant}}{{args}});
3838
}
3939
""";
4040
}

‎Drivers/MySqlConnectorDriver.cs

+2-3
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public override string CreateSqlCommand(string sqlTextConstant)
7878
public override string TransformQueryText(Query query)
7979
{
8080
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;
8282
return QueryParamRegex().Replace(queryText, _ => "@" + query.Params[counter++].Column.Name);
8383
}
8484

@@ -98,7 +98,7 @@ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, strin
9898
return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);
9999
}
100100

101-
public string[] GetLastIdStatement()
101+
public override string[] GetLastIdStatement()
102102
{
103103
return
104104
[
@@ -107,7 +107,6 @@ public string[] GetLastIdStatement()
107107
];
108108
}
109109

110-
111110
public override MemberDeclarationSyntax ManyDeclare(string queryTextConstant, string argInterface,
112111
string returnInterface, Query query)
113112
{

‎Drivers/NpgsqlDriver.cs

-9
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,4 @@ public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, strin
159159
{
160160
return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);
161161
}
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-
}
171162
}

‎Drivers/SqliteDriver.cs

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
using Microsoft.CodeAnalysis.CSharp.Syntax;
22
using Plugin;
33
using SqlcGenCsharp.Drivers.Generators;
4+
using System;
45
using System.Collections.Generic;
56
using System.Linq;
67
using System.Text.RegularExpressions;
78
using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
89

910
namespace SqlcGenCsharp.Drivers;
1011

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
1213
{
1314
protected override List<ColumnMapping> ColumnMappings { get; } = [
1415
new("byte[]", ordinal => $"Utils.GetBytes(reader, {ordinal})",
@@ -84,4 +85,9 @@ public MemberDeclarationSyntax ExecRowsDeclare(string queryTextConstant, string
8485
{
8586
return new ExecRowsDeclareGen(this).Generate(queryTextConstant, argInterface, query);
8687
}
88+
89+
public MemberDeclarationSyntax ExecLastIdDeclare(string queryTextConstant, string argInterface, Query query)
90+
{
91+
return new ExecLastIdDeclareGen(this).Generate(queryTextConstant, argInterface, query);
92+
}
8793
}

‎EndToEndTests/SqliteDapperTester.cs

+21-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace SqlcGenCsharpTests;
88

9-
public class SqliteDapperTester : IOneTester, IManyTester, IExecTester, IExecRowsTester
9+
public class SqliteDapperTester : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
1010
{
1111
private QuerySql QuerySql { get; } = new(
1212
Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv)!);
@@ -114,4 +114,24 @@ public async Task TestExecRows()
114114
var affectedRows = await QuerySql.UpdateAuthors(updateAuthorsArgs);
115115
ClassicAssert.AreEqual(2, affectedRows);
116116
}
117+
118+
public async Task TestExecLastId()
119+
{
120+
var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
121+
{
122+
Name = DataGenerator.GenericAuthor,
123+
Bio = DataGenerator.GenericQuote1
124+
};
125+
var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
126+
127+
var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
128+
{
129+
Id = insertedId
130+
});
131+
Assert.That(actual is
132+
{
133+
Name: DataGenerator.GenericAuthor,
134+
Bio: DataGenerator.GenericQuote1
135+
});
136+
}
117137
}

‎EndToEndTests/SqliteTester.cs

+21-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace SqlcGenCsharpTests;
88

9-
public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester
9+
public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
1010
{
1111
private QuerySql QuerySql { get; } = new(
1212
Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv)!);
@@ -115,4 +115,24 @@ public async Task TestExecRows()
115115
var affectedRows = await QuerySql.UpdateAuthors(updateAuthorsArgs);
116116
ClassicAssert.AreEqual(2, affectedRows);
117117
}
118+
119+
public async Task TestExecLastId()
120+
{
121+
var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
122+
{
123+
Name = DataGenerator.GenericAuthor,
124+
Bio = DataGenerator.GenericQuote1
125+
};
126+
var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
127+
128+
var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
129+
{
130+
Id = insertedId
131+
});
132+
Assert.That(actual is
133+
{
134+
Name: DataGenerator.GenericAuthor,
135+
Bio: DataGenerator.GenericQuote1
136+
});
137+
}
118138
}

‎LegacyEndToEndTests/SqliteDapperTester.cs

+30-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace SqlcGenCsharpTests
1010
{
11-
public class SqliteDapperTests : IOneTester, IManyTester, IExecTester, IExecRowsTester
11+
public class SqliteDapperTests : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
1212
{
1313
private QuerySql QuerySql { get; } = new QuerySql(
1414
Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv));
@@ -107,11 +107,40 @@ public async Task TestExecRows()
107107
ClassicAssert.AreEqual(2, affectedRows);
108108
}
109109

110+
[Test]
111+
public async Task TestExecLastId()
112+
{
113+
var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
114+
{
115+
Name = DataGenerator.BojackAuthor,
116+
Bio = DataGenerator.BojackTheme
117+
};
118+
var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
119+
120+
var expected = new QuerySql.GetAuthorByIdRow
121+
{
122+
Id = insertedId,
123+
Name = DataGenerator.BojackAuthor,
124+
Bio = DataGenerator.BojackTheme
125+
};
126+
var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
127+
{
128+
Id = insertedId
129+
});
130+
ClassicAssert.IsNotNull(actual);
131+
Assert.That(Equals(expected, actual));
132+
}
133+
110134
private static bool Equals(QuerySql.GetAuthorRow x, QuerySql.GetAuthorRow y)
111135
{
112136
return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
113137
}
114138

139+
private static bool Equals(QuerySql.GetAuthorByIdRow x, QuerySql.GetAuthorByIdRow y)
140+
{
141+
return x.Id.Equals(y.Id) && x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
142+
}
143+
115144
private static bool Equals(QuerySql.ListAuthorsRow x, QuerySql.ListAuthorsRow y)
116145
{
117146
return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);

‎LegacyEndToEndTests/SqliteTester.cs

+30-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace SqlcGenCsharpTests
1010
{
11-
public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester
11+
public class SqliteTester : IOneTester, IManyTester, IExecTester, IExecRowsTester, IExecLastIdTester
1212
{
1313
private QuerySql QuerySql { get; } = new QuerySql(
1414
Environment.GetEnvironmentVariable(EndToEndCommon.SqliteConnectionStringEnv));
@@ -107,11 +107,40 @@ public async Task TestExecRows()
107107
ClassicAssert.AreEqual(2, affectedRows);
108108
}
109109

110+
[Test]
111+
public async Task TestExecLastId()
112+
{
113+
var bojackCreateAuthorArgs = new QuerySql.CreateAuthorReturnIdArgs
114+
{
115+
Name = DataGenerator.BojackAuthor,
116+
Bio = DataGenerator.BojackTheme
117+
};
118+
var insertedId = await QuerySql.CreateAuthorReturnId(bojackCreateAuthorArgs);
119+
120+
var expected = new QuerySql.GetAuthorByIdRow
121+
{
122+
Id = insertedId,
123+
Name = DataGenerator.BojackAuthor,
124+
Bio = DataGenerator.BojackTheme
125+
};
126+
var actual = await QuerySql.GetAuthorById(new QuerySql.GetAuthorByIdArgs
127+
{
128+
Id = insertedId
129+
});
130+
ClassicAssert.IsNotNull(actual);
131+
Assert.That(Equals(expected, actual));
132+
}
133+
110134
private static bool Equals(QuerySql.GetAuthorRow x, QuerySql.GetAuthorRow y)
111135
{
112136
return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
113137
}
114138

139+
private static bool Equals(QuerySql.GetAuthorByIdRow x, QuerySql.GetAuthorByIdRow y)
140+
{
141+
return x.Id.Equals(y.Id) && x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);
142+
}
143+
115144
private static bool Equals(QuerySql.ListAuthorsRow x, QuerySql.ListAuthorsRow y)
116145
{
117146
return x.Name.Equals(y.Name) && x.Bio.Equals(y.Bio);

‎docs/03_Usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Advanced functionality - varies between databases:
2727
| :many | ✅ | ✅ | ✅ |
2828
| :exec | ✅ | ✅ | ✅ |
2929
| :execrows | ✅ | ✅ | ✅ |
30-
| :execlastid | ✅ | ✅ | ❌ |
30+
| :execlastid | ✅ | ✅ | ✅ |
3131
| :copyfrom | ✅ | ❌ | 🚫 |
3232

3333
- ✅ means the feature is fully supported.

‎examples/NpgsqlExample/QuerySql.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public async Task<long> CreateAuthorReturnId(CreateAuthorReturnIdArgs args)
105105
command.Parameters.AddWithValue("@name", args.Name);
106106
command.Parameters.AddWithValue("@bio", args.Bio!);
107107
var result = await command.ExecuteScalarAsync();
108-
return (long)(result ?? -1);
108+
return Convert.ToInt64(result);
109109
}
110110
}
111111
}

‎examples/NpgsqlLegacyExample/QuerySql.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public async Task<long> CreateAuthorReturnId(CreateAuthorReturnIdArgs args)
145145
command.Parameters.AddWithValue("@name", args.Name);
146146
command.Parameters.AddWithValue("@bio", args.Bio);
147147
var result = await command.ExecuteScalarAsync();
148-
return (long)(result ?? -1);
148+
return Convert.ToInt64(result);
149149
}
150150
}
151151
}

‎examples/SqliteDapperExample/QuerySql.cs

+38
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,44 @@ public async Task CreateAuthor(CreateAuthorArgs args)
6262
}
6363
}
6464

65+
private const string CreateAuthorReturnIdSql = "INSERT INTO authors (name, bio) VALUES (@name, @bio) RETURNING id";
66+
public class CreateAuthorReturnIdRow
67+
{
68+
public int Id { get; set; }
69+
};
70+
public class CreateAuthorReturnIdArgs
71+
{
72+
public string Name { get; set; }
73+
public string? Bio { get; set; }
74+
};
75+
public async Task<int> CreateAuthorReturnId(CreateAuthorReturnIdArgs args)
76+
{
77+
using (var connection = new SqliteConnection(connectionString))
78+
{
79+
return await connection.QuerySingleAsync<int>(CreateAuthorReturnIdSql, new { name = args.Name, bio = args.Bio });
80+
}
81+
}
82+
83+
private const string GetAuthorByIdSql = "SELECT id, name, bio FROM authors WHERE id = @id LIMIT 1";
84+
public class GetAuthorByIdRow
85+
{
86+
public int Id { get; set; }
87+
public string Name { get; set; }
88+
public string? Bio { get; set; }
89+
};
90+
public class GetAuthorByIdArgs
91+
{
92+
public int Id { get; set; }
93+
};
94+
public async Task<GetAuthorByIdRow?> GetAuthorById(GetAuthorByIdArgs args)
95+
{
96+
using (var connection = new SqliteConnection(connectionString))
97+
{
98+
var result = await connection.QueryFirstOrDefaultAsync<GetAuthorByIdRow?>(GetAuthorByIdSql, new { id = args.Id });
99+
return result;
100+
}
101+
}
102+
65103
private const string UpdateAuthorsSql = "UPDATE authors SET bio = @bio WHERE bio IS NOT NULL ";
66104
public class UpdateAuthorsArgs
67105
{

0 commit comments

Comments
 (0)