Groundwork for code generation for queries

stephenafamo · stephenafamo · commit b4b263cf7c72 · 2024-12-15T12:50:12.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added a new field `QueryFolders` to `gen/drivers.DBInfo` for drivers to be able to include information about parsed queries.
+- Added `gen/QueriesTemplates` which in the future will contain base templates for generating code for parsed qureries.
+- Added a `QueryTemplate` field to `bobgen_helpers.Templates` for drivers to include additional templates for queries.
+- Added a new reserved output key `queries`. This is handled specially for each query folder supplied by the driver.
+
 ### Changed
 
 - Updated error constant generation to employ specific error types for making error matching easier. (thanks @mbezhanov)
diff --git a/gen/bobgen-helpers/helpers.go b/gen/bobgen-helpers/helpers.go
@@ -35,6 +35,7 @@ func Version() string {
 type Templates struct {
 	Models  []fs.FS
 	Factory []fs.FS
+	Queries []fs.FS
 }
 
 func DefaultOutputs(destination, pkgname string, noFactory bool, templates *Templates) []*gen.Output {
@@ -57,6 +58,10 @@ func DefaultOutputs(destination, pkgname string, noFactory bool, templates *Temp
 			PkgName:   pkgname,
 			Templates: append(templates.Models, gen.ModelTemplates),
 		},
+		{
+			Key:       "queries",
+			Templates: append(templates.Queries, gen.QueriesTemplates),
+		},
 	}
 
 	if !noFactory {
diff --git a/gen/bobgen-mysql/driver/exclude-tables.golden.json b/gen/bobgen-mysql/driver/exclude-tables.golden.json
@@ -2339,6 +2339,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "TypeMonstersEnumNullable",
diff --git a/gen/bobgen-mysql/driver/include-exclude-tables-mixed.golden.json b/gen/bobgen-mysql/driver/include-exclude-tables-mixed.golden.json
@@ -119,6 +119,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "github.com/go-sql-driver/mysql"
diff --git a/gen/bobgen-mysql/driver/include-exclude-tables-regex.golden.json b/gen/bobgen-mysql/driver/include-exclude-tables-regex.golden.json
@@ -119,6 +119,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "github.com/go-sql-driver/mysql"
diff --git a/gen/bobgen-mysql/driver/include-exclude-tables.golden.json b/gen/bobgen-mysql/driver/include-exclude-tables.golden.json
@@ -60,6 +60,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "github.com/go-sql-driver/mysql"
diff --git a/gen/bobgen-mysql/driver/include-tables.golden.json b/gen/bobgen-mysql/driver/include-tables.golden.json
@@ -119,6 +119,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "github.com/go-sql-driver/mysql"
diff --git a/gen/bobgen-mysql/driver/mysql.golden.json b/gen/bobgen-mysql/driver/mysql.golden.json
@@ -2490,6 +2490,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "TypeMonstersEnumNullable",
diff --git a/gen/bobgen-psql/driver/exclude-tables.golden.json b/gen/bobgen-psql/driver/exclude-tables.golden.json
@@ -4578,6 +4578,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "UnicodeEnum",
diff --git a/gen/bobgen-psql/driver/include-exclude-tables-mixed.golden.json b/gen/bobgen-psql/driver/include-exclude-tables-mixed.golden.json
@@ -133,6 +133,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "UnicodeEnum",
diff --git a/gen/bobgen-psql/driver/include-exclude-tables-regex.golden.json b/gen/bobgen-psql/driver/include-exclude-tables-regex.golden.json
@@ -133,6 +133,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "UnicodeEnum",
diff --git a/gen/bobgen-psql/driver/include-exclude-tables.golden.json b/gen/bobgen-psql/driver/include-exclude-tables.golden.json
@@ -67,6 +67,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "UnicodeEnum",
diff --git a/gen/bobgen-psql/driver/include-tables.golden.json b/gen/bobgen-psql/driver/include-tables.golden.json
@@ -133,6 +133,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "UnicodeEnum",
diff --git a/gen/bobgen-psql/driver/psql.golden.json b/gen/bobgen-psql/driver/psql.golden.json
@@ -4743,6 +4743,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": [
 		{
 			"Type": "UnicodeEnum",
diff --git a/gen/bobgen-sqlite/driver/exclude-tables.golden.json b/gen/bobgen-sqlite/driver/exclude-tables.golden.json
@@ -3093,6 +3093,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "modernc.org/sqlite"
diff --git a/gen/bobgen-sqlite/driver/include-exclude-tables-mixed.golden.json b/gen/bobgen-sqlite/driver/include-exclude-tables-mixed.golden.json
@@ -245,6 +245,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "modernc.org/sqlite"
diff --git a/gen/bobgen-sqlite/driver/include-exclude-tables-regex.golden.json b/gen/bobgen-sqlite/driver/include-exclude-tables-regex.golden.json
@@ -245,6 +245,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "modernc.org/sqlite"
diff --git a/gen/bobgen-sqlite/driver/include-exclude-tables.golden.json b/gen/bobgen-sqlite/driver/include-exclude-tables.golden.json
@@ -123,6 +123,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "modernc.org/sqlite"
diff --git a/gen/bobgen-sqlite/driver/include-tables.golden.json b/gen/bobgen-sqlite/driver/include-tables.golden.json
@@ -245,6 +245,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "modernc.org/sqlite"
diff --git a/gen/bobgen-sqlite/driver/sqlite.golden.json b/gen/bobgen-sqlite/driver/sqlite.golden.json
@@ -3403,6 +3403,7 @@
 			"comment": ""
 		}
 	],
+	"query_folders": null,
 	"enums": null,
 	"extra_info": null,
 	"driver_name": "modernc.org/sqlite"
diff --git a/gen/drivers/interface.go b/gen/drivers/interface.go
@@ -54,9 +54,10 @@ type Types map[string]Type
 
 // DBInfo is the database's table data and dialect.
 type DBInfo[DBExtra, ConstraintExtra, IndexExtra any] struct {
-	Tables    []Table[ConstraintExtra, IndexExtra] `json:"tables"`
-	Enums     []Enum                               `json:"enums"`
-	ExtraInfo DBExtra                              `json:"extra_info"`
+	Tables       Tables[ConstraintExtra, IndexExtra] `json:"tables"`
+	QueryFolders []QueryFolder                       `json:"query_folders"`
+	Enums        []Enum                              `json:"enums"`
+	ExtraInfo    DBExtra                             `json:"extra_info"`
 	// DriverName is the module name of the underlying `database/sql` driver
 	DriverName string `json:"driver_name"`
 }
diff --git a/gen/drivers/query.go b/gen/drivers/query.go
@@ -0,0 +1,53 @@
+package drivers
+
+type QueryFolder struct {
+	Path  string
+	Files []QueryFile
+}
+
+type QueryFile struct {
+	Path    string
+	Queries []Query
+}
+
+type Query struct {
+	Name        string `yaml:"name"`
+	SQL         string `yaml:"raw"`
+	RowName     string `yaml:"row_name"`
+	GenerateRow bool   `yaml:"generate_row"`
+
+	Columns []QueryArg `yaml:"columns"`
+	Args    []QueryArg `yaml:"args"`
+}
+
+type QueryArg struct {
+	Name     string `yaml:"name"`
+	Nullable bool   `yaml:"nullable"`
+	TypeName string `yaml:"type"`
+	Refs     []Ref  `yaml:"refs"`
+}
+
+type Ref struct {
+	Key    string `yaml:"key"`
+	Column string `yaml:"column"`
+}
+
+type db interface {
+	GetColumn(key string, col string) Column
+}
+
+func (c QueryArg) Type(db db) string {
+	if len(c.Refs) == 0 {
+		return c.TypeName
+	}
+
+	ref := db.GetColumn(c.Refs[0].Key, c.Refs[0].Column).Type
+
+	for _, r := range c.Refs[1:] {
+		if ref != db.GetColumn(r.Key, r.Column).Type {
+			return c.TypeName
+		}
+	}
+
+	return ref
+}
diff --git a/gen/gen.go b/gen/gen.go
@@ -120,6 +120,7 @@ func Run[T, C, I any](ctx context.Context, s *State[C], driver drivers.Interface
 	data := &TemplateData[T, C, I]{
 		Dialect:           driver.Dialect(),
 		Tables:            dbInfo.Tables,
+		QueryFolders:      dbInfo.QueryFolders,
 		Enums:             dbInfo.Enums,
 		ExtraInfo:         dbInfo.ExtraInfo,
 		Aliases:           s.Config.Aliases,
@@ -162,17 +163,14 @@ func generate[T, C, I any](s *State[C], data *TemplateData[T, C, I], goVersion s
 	templateHeaderByteBuffer := &bytes.Buffer{}
 
 	for _, o := range s.Outputs {
-		if len(o.Templates) == 0 {
-			continue
-		}
-
 		if _, ok := knownKeys[o.Key]; ok {
 			return fmt.Errorf("Duplicate output key: %q", o.Key)
 		}
 		knownKeys[o.Key] = struct{}{}
 
-		// set the package name for this output
-		data.PkgName = o.PkgName
+		if len(o.Templates) == 0 {
+			continue
+		}
 
 		if err := o.initTemplates(s.CustomTemplateFuncs); err != nil {
 			return fmt.Errorf("unable to initialize templates: %w", err)
@@ -182,26 +180,66 @@ func generate[T, C, I any](s *State[C], data *TemplateData[T, C, I], goVersion s
 			continue
 		}
 
-		if err := o.initOutFolders(s.Config.Wipe); err != nil {
-			return fmt.Errorf("unable to initialize the output folders: %w", err)
-		}
+		iterator := slices.Values([]struct{}{{}})
 
-		// assign reusable scratch buffers to provided Output
-		o.templateByteBuffer = templateByteBuffer
-		o.templateHeaderByteBuffer = templateHeaderByteBuffer
+		if o.Key == "queries" {
+			iterator = func(yield func(struct{}) bool) {
+				for _, folder := range data.QueryFolders {
+					o.PkgName = filepath.Base(folder.Path)
+					o.OutFolder = folder.Path
+					data.QueryFolder = folder
 
-		if err := generateSingletonOutput(o, data, goVersion, s.Config.NoTests); err != nil {
-			return fmt.Errorf("singleton template output: %w", err)
+					if !yield(struct{}{}) {
+						return
+					}
+				}
+			}
 		}
 
-		dirExtMap := groupTemplates(o.tableTemplates)
+		for range iterator {
+			// set the package name for this output
+			data.PkgName = o.PkgName
+
+			if err := o.initOutFolders(s.Config.Wipe); err != nil {
+				return fmt.Errorf("unable to initialize the output folders: %w", err)
+			}
+
+			// assign reusable scratch buffers to provided Output
+			o.templateByteBuffer = templateByteBuffer
+			o.templateHeaderByteBuffer = templateHeaderByteBuffer
+
+			if err := generateSingletonOutput(o, data, goVersion, s.Config.NoTests); err != nil {
+				return fmt.Errorf("singleton template output: %w", err)
+			}
+
+			dirExtMap := groupTemplates(o.tableTemplates)
+
+			for _, table := range data.Tables {
+				data.Table = table
+
+				// Generate the regular templates
+				if err := generateOutput(o, dirExtMap, o.tableTemplates, data, goVersion, s.Config.NoTests); err != nil {
+					return fmt.Errorf("unable to generate output: %w", err)
+				}
+			}
+
+			if len(data.QueryFolder.Files) == 0 {
+				continue
+			}
+
+			dirExtMap = groupTemplates(o.queryTemplates)
+			for _, file := range data.QueryFolder.Files {
+				data.QueryFile = file
 
-		for _, table := range data.Tables {
-			data.Table = table
+				// We do this so that the name of the file is correct
+				base := filepath.Base(file.Path)
+				data.Table = drivers.Table[C, I]{
+					Name: base[:len(base)-4],
+				}
 
-			// Generate the regular templates
-			if err := generateOutput(o, dirExtMap, data, goVersion, s.Config.NoTests); err != nil {
-				return fmt.Errorf("unable to generate output: %w", err)
+				if err := generateOutput(o, dirExtMap, o.queryTemplates, data, goVersion, s.Config.NoTests); err != nil {
+					return fmt.Errorf("unable to generate output: %w", err)
+				}
 			}
 		}
 	}
diff --git a/gen/output.go b/gen/output.go
diff --git a/gen/templates.go b/gen/templates.go

Original file line number	Diff line number	Diff line change
`@@ -2339,6 +2339,7 @@`
`2339`	`2339`	`"comment": ""`
`2340`	`2340`	`}`
`2341`	`2341`	`],`
	`2342`	`+ "query_folders": null,`
`2342`	`2343`	`"enums": [`
`2343`	`2344`	`{`
`2344`	`2345`	`"Type": "TypeMonstersEnumNullable",`
Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,7 @@`
`119`	`119`	`"comment": ""`
`120`	`120`	`}`
`121`	`121`	`],`
	`122`	`+ "query_folders": null,`
`122`	`123`	`"enums": null,`
`123`	`124`	`"extra_info": null,`
`124`	`125`	`"driver_name": "github.com/go-sql-driver/mysql"`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@`
`60`	`60`	`"comment": ""`
`61`	`61`	`}`
`62`	`62`	`],`
	`63`	`+ "query_folders": null,`
`63`	`64`	`"enums": null,`
`64`	`65`	`"extra_info": null,`
`65`	`66`	`"driver_name": "github.com/go-sql-driver/mysql"`
Original file line number	Diff line number	Diff line change
`@@ -2490,6 +2490,7 @@`
`2490`	`2490`	`"comment": ""`
`2491`	`2491`	`}`
`2492`	`2492`	`],`
	`2493`	`+ "query_folders": null,`
`2493`	`2494`	`"enums": [`
`2494`	`2495`	`{`
`2495`	`2496`	`"Type": "TypeMonstersEnumNullable",`
Original file line number	Diff line number	Diff line change
`@@ -4578,6 +4578,7 @@`
`4578`	`4578`	`"comment": ""`
`4579`	`4579`	`}`
`4580`	`4580`	`],`
	`4581`	`+ "query_folders": null,`
`4581`	`4582`	`"enums": [`
`4582`	`4583`	`{`
`4583`	`4584`	`"Type": "UnicodeEnum",`
Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,7 @@`
`133`	`133`	`"comment": ""`
`134`	`134`	`}`
`135`	`135`	`],`
	`136`	`+ "query_folders": null,`
`136`	`137`	`"enums": [`
`137`	`138`	`{`
`138`	`139`	`"Type": "UnicodeEnum",`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@`
`67`	`67`	`"comment": ""`
`68`	`68`	`}`
`69`	`69`	`],`
	`70`	`+ "query_folders": null,`
`70`	`71`	`"enums": [`
`71`	`72`	`{`
`72`	`73`	`"Type": "UnicodeEnum",`
Original file line number	Diff line number	Diff line change
`@@ -4743,6 +4743,7 @@`
`4743`	`4743`	`"comment": ""`
`4744`	`4744`	`}`
`4745`	`4745`	`],`
	`4746`	`+ "query_folders": null,`
`4746`	`4747`	`"enums": [`
`4747`	`4748`	`{`
`4748`	`4749`	`"Type": "UnicodeEnum",`
Original file line number	Diff line number	Diff line change
`@@ -3093,6 +3093,7 @@`
`3093`	`3093`	`"comment": ""`
`3094`	`3094`	`}`
`3095`	`3095`	`],`
	`3096`	`+ "query_folders": null,`
`3096`	`3097`	`"enums": null,`
`3097`	`3098`	`"extra_info": null,`
`3098`	`3099`	`"driver_name": "modernc.org/sqlite"`
Original file line number	Diff line number	Diff line change
`@@ -245,6 +245,7 @@`
`245`	`245`	`"comment": ""`
`246`	`246`	`}`
`247`	`247`	`],`
	`248`	`+ "query_folders": null,`
`248`	`249`	`"enums": null,`
`249`	`250`	`"extra_info": null,`
`250`	`251`	`"driver_name": "modernc.org/sqlite"`