initial commit

Author: kefniark

.envrc

@@ -0,0 +1,3 @@
+source_url "https://raw.githubusercontent.com/cachix/devenv/95f329d49a8a5289d31e0982652f7058a189bfca/direnvrc" "sha256-d+8cBpDfDBj41inrADaJt+bDWhOktwslgoP5YiGJ1v0="
+
+use devenv

.github/workflows/ci.yaml

@@ -0,0 +1,15 @@
+on: [push, pull_request]
+name: Test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v26
+      - uses: cachix/cachix-action@v14
+        with:
+          name: devenv
+      - name: Install devenv.sh
+        run: nix profile install nixpkgs#devenv
+      - name: Build the devenv shell and run any pre-commit hooks
+        run: devenv test

.gitignore

@@ -0,0 +1,12 @@
+# Devenv
+.devenv*
+devenv.local.nix
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml
+
+coverage.*
+bin/

Readme.md

@@ -0,0 +1,109 @@
+# MangoSQL
+
+## Description
+
+MangoSQL is a fresh and juicy SQL code generator.
+
+1. You provide your database schema (.sql files)
+2. You run MangoSQL cli to generate a client with type-safe interfaces and queries
+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.
+
+## Features
+
+* **Convenient**: Generate all the structs for you
+* **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
+
+## Status
+
+This is WIP, features are still not complete and may change
+
+Goals:
+* Handle custom relations (join, aggregations, ...)
+* Handle views
+* Support Mysql/MariaDB/Sqlite3
+* Better CLI
+
+## Example 
+
+So let's see what it means in reality. For the following:
+```sql
+CREATE TABLE users (
+  id          UUID PRIMARY KEY,
+  email       VARCHAR(64) NOT NULL,
+  name        VARCHAR(64) NOT NULL,
+  created_at  TIMESTAMP NOT NULL DEFAULT NOW(),
+  updated_at  TIMESTAMP NOT NULL DEFAULT NOW(),
+  deleted_at  TIMESTAMP DEFAULT NULL
+);
+```
+
+Execute the following command to automatically generate a `database/client.go`
+```sh
+mangosql --output=database schema.sql
+```
+
+This is all you need to do, now the client can be used in your code
+```go
+sqlDb, err := sqlx.Connect("postgres", "Postgres Connection URL")
+if err != nil {
+    panic(err)
+}
+
+db := database.New(sqlDb)
+
+// then you can use it and make queries or transactions
+
+// Handle crud operation
+user, err := db.User.Create(database.UserCreate{
+    Name: "user1",
+    Email: "user1@email.com"
+})
+
+// Handle transactions
+err := db.Transaction(func(tx *database.DBClient) error {
+    // ...
+})
+
+// Handle dynamic clause (filters, pagination, ...)
+users, err := db.User.Where(func(cond database.SelectBuilder) database.SelectBuilder {
+    return cond.Where("name ILIKE $1", "%user%").Offset(0).Limit(20)
+})
+
+// Handle Batching
+ids, err := db.User.UpsertMany([]database.UserUpdate{
+    {Email: "usernew@localhost", Name: "usernew"}, // this entry will be inserted
+    {Id: id, Email: "user1-updated", Name: "user1-updated"}, // this entry will be updated
+})
+
+// ...
+```
+
+## API
+
+Here is the list of all the autogenerated 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)
+
+## Mutations
+* db.{Table}.Create(input)
+* db.{Table}.Update(input)
+* db.{Table}.Upsert(input)
+* db.{Table}.DeleteSoft(id)
+* db.{Table}.DeleteHard(id)
+
+## Batch Mutations
+* db.{Table}.CreateMany(inputs)
+* db.{Table}.UpdateMany(inputs)
+* db.{Table}.UpsertMany(inputs)

cmd/mangosql/mangosql.go

@@ -0,0 +1,170 @@
+package main
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+	"go/format"
+	"log"
+	"os"
+	"path"
+	"regexp"
+	"strings"
+
+	"github.com/kefniark/mango-sql/internal"
+	"github.com/urfave/cli/v2"
+)
+
+func main() {
+	app := &cli.App{
+		Name:     "mangosql",
+		HelpName: "MangoSQL",
+		Usage:    "Generate a SQL Client from a SQL file or folder of SQL migrations",
+		UsageText: `Syntax: mangosql [options] <source folder>
+Example: mangosql --output db/file.go db/schema.sql`,
+		Suggest: true,
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:  "output",
+				Value: "database/client.go",
+				Usage: "Output file",
+			},
+			&cli.StringFlag{
+				Name:  "package",
+				Value: "database",
+				Usage: "Go Package",
+			},
+		},
+		Action: func(ctx *cli.Context) error {
+			if ctx.NArg() <= 0 {
+				return fmt.Errorf("missing source folder")
+			}
+
+			name := ctx.Args().Get(0)
+			return generate(GenerateOptions{
+				Src:     name,
+				Output:  ctx.String("output"),
+				Package: ctx.String("package"),
+			})
+		},
+	}
+
+	if err := app.Run(os.Args); err != nil {
+		log.Fatal(err)
+	}
+}
+
+type GenerateOptions struct {
+	Src     string
+	Output  string
+	Package string
+}
+
+func generate(opts GenerateOptions) error {
+	stat, err := os.Stat(opts.Output)
+	if err != nil {
+		return err
+	}
+
+	var sql string
+	if stat.IsDir() {
+		sql = parseMigrationFolder(opts.Src)
+	} else {
+		data, err := os.ReadFile(opts.Src)
+		if err != nil {
+			return err
+		}
+		sql = string(data)
+	}
+
+	schema, err := internal.ParseSchema(sql)
+	if err != nil {
+		return err
+	}
+
+	var b bytes.Buffer
+	contents := bufio.NewWriter(&b)
+
+	if err = internal.Generate(schema, contents, opts.Package); err != nil {
+		return err
+	}
+
+	folder := path.Dir(opts.Output)
+	file := path.Base(opts.Output)
+
+	stat, err = os.Stat(opts.Output)
+	if err == nil && stat.IsDir() {
+		folder = opts.Output
+		file = "client.go"
+	}
+
+	if err = os.MkdirAll(folder, os.ModeAppend); err != nil {
+		return err
+	}
+
+	f, err := os.Create(path.Join(folder, file))
+	if err != nil {
+		return err
+	}
+
+	defer f.Close()
+
+	contents.Flush()
+
+	formatted, err := format.Source([]byte((b.String())))
+	if err != nil {
+		return err
+	}
+
+	_, err = f.WriteString(string(formatted))
+	fmt.Printf("Generated %s\n", path.Join(folder, file))
+
+	return err
+}
+
+func parseMigrationFolder(folderName string) string {
+	entries, err := os.ReadDir(folderName)
+	if err != nil {
+		panic(err)
+	}
+
+	sql := []string{}
+	for _, entries := range entries {
+		if entries.IsDir() {
+			continue
+		}
+
+		fileName := path.Join(folderName, entries.Name())
+		data, err := os.ReadFile(fileName)
+		if err != nil {
+			panic(err)
+		}
+
+		entry := parseMigrationFile(string(data))
+		sql = append(sql, strings.TrimSpace(entry))
+	}
+
+	return strings.Join(sql, "\n")
+}
+
+var parseGooseMetaUp = regexp.MustCompile(`-- \+goose Up`)
+var parseGooseMetaDown = regexp.MustCompile(`-- \+goose Down`)
+
+func parseMigrationFile(content string) string {
+	up := parseGooseMetaUp.FindStringIndex(content)
+	down := parseGooseMetaDown.FindStringIndex(content)
+
+	if len(up) == 0 {
+		return ""
+	}
+
+	if len(down) == 0 {
+		return content[up[1]:]
+	}
+
+	if up[0] < down[0] {
+		return content[up[1]:down[0]]
+	}
+
+	return content[down[1]:up[0]]
+}