Support new table_name tag and change schema definition to an anonymous struct

Author: hlubek

README.md

@@ -15,16 +15,19 @@ This is a code generator to generate a bunch of structs and functions to impleme
 **Your custom type defines fields for reading and writing**
 
 *model/customer.go*
+
 ```go
 package model
 
+import "github.com/networkteam/construct/v2"
+
 // Customer is just a struct, only struct tags are used in construct to generate code (no struct embedding needed) 
 type Customer struct {
-	ID            uuid.UUID `read_col:"customers.customer_id" write_col:"customer_id"`
-	Name          string    `read_col:"customers.name,sortable" write_col:"name"`
-    // Fields can be serialized as JSON by adding a "json" option to the "write_col" tag.
-    // It works perfectly with a column of type jsonb or json in PostgreSQL.
-	ContactPerson Contact   `read_col:"customers.contact_person,sortable" write_col:"contact_person,json"`
+	ID   uuid.UUID `table_name:"customers" read_col:"customers.customer_id" write_col:"customer_id"` // The table_name tag is optional and can be specified at most once per struct
+	Name string    `read_col:"customers.name,sortable" write_col:"name"`
+	// Fields can be serialized as JSON by adding a "json" option to the "write_col" tag.
+	// It works perfectly with a column of type jsonb or json in PostgreSQL.
+	ContactPerson Contact `read_col:"customers.contact_person,sortable" write_col:"contact_person,json"`
 
 	// DomainCount is not mapped to the table but used in the select for reading an aggregate count
 	DomainCount int
@@ -79,31 +82,29 @@ import (
 	"github.com/networkteam/qrb/fn"
 	"github.com/networkteam/qrb/qrbpgx"
 
-	".../myproject/domain"
+	".../myproject/model"
 )
 
-var customers = qrb.N("customers")
-
-func FindCustomerByID(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID) (domain.Customer, error) {
+func FindCustomerByID(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID) (model.Customer, error) {
 	q := qrb.
 		Select(customerJson()).
-		From(customers).
+		From(customer).
 		// constants for read columns are generated as qrb identifier expressions by construct
-		LeftJoin(domains).On(domain_customerID.Eq(customer_id)).
-		Where(customer_id.Eq(qrb.Arg(id))).
-		GroupBy(customer_id)
+		LeftJoin(domain).On(domain.customerID.Eq(customer.id)).
+		Where(customer.id.Eq(qrb.Arg(id))).
+		GroupBy(customer.id)
 
 	row, err := qrbpgx.Build(q).WithExecutor(executor).QueryRow(ctx)
 	if err != nil {
 		return result, err
 	}
-	return pgxScanRow[domain.Customer](row)
+	return pgxScanRow[model.Customer](row)
 }
 
 // CustomerChangeSet is generated by construct for handling partially filled models
 func InsertCustomer(ctx context.Context, executor qrbpgx.Executor, changeSet CustomerChangeSet) error {
 	q := qrb.
-		InsertInto(customers).
+		InsertInto(customer).
 		// toMap is generated by construct 
 		SetMap(changeSet.toMap())
 
@@ -113,8 +114,8 @@ func InsertCustomer(ctx context.Context, executor qrbpgx.Executor, changeSet Cus
 
 func UpdateCustomer(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID, changeSet CustomerChangeSet) error {
 	q := qrb.
-		Update(customers).
-		Where(customer_id.Eq(qrb.Arg(id))).
+		Update(customer).
+		Where(customer.id.Eq(qrb.Arg(id))).
 		SetMap(changeSet.toMap())
 
 	res, err := qrbpgx.Build(q).WithExecutor(executor).Exec(ctx)
@@ -129,7 +130,7 @@ func customerJson() builder.JsonBuildObjectBuilder {
 	// customerDefaultJson is generated by construct and is a JsonBuildObjectBuilder that can be further modified (immutable)
 	return customerDefaultJson.
 		// It's easy to set additional properties
-		Prop("DomainCount", qrb.Count(domain_id))
+		Prop("DomainCount", qrb.Count(domain.id))
 }
 ```
 

example/go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/gofrs/uuid v4.4.0+incompatible
 	github.com/jackc/pgx/v5 v5.3.1
 	github.com/networkteam/construct/v2 v2.0.0
-	github.com/networkteam/qrb v0.3.0
+	github.com/networkteam/qrb v0.3.2
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/urfave/cli/v2 v2.25.1
 )

example/go.sum

@@ -18,8 +18,8 @@ github.com/jackc/puddle/v2 v2.2.0 h1:RdcDk92EJBuBS55nQMMYFXTxwstHug4jkhT5pq8VxPk
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/mattn/go-runewidth v0.0.14 h1:+xnbZSEeDbOIg5/mE6JF0w6n9duR1l3/WmbinWVwUuU=
 github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
-github.com/networkteam/qrb v0.3.0 h1:ISKHpdFsgSTVaD1u0IJGVAVimkkUnRnsY5u3HFFSzWM=
-github.com/networkteam/qrb v0.3.0/go.mod h1:rRD44E0t1wI+YHLOH/CPUIbYx/dKgetNYkFXVixDPfc=
+github.com/networkteam/qrb v0.3.2 h1:+RiQR/ZC7/JXA9MllFU9ZN/Z7Cd/sLlKfFNzM+J2rT4=
+github.com/networkteam/qrb v0.3.2/go.mod h1:rRD44E0t1wI+YHLOH/CPUIbYx/dKgetNYkFXVixDPfc=
 github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
 github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
 github.com/pashagolub/pgxmock/v2 v2.6.0 h1:Dk07FlzdMOrqdxrelmEeWP9uqcDm757HZWrIwyvdPsE=

example/pgx/model/project.go

@@ -6,7 +6,7 @@ import (
 
 // Project model with todos
 type Project struct {
-	ID    uuid.UUID `read_col:"projects.id" write_col:"id"`
+	ID    uuid.UUID `table_name:"projects" read_col:"projects.id" write_col:"id"`
 	Title string    `read_col:"projects.title" write_col:"title"`
 
 	// for embedded loading of counts

example/pgx/model/todo.go

@@ -4,14 +4,17 @@ import (
 	"time"
 
 	"github.com/gofrs/uuid"
+
+	"github.com/networkteam/construct/v2"
 )
 
 // Todo model belonging to a project
 type Todo struct {
-	ID          uuid.UUID  `read_col:"todos.id" write_col:"id"`
-	ProjectID   uuid.UUID  `read_col:"todos.project_id" write_col:"project_id"`
-	Title       string     `read_col:"todos.title" write_col:"title"`
-	CompletedAt *time.Time `read_col:"todos.completed_at" write_col:"completed_at"`
+	construct.Table `table_name:"todos"` // The table_name struct tag could also be applied to an empty embedded struct
+	ID              uuid.UUID            `read_col:"todos.id" write_col:"id"`
+	ProjectID       uuid.UUID            `read_col:"todos.project_id" write_col:"project_id"`
+	Title           string               `read_col:"todos.title" write_col:"title"`
+	CompletedAt     *time.Time           `read_col:"todos.completed_at" write_col:"completed_at"`
 
 	// for eager loading of referenced records
 	Project *Project

example/pgx/repository/mappings_project_gen.go

@@ -13,27 +13,25 @@ import (
 	"github.com/networkteam/construct/v2/example/pgx/model"
 )
 
-var projects = N("projects")
-
 // projectBuildFindQuery creates a partial builder.SelectBuilder that
 // - selects a single JSON result by using buildProjectJson
 // - from the projects table
 // - and left joins an aggregation of todo counts by project
 func projectBuildFindQuery() builder.SelectBuilder {
 	return SelectJson(projectJson()).
-		From(projects).
+		From(project).
 		LeftJoin(
-			Select(fn.Count(todo_projectID)).As("count").
-				Select(todo_projectID).
-				From(todos).
-				GroupBy(todo_projectID),
-		).As("todo_counts").On(project_id.Eq(N("todo_counts.project_id")))
+			Select(fn.Count(todo.projectID)).As("count").
+				Select(todo.projectID).
+				From(todo).
+				GroupBy(todo.projectID),
+		).As("todo_counts").On(project.id.Eq(N("todo_counts.project_id")))
 }
 
 // FindProjectByID finds a single project by id
 func FindProjectByID(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID) (result model.Project, err error) {
 	q := projectBuildFindQuery().
-		Where(project_id.Eq(Arg(id)))
+		Where(project.id.Eq(Arg(id)))
 
 	row, err := qrbpgx.Build(q).WithExecutor(executor).QueryRow(ctx)
 	if err != nil {
@@ -45,7 +43,7 @@ func FindProjectByID(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID
 // FindAllProjects finds all projects sorted by title
 func FindAllProjects(ctx context.Context, executor qrbpgx.Executor) (result []model.Project, err error) {
 	q := projectBuildFindQuery().
-		OrderBy(project_title)
+		OrderBy(project.title)
 
 	rows, err := qrbpgx.Build(q).WithExecutor(executor).Query(ctx)
 	if err != nil {
@@ -57,7 +55,7 @@ func FindAllProjects(ctx context.Context, executor qrbpgx.Executor) (result []mo
 
 // InsertProject inserts a new project from a ProjectChangeSet
 func InsertProject(ctx context.Context, executor qrbpgx.Executor, changeSet ProjectChangeSet) error {
-	q := InsertInto(projects).
+	q := InsertInto(project).
 		SetMap(changeSet.toMap())
 
 	_, err := qrbpgx.Build(q).WithExecutor(executor).Exec(ctx)

example/pgx/repository/mappings_todo_gen.go

@@ -12,23 +12,21 @@ import (
 	"github.com/networkteam/construct/v2/example/pgx/model"
 )
 
-var todos = qrb.N("todos")
-
 // todoBuildFindQuery creates a partial builder.SelectBuilder that
 // - selects a single JSON result by using todoJson()
 // - from the todos table
 // - and left join the projects for eagerly fetching the project for each todo in a single query
 func todoBuildFindQuery() builder.SelectBuilder {
 	return qrb.
 		SelectJson(todoJson()).
-		From(todos).
-		LeftJoin(projects).On(todo_projectID.Eq(project_id))
+		From(todo).
+		LeftJoin(project).On(todo.projectID.Eq(project.id))
 }
 
 // FindTodoByID finds a single todo by id
 func FindTodoByID(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID) (result model.Todo, err error) {
 	q := todoBuildFindQuery().
-		Where(todo_id.Eq(qrb.Arg(id)))
+		Where(todo.id.Eq(qrb.Arg(id)))
 
 	row, err := qrbpgx.Build(q).WithExecutor(executor).QueryRow(ctx)
 	if err != nil {
@@ -40,7 +38,7 @@ func FindTodoByID(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID) (
 // FindAllTodos finds all todos sorted by title
 func FindAllTodos(ctx context.Context, executor qrbpgx.Executor, filter model.TodosFilter) (result []model.Todo, err error) {
 	q := todoBuildFindQuery().
-		OrderBy(todo_completedAt).Desc().NullsFirst()
+		OrderBy(todo.completedAt).Desc().NullsFirst()
 
 	rows, err := qrbpgx.Build(q).WithExecutor(executor).Query(ctx)
 	if err != nil {
@@ -53,7 +51,7 @@ func FindAllTodos(ctx context.Context, executor qrbpgx.Executor, filter model.To
 // InsertTodo inserts a new todo with values from changeSet
 func InsertTodo(ctx context.Context, executor qrbpgx.Executor, changeSet TodoChangeSet) error {
 	q := qrb.
-		InsertInto(todos).
+		InsertInto(todo).
 		SetMap(changeSet.toMap())
 
 	_, err := qrbpgx.Build(q).WithExecutor(executor).Exec(ctx)
@@ -63,9 +61,9 @@ func InsertTodo(ctx context.Context, executor qrbpgx.Executor, changeSet TodoCha
 // UpdateTodo updates a todo with the given id and changes from changeSet
 func UpdateTodo(ctx context.Context, executor qrbpgx.Executor, id uuid.UUID, changeSet TodoChangeSet) error {
 	q := qrb.
-		Update(todos).
+		Update(todo).
 		SetMap(changeSet.toMap()).
-		Where(todo_id.Eq(qrb.Arg(id)))
+		Where(todo.id.Eq(qrb.Arg(id)))
 
 	res, err := qrbpgx.Build(q).WithExecutor(executor).Exec(ctx)
 	if err != nil {

example/pgx/repository/repository_project.go

@@ -6,7 +6,7 @@ require (
 	github.com/dave/jennifer v1.6.0
 	github.com/fatih/structtag v1.2.0
 	github.com/gofrs/uuid v4.4.0+incompatible
-	github.com/networkteam/qrb v0.3.0
+	github.com/networkteam/qrb v0.3.2
 	github.com/stretchr/testify v1.8.2
 	github.com/urfave/cli/v2 v2.25.1
 	golang.org/x/tools v0.7.0