feat: add the possibility to override data types in plugin options (#250)

* fix: rename agg query to cnt

* feat: support data type override in plugin options

* fix: update request files and fix Makefile flow

* feat: generate missing tests

* feat: add not null option in type override

* fix: sqlc config files

* fix: sqlc-fluff pre-commit

* fix: sqlc-fluff pre-commit fix

* fix: generated files

* fix: README to include new option

* fix: document override option

Author: SockworkOrange

.github/workflows/build.yml

@@ -126,4 +126,4 @@ jobs:
        - name: Verify pushed codegen requests are synced
          run: |
            dotnet publish LocalRunner -c release --output dist/
-           sqlc -f sqlc.local.yaml diff
+           sqlc -f sqlc.requests.yaml diff

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+- repo: https://github.com/sqlfluff/sqlfluff
+  rev: 3.4.1
+  hooks:
+    - id: sqlfluff-fix
+      args: [--FIX-EVEN-UNPARSABLE]

.sqlfluff

@@ -0,0 +1,17 @@
+[sqlfluff]
+exclude_rules = AM04,AL03,RF02,RF04,AM05,AL01,ST06
+dialect = ansi
+
+[sqlfluff:rules]
+
+[sqlfluff:rules:LT02]
+capitalisation_policy = upper
+
+[sqlfluff:paths:examples/config/postgresql/]
+dialect = postgres
+
+[sqlfluff:paths:examples/config/mysql/]
+dialect = mysql
+
+[sqlfluff:paths:examples/config/sqlite/]
+dialect = sqlite

CodeGenerator/Generators/DataClassesGen.cs

@@ -10,24 +10,24 @@ namespace SqlcGenCsharp.Generators;
 
 internal class DataClassesGen(DbDriver dbDriver)
 {
-    public MemberDeclarationSyntax Generate(string name, ClassMember? classMember, IList<Column> columns, Options options)
+    public MemberDeclarationSyntax Generate(string name, ClassMember? classMember, IList<Column> columns, Options options, Query? query)
     {
         var className = classMember is null ? name : classMember.Value.Name(name);
         if (options.DotnetFramework.IsDotnetCore() && !options.UseDapper)
-            return GenerateAsRecord(className, columns);
-        return GenerateAsCLass(className, columns);
+            return GenerateAsRecord(className, columns, query);
+        return GenerateAsCLass(className, columns, query);
     }
 
-    private MemberDeclarationSyntax GenerateAsRecord(string className, IList<Column> columns)
+    private MemberDeclarationSyntax GenerateAsRecord(string className, IList<Column> columns, Query? query)
     {
         var seenEmbed = new Dictionary<string, int>();
         var recordParameters = columns
-            .Select(column => $"{dbDriver.GetCsharpType(column)} {GetFieldName(column, seenEmbed)}")
+            .Select(column => $"{dbDriver.GetCsharpType(column, query)} {GetFieldName(column, seenEmbed)}")
             .JoinByComma();
         return ParseMemberDeclaration($"public readonly record struct {className} ({recordParameters});")!;
     }
 
-    private ClassDeclarationSyntax GenerateAsCLass(string className, IList<Column> columns)
+    private ClassDeclarationSyntax GenerateAsCLass(string className, IList<Column> columns, Query? query)
     {
         var modernDotnetSupported = dbDriver.Options.DotnetFramework.IsDotnetCore();
         return ClassDeclaration(className)
@@ -40,7 +40,7 @@ MemberDeclarationSyntax[] ColumnsToProperties()
             var seenEmbed = new Dictionary<string, int>();
             return columns.Select(column =>
                 {
-                    var csharpType = dbDriver.GetCsharpType(column);
+                    var csharpType = dbDriver.GetCsharpType(column, query);
                     var optionalRequiredModifier = RequiredModifierNeeded(column) ? "required" : string.Empty;
                     var setterMethod = modernDotnetSupported ? "init" : "set";
                     return ParseMemberDeclaration(
@@ -58,7 +58,7 @@ bool RequiredModifierNeeded(Column column)
                 return false;
             if (column.EmbedTable != null)
                 return true;
-            return column.NotNull;
+            return dbDriver.IsColumnNotNull(column, query);
         }
     }
 

CodeGenerator/Generators/ModelsGen.cs

@@ -46,7 +46,7 @@ private MemberDeclarationSyntax[] GenerateDataClasses(Dictionary<string, Diction
             from schemaTables in tables
             from table in schemaTables.Value
             let className = table.Value.Rel.Name.ToModelName(table.Value.Rel.Schema, dbDriver.DefaultSchema)
-            select DataClassesGen.Generate(className, null, table.Value.Columns, dbDriver.Options)
+            select DataClassesGen.Generate(className, null, table.Value.Columns, dbDriver.Options, null)
         ).ToArray();
     }
 

CodeGenerator/Generators/QueriesGen.cs

@@ -89,14 +89,14 @@ private IEnumerable<MemberDeclarationSyntax> GetMembersForSingleQuery(Query quer
     private MemberDeclarationSyntax? GetQueryColumnsDataclass(Query query)
     {
         if (query.Columns.Count <= 0) return null;
-        return DataClassesGen.Generate(query.Name, ClassMember.Row, query.Columns, dbDriver.Options);
+        return DataClassesGen.Generate(query.Name, ClassMember.Row, query.Columns, dbDriver.Options, query);
     }
 
     private MemberDeclarationSyntax? GetQueryParamsDataclass(Query query)
     {
         if (query.Params.Count <= 0) return null;
-        var columns = query.Params.Select(dbDriver.GetColumnFromParam).ToList();
-        return DataClassesGen.Generate(query.Name, ClassMember.Args, columns, dbDriver.Options);
+        var columns = query.Params.Select(p => dbDriver.GetColumnFromParam(p, query)).ToList();
+        return DataClassesGen.Generate(query.Name, ClassMember.Args, columns, dbDriver.Options, query);
     }
 
     private MemberDeclarationSyntax? GetQueryTextConstant(Query query)

CodegenTests/CodegenTypeOverrideTests.cs

@@ -0,0 +1,44 @@
+using Google.Protobuf;
+using Plugin;
+using SqlcGenCsharp;
+using System.Text;
+using System.Xml;
+
+namespace CodegenTests;
+
+public class CodegenTypeOverrideTests
+{
+    private readonly Settings _postgresSettings = new()
+    {
+        Engine = "postgresql",
+        Codegen = new Codegen { Out = "DummyProject" }
+    };
+
+    private readonly Catalog _emptyCatalog = new()
+    {
+        Schemas =
+        {
+            new Schema
+            {
+                Name = string.Empty,
+                Tables = { Capacity = 0 },
+                Enums = { Capacity = 0 },
+            }
+        }
+    };
+
+    private CodeGenerator CodeGenerator { get; } = new();
+
+    [Test]
+    public void TestOverrideQueryColumnDataType()
+    {
+        var request = new GenerateRequest
+        {
+            Settings = _postgresSettings,
+            Catalog = _emptyCatalog,
+            PluginOptions = ByteString.CopyFrom("{\"overrides\":[{\"column\":\"GetPostgresFunctions:max_integer\",\"csharp_type\":{\"type\":\"int\"}},{\"column\":\"GetPostgresFunctions:max_varchar\",\"csharp_type\":{\"type\":\"string\"}},{\"column\":\"GetPostgresFunctions:max_timestamp\",\"csharp_type\":{\"type\":\"DateTime\"}}]}", Encoding.UTF8)
+        };
+
+        var response = CodeGenerator.Generate(request);
+    }
+}

CodegenTests/test-requests/DefaultSchemaEnum/query.sql

@@ -2,4 +2,4 @@
 SELECT * FROM dummy_table LIMIT 1;
 
 -- name: TestInsert :exec
-INSERT INTO dummy_table (dummy_column) VALUES (?);
+INSERT INTO dummy_table (dummy_column) VALUES (?);

CodegenTests/test-requests/DefaultSchemaEnum/schema.sql

@@ -1,4 +1,4 @@
 CREATE TABLE dummy_table
 (
-    dummy_column ENUM ('x', 'y')
-);
+    dummy_column ENUM('x', 'y')
+);

CodegenTests/test-requests/SchemaScopedEnum/schema.sql

@@ -2,5 +2,5 @@ CREATE SCHEMA dummy_schema;
 
 CREATE TABLE dummy_schema.dummy_table
 (
-    dummy_column ENUM ('x', 'y')
-);
+    dummy_column ENUM('x', 'y')
+);