Merge pull request #221 from stephenafamo/alias-where

Add `AliasedAs()` method to `tableColumns` and `tableWhere`

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Add PreloadAs PreloadOption to override the join alias when preloading a relationship with a left join. (thanks @daddz)
+- Add `AliasedAs()` method to `tableColumns` and `tableWhere` types to use a custom alias.
+
+### Removed
+
+- Remove `TableWhere` function from the generated code. It was not used by the rest of the generated code and offered no clear benefit.
+
 ## [v0.26.1] - 2024-05-26
 
 ### Fixed

gen/templates/models/01_types.go.tpl

@@ -206,18 +206,28 @@ func {{$tAlias.DownPlural}}Join[Q dialect.Joinable](ctx context.Context) joinSet
 {{- end}}
 
 {{$.Importer.Import (printf "github.com/stephenafamo/bob/dialect/%s" $.Dialect)}}
-var {{$tAlias.UpSingular}}Columns = struct {
+var {{$tAlias.UpSingular}}Columns = build{{$tAlias.UpSingular}}Columns({{quote $table.Key}})
+type {{$tAlias.DownSingular}}Columns struct {
 	{{range $column := $table.Columns -}}
 	{{- $colAlias := $tAlias.Column $column.Name -}}
 	{{$colAlias}} {{$.Dialect}}.Expression
 	{{end -}}
-}{
-	{{range $column := $table.Columns -}}
-	{{- $colAlias := $tAlias.Column $column.Name -}}
-	{{$colAlias}}: {{$.Dialect}}.Quote({{quote $table.Key}}, {{quote $column.Name}}),
-	{{end -}}
 }
 
+func ({{$tAlias.DownSingular}}Columns) AliasedAs(alias string) {{$tAlias.DownSingular}}Columns {
+  return build{{$tAlias.UpSingular}}Columns(alias)
+}
+
+func build{{$tAlias.UpSingular}}Columns(alias string) {{$tAlias.DownSingular}}Columns {
+  return {{$tAlias.DownSingular}}Columns{
+    {{range $column := $table.Columns -}}
+    {{- $colAlias := $tAlias.Column $column.Name -}}
+    {{$colAlias}}: {{$.Dialect}}.Quote(alias, {{quote $column.Name}}),
+    {{end -}}
+  }
+}
+
+
 type {{$tAlias.DownSingular}}Where[Q {{$.Dialect}}.Filterable] struct {
 	{{range $column := $table.Columns -}}
 	{{- $colAlias := $tAlias.Column $column.Name -}}
@@ -229,14 +239,18 @@ type {{$tAlias.DownSingular}}Where[Q {{$.Dialect}}.Filterable] struct {
   {{end -}}
 }
 
-func {{$tAlias.UpSingular}}Where[Q {{$.Dialect}}.Filterable]() {{$tAlias.DownSingular}}Where[Q] {
+func ({{$tAlias.DownSingular}}Where[Q]) AliasedAs(alias string) {{$tAlias.DownSingular}}Where[Q] {
+	return build{{$tAlias.UpSingular}}Where[Q](build{{$tAlias.UpSingular}}Columns(alias))
+}
+
+func build{{$tAlias.UpSingular}}Where[Q {{$.Dialect}}.Filterable](cols {{$tAlias.DownSingular}}Columns) {{$tAlias.DownSingular}}Where[Q] {
 	return {{$tAlias.DownSingular}}Where[Q]{
 			{{range $column := $table.Columns -}}
 			{{- $colAlias := $tAlias.Column $column.Name -}}
 				{{- if $column.Nullable -}}
-					{{$colAlias}}: {{$.Dialect}}.WhereNull[Q, {{$column.Type}}]({{$tAlias.UpSingular}}Columns.{{$colAlias}}),
+					{{$colAlias}}: {{$.Dialect}}.WhereNull[Q, {{$column.Type}}](cols.{{$colAlias}}),
 				{{- else -}}
-					{{$colAlias}}: {{$.Dialect}}.Where[Q, {{$column.Type}}]({{$tAlias.UpSingular}}Columns.{{$colAlias}}),
+					{{$colAlias}}: {{$.Dialect}}.Where[Q, {{$column.Type}}](cols.{{$colAlias}}),
 				{{- end}}
 			{{end -}}
 	}

gen/templates/models/singleton/bob_main.go.tpl

@@ -52,7 +52,7 @@ func Where[Q {{$.Dialect}}.Filterable]() struct {
 	}{
 		{{range $table := .Tables -}}
 		{{$tAlias := $.Aliases.Table $table.Key -}}
-		{{$tAlias.UpPlural}}: {{$tAlias.UpSingular}}Where[Q](),
+		{{$tAlias.UpPlural}}: build{{$tAlias.UpSingular}}Where[Q]({{$tAlias.UpSingular}}Columns),
 		{{end -}}
 	}
 }

website/docs/code-generation/usage.md

@@ -1,8 +1,6 @@
 ---
-
 sidebar_position: 3
 description: How to use the Generated Models
-
 ---
 
 # Usage
@@ -74,9 +72,9 @@ var JetsTable = psql.NewTablex[*Jet, JetSlice, *JetSetter]("", "jets")
 
 **JetsTable** gives the full range of capabilites of a Bob model, including
 
-* Flexible queries: One, All, Cursor, Count, Exists
-* Expressions for names and column lists
-* Hooks
+- Flexible queries: One, All, Cursor, Count, Exists
+- Expressions for names and column lists
+- Hooks
 
 [Read the documentation to see how to use](../models/table)
 
@@ -207,7 +205,17 @@ users, err := models.Users(
 ).All()
 ```
 
-Since each query type has its own mods, `SelectWhere`,  `InsertWhere`, `UpdateWhere` and `DeleteWhere` are all generated.
+Since each query type has its own mods, `SelectWhere`, `InsertWhere`, `UpdateWhere` and `DeleteWhere` are all generated.
+
+:::tip
+
+To use these filters with an aliased table name, use the `AliasedAs` method.
+
+```go
+models.SelectWhere.Users.AliasedAs("u").Name.IsNull()
+```
+
+:::
 
 ### Join Helpers
 
@@ -224,7 +232,7 @@ models.Jets(
 ).All()
 ```
 
-Since each query type has its own mods, `SelectJoins`,  `InsertJoins`, `UpdateJoins` and `DeleteJoins` are all generated.
+Since each query type has its own mods, `SelectJoins`, `InsertJoins`, `UpdateJoins` and `DeleteJoins` are all generated.
 
 ### Column Expressions
 
@@ -244,4 +252,14 @@ psql.Select(
 
 ```
 
+:::tip
+
+To use these expressions with an aliased table name, use the `AliasedAs` method.
+
+```go
+models.JetColumns.AliasedAs("j").Name.IsNull()
+```
+
+:::
+
 [^1]: Some are technically just global variables. But they are never mutated by Bob, or expected to be mutated by the user.