Add more features

Author: kefniark

.gitignore

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

Readme.md

@@ -9,26 +9,29 @@ MangoSQL is a fresh and juicy SQL code generator.
 3. You write application code that calls the generated code
 
 This is not an ORM, and you can easily inspect the code generated.
-This is inspired by [SQLC](https://github.com/sqlc-dev/sqlc) but pushes the idea farther by supporting relations and dynamic queries.
+This is inspired by [SQLC](https://github.com/sqlc-dev/sqlc) but pushes the idea farther by supporting batching, relations and dynamic queries.
 
 ## Features
 
-* **Convenient**: Generate all the structs for you
+* **Convenient**: All the structs are generated for you, No need for manual DTO/PDO
+* **Time Saver**: All the basic queries (CRUD) are generated from your schema alone
+* **Developer Friendly**: The code generated contains comments, examples and is designed with IDE autocompletion in mind 
 * **Flexible**: Provide a way to run dynamic queries (pagination, search, ...)
-* **Time Saver**: All the basic queries (CRUD) are auto-generated from your schema, nothing to declare
-* **Performant**: Support batching out of the box
-* **Safe**: All the SQL queries use prepared statement
-* **Consistency**: Easy to use transaction API
+* **Composable**: Use filters auto-generated or make your owns and reuse them across queries
+* **Safe**: All the SQL queries use prepared statement to avoid injection
+* **Consistent**: Easy to use transaction API to rollback when an error occurs
 
 ## Status
 
-This is WIP, features are still not complete and may change
+This repostiroy is currently a WIP, features are still not complete and may likely change
 
-Goals:
-* Handle custom relations (join, aggregations, ...)
-* Handle views
-* Support Mysql/MariaDB/Sqlite3
-* Better CLI
+Roadmap:
+* Handle custom queries for advanced relations (join, aggregations, ...)
+* Handle sql enums
+* Handle sql views
+* Support more types and custom types (cf ulid, ...)
+* Support more driver and database Mysql/MariaDB/Sqlite3
+* Write benchmark to compare performance with existing Golang ORM
 
 ## Example 
 
@@ -71,9 +74,16 @@ err := db.Transaction(func(tx *database.DBClient) error {
     // ...
 })
 
-// Handle dynamic clauses (filters, pagination, ...)
-users, err := db.User.Where(func(cond database.SelectBuilder) database.SelectBuilder {
-    return cond.Where("name ILIKE $1", "%user%").Offset(0).Limit(20)
+// Typed dynamic clauses (filters, pagination, ...) with typed helpers
+users, err := db.User.FindMany(
+    db.User.Query.Name.Like("%user%"),
+    db.User.Query.Amount.MoreThan(0),
+    db.User.Query.Limit(20)
+)
+
+// Raw dynamic clauses
+users, err := db.User.FindMany(func(query SelectBuilder) SelectBuilder {
+	return query.Where("name ILIKE $1 OR name ILIKE $2", "%user1%", "%user2%")
 })
 
 // Handle Batching
@@ -82,28 +92,45 @@ ids, err := db.User.UpsertMany([]database.UserUpdate{
     {Id: id, Email: "user1-updated", Name: "user1-updated"}, // this entry will be updated
 })
 
+// Use Struct Helpers
+user, _ := db.User.FindById(id)
+user.name = "NewName"
+user.Save(db)
+
 // ...
+
 ```
 
 ## API
 
 Here is the list of all the auto-generated methods for your tables:
 
 ## Getters
-* db.{Table}.Count()
-* db.{Table}.CountWhere(condition)
-* db.{Table}.All(offset, limit)
-* db.{Table}.Where(condition)
-* db.{Table}.GetById(id)
+* db.{Table}.FindById(id)  (*T, error)
+* db.{Table}.FindByIds(id) ([]T, error)
+* db.{Table}.FindUnique(...filters) (*T, error)
+* db.{Table}.FindMany(...filters) ([]T, error)
+* db.{Table}.Count(...filters) (int, error)
 
 ## Mutations
-* db.{Table}.Create(input)
-* db.{Table}.Update(input)
-* db.{Table}.Upsert(input)
+* db.{Table}.Create(input) (*T, error)
+* db.{Table}.CreateMany(inputs) ([]T, error)
+* db.{Table}.Update(input) (*T, error)
+* db.{Table}.UpdateMany(inputs) ([]T, error)
+* db.{Table}.Upsert(input) (*T, error)
+* db.{Table}.UpsertMany(inputs) ([]T, error)
 * db.{Table}.DeleteSoft(id)
 * db.{Table}.DeleteHard(id)
 
-## Batch Mutations
-* db.{Table}.CreateMany(inputs)
-* db.{Table}.UpdateMany(inputs)
-* db.{Table}.UpsertMany(inputs)
+## Query Filters
+* db.{Table}.Query.{Field}.Equal(input)
+* db.{Table}.Query.{Field}.NotEqual(input)
+* db.{Table}.Query.{Field}.In(input)
+* db.{Table}.Query.{Field}.NotIn(input)
+* db.{Table}.Query.{Field}.Like(input)
+* db.{Table}.Query.{Field}.MoreThan(input)
+* db.{Table}.Query.{Field}.LessThan(input)
+* db.{Table}.Query.{Field}.Between(low, high)
+* db.{Table}.Query.Offset(offset)
+* db.{Table}.Query.Limit(limit)
+* db.{Table}.Query.OrderBy{Field}()

cmd/mangosql/mangosql.go

@@ -61,27 +61,45 @@ type GenerateOptions struct {
 }
 
 func generate(opts GenerateOptions) error {
-	stat, err := os.Stat(opts.Output)
+	stat, err := os.Stat(opts.Src)
 	if err != nil {
 		return err
 	}
 
 	var sql string
+	var queriesFilePath string
+	var queriesSql string
 	if stat.IsDir() {
 		sql = parseMigrationFolder(opts.Src)
+
+		queriesFilePath = path.Join(opts.Src, "queries.sql")
 	} else {
 		data, err := os.ReadFile(opts.Src)
 		if err != nil {
 			return err
 		}
 		sql = string(data)
+
+		queriesFilePath = path.Join(path.Dir(opts.Src), "queries.sql")
 	}
 
 	schema, err := internal.ParseSchema(sql)
 	if err != nil {
 		return err
 	}
 
+	if _, err = os.Stat(queriesFilePath); err == nil {
+		data, err := os.ReadFile(queriesFilePath)
+		if err != nil {
+			return err
+		}
+		queriesSql = string(data)
+		err = internal.ParseQueries(schema, queriesSql)
+		if err != nil {
+			return err
+		}
+	}
+
 	var b bytes.Buffer
 	contents := bufio.NewWriter(&b)