Quick cleanup

Author: kefniark

.gitignore

@@ -9,6 +9,7 @@ devenv.local.nix
 .pre-commit-config.yaml
 
 coverage.*
+*.test
 bin/
 codegen/test/
 

Readme.md

@@ -104,7 +104,9 @@ user.Save(db)
 
 ## Status
 
-This repository is currently a WIP, features are still not complete and may likely change
+This repository is currently a WIP, features are still not complete and may likely change.
+
+Also the current SQL Parser being based on CockroachDB, some postgres specific syntax may be not supported.
 
 **Roadmap**:
 * [x] Handle custom user queries
@@ -113,5 +115,15 @@ This repository is currently a WIP, features are still not complete and may like
 * [ ] Support more types and custom types (cf ulid, ...)
 * [ ] Support more driver and database Mysql/MariaDB/Sqlite3
     * [x] For postgres support both `pq + sqlc` or `pgx`
+    * [ ] For Mysql/MariaDB `go-sql-driver`
+    * [ ] For Sqlite ``
+* [ ] Support easier logging and profiling
+* [ ] Support for Listen/Notify on pgx
+* [ ] Support DB Introspection to automatically extract schema from running database
+* [ ] Write Documentation
+    * [ ] Pick a static doc generator website
+    * [ ] Setup
 * [ ] Write benchmark to compare performance with existing Golang ORM
     * [x] Wrote basic comparison (insert, bulk insert, select)
+    * [ ] Add more use cases (select with lot of data, upsert, complex query with joins)
+    * [ ] Generate diagrams out of benchmark data

cmd/mangosql/main.go cmd/mangosql/mangosql.gocmd/mangosql/main.go renamed to cmd/mangosql/mangosql.go

@@ -172,8 +172,10 @@ func parseMigrationFolder(folderName string) string {
 	return strings.Join(sql, "\n")
 }
 
-var parseGooseMetaUp = regexp.MustCompile(`-- \+goose Up`)
-var parseGooseMetaDown = regexp.MustCompile(`-- \+goose Down`)
+var (
+	parseGooseMetaUp   = regexp.MustCompile(`-- \+goose Up`)
+	parseGooseMetaDown = regexp.MustCompile(`-- \+goose Down`)
+)
 
 func parseMigrationFile(content string) string {
 	up := parseGooseMetaUp.FindStringIndex(content)

internal/parser.go

@@ -66,12 +66,10 @@ func ParseSchema(sql string) (*core.SQLSchema, error) {
 
 	w := &walk.AstWalker{
 		Fn: func(ctx interface{}, node interface{}) (stop bool) {
-			// log.Printf("node type %T", node)
 			switch stmt := node.(type) {
 			case *tree.CreateTable:
 				parseTable(schema, stmt)
 			case *tree.CreateIndex:
-				// fmt.Println("index name: ", stmt.Name)
 				refTable := schema.Tables[stmt.Table.TableName.Normalize()]
 				if stmt.Unique {
 					refTable.Constraints = append(refTable.Constraints, &core.SQLTableConstraint{
@@ -177,35 +175,26 @@ func findTableDeps(schema *core.SQLSchema, table *tree.SelectClause, macro []cor
 			case *tree.Subquery:
 			case *tree.ParenSelect:
 				walk(ctx, s.Select)
-				// fmt.Printf("FindSelect %T %s\n", s, s)
 			case *tree.Select:
 				walk(ctx, s.Select)
 			case *tree.TableName:
 				ctx.tables = append(ctx.tables, s.TableName.Normalize())
-				// fmt.Printf("FindTableName %T %s\n", s, s)
 			case *tree.AliasedTableExpr:
 				subCtx := &FindTableDepsCtx{}
 				walk(subCtx, s.Expr)
-				// fmt.Printf("FindAliasedTableExpr %T %s (%s|%s|%s)\n", s, s, s.Expr, s.As, subCtx.tables)
 				ctx.tables = append(ctx.tables, subCtx.tables...)
 				ctx.Tables = append(ctx.Tables, core.TableDeps{
 					Names: subCtx.tables,
 					As:    s.As.Alias.Normalize(),
 				})
 			case *tree.JoinTableExpr:
-				// fmt.Printf("FindJoinTableExpr %T %s (%s|%s|%s|%s)\n", s, s, s.JoinType, s.Left, s.Right, s.Cond)
-				// fmt.Printf("> Left %T %s\n", s.Left, s.Left)
-				// fmt.Printf("> Right %T %s\n", s.Right, s.Right)
 				walk(ctx, s.Left)
 				walk(ctx, s.Right)
 				query.From = s.String()
 			case *tree.Where:
-				// fmt.Println("Where", s)
 				if s != nil && s.Expr != nil {
 					query.Where = s.Expr.String()
 				}
-			case *tree.GroupBy:
-				// fmt.Println("GROUP BY", s)
 			default:
 				fmt.Printf("not supported : %T %s\n", s, s)
 			}
@@ -456,9 +445,7 @@ func parseTable(schema *core.SQLSchema, stmt *tree.CreateTable) {
 }
 
 func parseAlterTable(schema *core.SQLSchema, stmt *tree.AlterTable) {
-	// fmt.Println("alter table")
 	for _, cmd := range stmt.Cmds {
-		// fmt.Println("cmd type: ", cmd)
 		switch cmd := cmd.(type) {
 		case *tree.AlterTableDropColumn:
 			refTable := schema.Tables[stmt.Table.ToTableName().TableName.Normalize()]
@@ -520,7 +507,6 @@ func parseAlterTable(schema *core.SQLSchema, stmt *tree.AlterTable) {
 					TableColumns: NameListToStrings(fk.ToCols),
 				})
 			}
-
 		}
 	}
 }

internal/parser_test.go

@@ -15,7 +15,7 @@ func TestParseTableCreate(t *testing.T) {
 	`)
 	assert.NoError(t, err)
 
-	//table
+	// table
 	assert.Equal(t, 1, len(schema.Tables))
 	assert.Equal(t, "orders", schema.Tables["orders"].Name)
 

internal/postgres/filters.go

@@ -5,20 +5,26 @@ import (
 	"strings"
 )
 
+const (
+	FilterNumericField = "FilterNumericField"
+	FilterStringField  = "FilterStringField"
+	FilterArrayField   = "FilterArrayField"
+	FilterGenericField = "FilterGenericField"
+)
+
 func GetNormalizedTypeFilter(col *PostgresColumn) string {
-	// fmt.Println(col.Type, col.TypeSql)
 	if strings.HasPrefix(col.Type, "[]") {
-		return "FilterArrayField"
+		return FilterArrayField
 	} else if strings.Contains(strings.ToLower(col.Type), "string") {
-		return "FilterStringField"
+		return FilterStringField
 	} else if strings.Contains(strings.ToLower(col.Type), "int") {
-		return "FilterNumericField"
+		return FilterNumericField
 	} else if strings.Contains(strings.ToLower(col.Type), "float") {
-		return "FilterNumericField"
+		return FilterNumericField
 	} else if strings.Contains(strings.ToLower(col.Type), "time") {
-		return "FilterNumericField"
+		return FilterNumericField
 	}
-	return "FilterGenericField"
+	return FilterGenericField
 }
 
 func (table *PostgresTable) GetFieldFilters() []SelectFieldFilter {

internal/postgres/postgres.go

@@ -48,11 +48,6 @@ func Generate(schema *core.SQLSchema, contents io.Writer, pkg string, driver str
 		return err
 	}
 
-	// relationsTmpl, err := template.ParseFS(templates, "templates/relations.tmpl")
-	// if err != nil {
-	// 	return err
-	// }
-
 	customQueriesTmpl, err := template.ParseFS(templates, "templates/custom.tmpl")
 	if err != nil {
 		return err
@@ -343,11 +338,11 @@ func (table *PostgresTable) HasUpdateExtraUpdated() bool {
 }
 
 func (table *PostgresTable) GetTableName() string {
-	return fmt.Sprintf("%sTable", strcase.ToLowerCamel(plural.Singular(table.Name)))
+	return strcase.ToLowerCamel(plural.Singular(table.Name)) + "Table"
 }
 
 func (table *PostgresTable) GetCreateSqlName() string {
-	return fmt.Sprintf("%sCreateSql", strcase.ToLowerCamel(plural.Singular(table.Name)))
+	return strcase.ToLowerCamel(plural.Singular(table.Name)) + "CreateSql"
 }
 
 func (table *PostgresTable) GetCreateSqlContent() string {
@@ -383,7 +378,7 @@ func (table *PostgresTable) GetCreateSqlContent() string {
 }
 
 func (table *PostgresTable) GetCreateManySqlName() string {
-	return fmt.Sprintf("%sCreateManySql", strcase.ToLowerCamel(plural.Singular(table.Name)))
+	return strcase.ToLowerCamel(plural.Singular(table.Name)) + "CreateManySql"
 }
 
 func (table *PostgresTable) GetCreateManySqlContent() string {
@@ -470,7 +465,7 @@ func (table *PostgresTable) GetUpsertSqlContent() string {
 }
 
 func (table *PostgresTable) GetUpsertManySqlName() string {
-	return fmt.Sprintf("%sUpsertManySql", strcase.ToLowerCamel(plural.Singular(table.Name)))
+	return strcase.ToLowerCamel(plural.Singular(table.Name)) + "UpsertManySql"
 }
 
 func (table *PostgresTable) GetUpsertManySqlContent() string {

justfile

@@ -1,8 +1,5 @@
 build:
-    go build -ldflags="-s -w" -o bin/mangosql ./cmd/mangosql
-
-bench:
-    go test -bench=. -benchtime=1s -benchmem ./tests/bench
+    CGO_ENABLED=0 go build -ldflags="-s -w" -o bin/mangosql ./cmd/mangosql
 
 format:
     golangci-lint run --fix ./...
@@ -12,7 +9,7 @@ lint:
 
 generate:
     # tests
-    go run ./cmd/mangosql/ --output ./tests/postgres/pgx/client.go --package main ./tests/postgres/pgx/schema.sql
+    go run ./cmd/mangosql/ --output ./tests/postgres/pgx_driver/client.go --package main ./tests/postgres/pgx_driver/schema.sql
     go run ./cmd/mangosql/ --output ./tests/postgres/overview/client.go --package overview ./tests/postgres/overview/schema.sql
     go run ./cmd/mangosql/ --output ./tests/postgres/auto-increment/client.go --package autoincrement ./tests/postgres/auto-increment/schema.sql
     go run ./cmd/mangosql/ --output ./tests/postgres/composite/client.go --package composite ./tests/postgres/composite/schema.sql
@@ -26,8 +23,11 @@ generate:
     go run ./cmd/mangosql/ --output ./tests/bench/pq/client.go --package pq --driver pq ./tests/bench/schema.sql
     go run ./cmd/mangosql/ --output ./tests/bench/pgx/client.go --package pgx ./tests/bench/schema.sql
 
+bench:
+    CGO_ENABLED=0 go test -c -bench=. -benchtime=1s -benchmem ./tests/bench
+
 test: generate
-    go test --cover --coverprofile=coverage.txt ./...
+    go test -race --cover --coverprofile=coverage.txt ./...
     go tool cover -html=coverage.txt -o coverage.html
     gocover-cobertura < coverage.txt > coverage.xml
 

tests/bench/insert_test.go

@@ -33,8 +33,6 @@ func newBenchmarkDBPQ(t *testing.B) (*driver_pq.DBClient, func()) {
 func newBenchmarkDBPGX(t *testing.B) (*driver_pgx.DBClient, func()) {
 	t.Helper()
 	config := helpers.NewDBBenchConfig(t)
-	// db, err := sqlx.Connect("pgx", config.URL())
-
 	db, err := pgx.Connect(context.Background(), config.URL())
 	if err != nil {
 		panic(err)
@@ -75,7 +73,7 @@ type User struct {
 }
 
 func benchmarkInsertOne(t *testing.B) {
-	db, close := newBenchmarkDBPQ(t)
+	dbPq, close := newBenchmarkDBPQ(t)
 	defer close()
 	dbPgx, closePgx := newBenchmarkDBPGX(t)
 	defer closePgx()
@@ -84,7 +82,7 @@ func benchmarkInsertOne(t *testing.B) {
 
 	t.Run("Insert One - Mango PQ", func(t *testing.B) {
 		for i := 0; i < t.N; i++ {
-			_, err := db.User.Insert(driver_pq.UserCreate{Name: "John Doe", Email: "john@email.com"})
+			_, err := dbPq.User.Insert(driver_pq.UserCreate{Name: "John Doe", Email: "john@email.com"})
 			assert.NoError(t, err)
 		}
 	})
@@ -215,7 +213,6 @@ func benchmarkSelect(t *testing.B) {
 			}
 		}
 	})
-
 }
 
 func Benchmark(t *testing.B) {