Merge pull request #15 from kefniark/feature/mysql

Implement Mysql + Mariadb drivers

Author: kefniark

cmd/mangosql/mangosql.go

@@ -5,7 +5,6 @@ import (
 	"bytes"
 	"fmt"
 	"go/format"
-	"log"
 	"os"
 	"path"
 	"regexp"
@@ -16,9 +15,15 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+var (
+	version = "dev"
+	commit  = "none"
+	date    = "unknown"
+)
+
 func main() {
 	app := &cli.App{
-		Version:  "v0.0.1",
+		Version:  fmt.Sprintf("%s (%s - %s)", version, commit, date),
 		Name:     "mangosql",
 		HelpName: "MangoSQL",
 		Usage:    "Generate a SQL Client from a SQL file or folder of SQL migrations",
@@ -62,7 +67,7 @@ Example: mangosql --output db/file.go db/schema.sql`,
 				return fmt.Errorf("missing source folder")
 			}
 
-			allowed_drivers := []string{"pq", "pgx", "sqlite"}
+			allowed_drivers := []string{"pq", "pgx", "sqlite", "mysql", "mariadb"}
 			driver := ctx.String("driver")
 			if !slices.Contains(allowed_drivers, driver) {
 				return fmt.Errorf("unknown driver, should be one of %v", allowed_drivers)
@@ -87,7 +92,8 @@ Example: mangosql --output db/file.go db/schema.sql`,
 	}
 
 	if err := app.Run(os.Args); err != nil {
-		log.Fatal(err)
+		fmt.Println("\033[31mError\033[0m:", err)
+		os.Exit(1)
 	}
 }
 

devenv.lock

@@ -3,11 +3,11 @@
     "devenv": {
       "locked": {
         "dir": "src/modules",
-        "lastModified": 1724251323,
+        "lastModified": 1724504184,
         "owner": "cachix",
         "repo": "devenv",
-        "rev": "5340ef87de79a5e23414e6707cc90009e97745d5",
-        "treeHash": "f09dcc233cb82d8ccafebd393e124824a0e25b55",
+        "rev": "51338b58fd666f448db7486ec145dbe52db9b829",
+        "treeHash": "cedf6d41b00189dfd5132772cb5f35fcb10a7f7b",
         "type": "github"
       },
       "original": {
@@ -112,11 +112,11 @@
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1724227338,
+        "lastModified": 1724440431,
         "owner": "cachix",
         "repo": "pre-commit-hooks.nix",
-        "rev": "6cedaa7c1b4f82a266e5d30f212273e60d62cb0d",
-        "treeHash": "698918d3a04360f1dfd19164903511a167368ec1",
+        "rev": "c8a54057aae480c56e28ef3e14e4960628ac495b",
+        "treeHash": "40ee1da550348c789ed9503eea365533a618506c",
         "type": "github"
       },
       "original": {

docker-compose.yml

@@ -1,5 +1,27 @@
 version: "3.6"
 services:
+  mysqltestdb:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_USER: user
+      MYSQL_PASSWORD: password
+      MYSQL_DATABASE: test
+    restart: unless-stopped
+    ports:
+      - "3307:3306"
+
+  mariatestdb:
+    image: mariadb:latest
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_USER: user
+      MYSQL_PASSWORD: password
+      MYSQL_DATABASE: test
+    restart: unless-stopped
+    ports:
+      - "3306:3306"
+
   pgtestdb:
     image: postgres:16
     environment:

docs/bench/bench.md

@@ -4,9 +4,9 @@ import { withBase } from 'vitepress'
 
 # Benchmark
 
-The following benchmarks are just here to help development and give a general performance idea of MangoSQL.
+The benchmarks provided are meant to help development and offer a general sense of MangoSQL's performance. They are not intended to be exhaustive or compare every available method or library.
 
-It's not intended to cover every method or library on the market.
+MangoSQL’s speed is not a primary objective, it's rather a byproduct of its design. By eliminating abstraction, reducing indirection, and directly interfacing with drivers, the system minimizes overhead.
 
 ## Postgres 
 

docs/getting-started/index.md

@@ -14,23 +14,22 @@ go install github.com/kefniark/mango-sql/cmd/mangosql
 mangosql schema.sql
 ```
 
-```sh [docker]
-# Download from docker registry: https://github.com/kefniark/mango-sql/pkgs/container/mango-sql
+```sh [manual]
+# Download the last release from https://github.com/kefniark/mango-sql/releases
 
 # Use MangoSQL CLI
-docker run -it -v [MOUNT FOLDER]:/app/ ghcr.io/kefniark/mango-sql:latest -i /app/[YOUR SQL FILE] > [OUTPUT GO FILE]
-
-# Example
-docker run -it -v .:/app/ ghcr.io/kefniark/mango-sql:latest -i /app/schema.sql > client.go
-
-# -i/--inline: allow to get the generated code without dealing with volume mount and permission issues
+./mangosql schema.sql
 ```
 
-```sh [manual]
-# Download the last release from https://github.com/kefniark/mango-sql/releases
+```sh [docker]
+# Download from docker registry: https://github.com/kefniark/mango-sql/pkgs/container/mango-sql
 
 # Use MangoSQL CLI
-./mangosql schema.sql
+docker run -t --rm -v .:/app/ \
+  ghcr.io/kefniark/mango-sql:latest \
+  -i /app/schema.sql > client.go
+
+# -i/--inline: allow to output the generated file to the console
 ```
 
 :::
@@ -55,6 +54,22 @@ mangosql --driver sqlite ./schema.sql
 mangosql --output ./myfolder --package myfolder --driver sqlite ./schema.sql
 ```
 
+```sh [mariadb]
+# Default command (output: ./database/client.go)
+mangosql --driver mariadb ./schema.sql
+
+# Or: Output in a specific folder
+mangosql --output ./myfolder --package myfolder --driver mariadb ./schema.sql
+```
+
+```sh [mysql]
+# Default command (output: ./database/client.go)
+mangosql --driver mysql ./schema.sql
+
+# Or: Output in a specific folder
+mangosql --output ./myfolder --package myfolder --driver mysql ./schema.sql
+```
+
 :::
 
 * `./schema.sql`: Input schema, accept a SQL file or a directory of migrations

docs/getting-started/usage.md

@@ -55,6 +55,31 @@ func NewDBClient() (db *DBClient, close func()) {
 }
 ```
 
+```go [mariadb/mysql]
+import (
+    "context"
+
+    "github.com/jmoiron/sqlx"
+    _ "github.com/go-sql-driver/mysql"
+)
+
+// TODO: Update mysql/mariadb connection url
+// Ref: https://github.com/go-sql-driver/mysql
+// example: user:password@tcp(127.0.0.1:3306)/dbname?parseTime=true
+const databaseURL := "{CONNECTION URL TO YOUR DATABASE}"
+
+func NewDBClient() (db *DBClient, close func()) {
+    db, err := sqlx.Open("mysql", databaseURL)
+	if err != nil {
+		panic(err)
+	}
+
+    return New(db), func() {
+		db.Close()
+	}
+}
+```
+
 :::
 
 ## Enjoy MangoSQL

docs/public/bench_postgres_findmany_alloc.html

@@ -9,13 +9,13 @@
 </head>
 
 <body><div class="container">
-    <div class="item" id="UTHMMxeRfgFA" style="width:576px;height:320px;"></div>
+    <div class="item" id="RonWfyTtinEl" style="width:576px;height:320px;"></div>
 </div><script type="text/javascript">
     "use strict";
-    let goecharts_UTHMMxeRfgFA = echarts.init(document.getElementById('UTHMMxeRfgFA'), "shine", { renderer: "canvas" });
-    let option_UTHMMxeRfgFA = {"legend":{},"series":[{"name":"GormPGX","type":"line","data":[{"value":121},{"value":465},{"value":1082},{"value":2163},{"value":4325},{"value":10789},{"value":22040},{"value":1090},{"value":437},{"value":981},{"value":1888},{"value":3703},{"value":9270},{"value":18535}]},{"name":"MangoPGX","type":"line","data":[{"value":40},{"value":102},{"value":223},{"value":424},{"value":825},{"value":2027},{"value":4541},{"value":1190},{"value":325},{"value":631},{"value":1138},{"value":2142},{"value":5152},{"value":10162}]},{"name":"MangoPQ","type":"line","data":[{"value":41},{"value":121},{"value":257},{"value":483},{"value":934},{"value":2286},{"value":5058},{"value":1190},{"value":293},{"value":580},{"value":1057},{"value":2008},{"value":4862},{"value":9618}]}],"title":{"text":"FindMany|Mem","subtext":"Lower is Better (allocs/op)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
+    let goecharts_RonWfyTtinEl = echarts.init(document.getElementById('RonWfyTtinEl'), "shine", { renderer: "canvas" });
+    let option_RonWfyTtinEl = {"legend":{},"series":[{"name":"GormPGX","type":"line","data":[{"value":122},{"value":475},{"value":1107},{"value":2213},{"value":4425},{"value":11039},{"value":22541},{"value":1100},{"value":446},{"value":1006},{"value":1938},{"value":3803},{"value":9521},{"value":19039}]},{"name":"MangoPGX","type":"line","data":[{"value":41},{"value":102},{"value":223},{"value":424},{"value":825},{"value":2027},{"value":4542},{"value":1220},{"value":335},{"value":656},{"value":1188},{"value":2242},{"value":5402},{"value":10662}]},{"name":"MangoPQ","type":"line","data":[{"value":41},{"value":121},{"value":257},{"value":483},{"value":934},{"value":2285},{"value":5058},{"value":1210},{"value":293},{"value":580},{"value":1057},{"value":2008},{"value":4862},{"value":9618}]}],"title":{"text":"FindMany|Mem","subtext":"Lower is Better (allocs/op)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
 
-    goecharts_UTHMMxeRfgFA.setOption(option_UTHMMxeRfgFA);
+    goecharts_RonWfyTtinEl.setOption(option_RonWfyTtinEl);
 </script>
 <style>
     .container {margin-top:30px; display: flex;justify-content: center;align-items: center;}

docs/public/bench_postgres_findmany_cpu.html

@@ -9,13 +9,13 @@
 </head>
 
 <body><div class="container">
-    <div class="item" id="VxFbtyzyZZqC" style="width:576px;height:320px;"></div>
+    <div class="item" id="FinTqiRZVJaq" style="width:576px;height:320px;"></div>
 </div><script type="text/javascript">
     "use strict";
-    let goecharts_VxFbtyzyZZqC = echarts.init(document.getElementById('VxFbtyzyZZqC'), "shine", { renderer: "canvas" });
-    let option_VxFbtyzyZZqC = {"legend":{},"series":[{"name":"GormPGX","type":"line","data":[{"value":2437},{"value":1857},{"value":1403},{"value":952},{"value":553},{"value":214},{"value":127},{"value":606},{"value":4474},{"value":2861},{"value":1925},{"value":1011},{"value":404},{"value":213}]},{"name":"MangoPGX","type":"line","data":[{"value":6889},{"value":4763},{"value":3319},{"value":2074},{"value":1146},{"value":457},{"value":220},{"value":662},{"value":4938},{"value":3742},{"value":2585},{"value":1580},{"value":660},{"value":319}]},{"name":"MangoPQ","type":"line","data":[{"value":7399},{"value":5061},{"value":3449},{"value":2194},{"value":1181},{"value":472},{"value":234},{"value":734},{"value":5388},{"value":3944},{"value":2561},{"value":1559},{"value":676},{"value":329}]}],"title":{"text":"FindMany|CPU","subtext":"Higher is Better (op/s)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
+    let goecharts_FinTqiRZVJaq = echarts.init(document.getElementById('FinTqiRZVJaq'), "shine", { renderer: "canvas" });
+    let option_FinTqiRZVJaq = {"legend":{},"series":[{"name":"GormPGX","type":"line","data":[{"value":2429},{"value":1908},{"value":1453},{"value":971},{"value":561},{"value":219},{"value":128},{"value":604},{"value":4173},{"value":2932},{"value":1922},{"value":1045},{"value":432},{"value":185}]},{"name":"MangoPGX","type":"line","data":[{"value":6711},{"value":4795},{"value":3234},{"value":2133},{"value":1154},{"value":449},{"value":223},{"value":651},{"value":4948},{"value":3678},{"value":2582},{"value":1515},{"value":659},{"value":306}]},{"name":"MangoPQ","type":"line","data":[{"value":7443},{"value":5004},{"value":3393},{"value":2158},{"value":1197},{"value":477},{"value":238},{"value":719},{"value":5477},{"value":3483},{"value":2623},{"value":1582},{"value":675},{"value":307}]}],"title":{"text":"FindMany|CPU","subtext":"Higher is Better (op/s)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
 
-    goecharts_VxFbtyzyZZqC.setOption(option_VxFbtyzyZZqC);
+    goecharts_FinTqiRZVJaq.setOption(option_FinTqiRZVJaq);
 </script>
 <style>
     .container {margin-top:30px; display: flex;justify-content: center;align-items: center;}

docs/public/bench_postgres_insertmany_alloc.html

@@ -9,13 +9,13 @@
 </head>
 
 <body><div class="container">
-    <div class="item" id="IhywVMYWTAuI" style="width:576px;height:320px;"></div>
+    <div class="item" id="EWakwZPOUEFv" style="width:576px;height:320px;"></div>
 </div><script type="text/javascript">
     "use strict";
-    let goecharts_IhywVMYWTAuI = echarts.init(document.getElementById('IhywVMYWTAuI'), "shine", { renderer: "canvas" });
-    let option_IhywVMYWTAuI = {"legend":{},"series":[{"name":"GormPGX","type":"line","data":[{"value":121},{"value":465},{"value":1082},{"value":2163},{"value":4325},{"value":10789},{"value":22040},{"value":1090},{"value":437},{"value":981},{"value":1888},{"value":3703},{"value":9270},{"value":18535}]},{"name":"MangoPGX","type":"line","data":[{"value":40},{"value":102},{"value":223},{"value":424},{"value":825},{"value":2027},{"value":4541},{"value":1190},{"value":325},{"value":631},{"value":1138},{"value":2142},{"value":5152},{"value":10162}]},{"name":"MangoPQ","type":"line","data":[{"value":41},{"value":121},{"value":257},{"value":483},{"value":934},{"value":2286},{"value":5058},{"value":1190},{"value":293},{"value":580},{"value":1057},{"value":2008},{"value":4862},{"value":9618}]}],"title":{"text":"InsertMany|Mem","subtext":"Lower is Better (allocs/op)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
+    let goecharts_EWakwZPOUEFv = echarts.init(document.getElementById('EWakwZPOUEFv'), "shine", { renderer: "canvas" });
+    let option_EWakwZPOUEFv = {"legend":{},"series":[{"name":"MangoPQ","type":"line","data":[{"value":41},{"value":121},{"value":257},{"value":483},{"value":934},{"value":2285},{"value":5058},{"value":1210},{"value":293},{"value":580},{"value":1057},{"value":2008},{"value":4862},{"value":9618}]},{"name":"GormPGX","type":"line","data":[{"value":122},{"value":475},{"value":1107},{"value":2213},{"value":4425},{"value":11039},{"value":22541},{"value":1100},{"value":446},{"value":1006},{"value":1938},{"value":3803},{"value":9521},{"value":19039}]},{"name":"MangoPGX","type":"line","data":[{"value":41},{"value":102},{"value":223},{"value":424},{"value":825},{"value":2027},{"value":4542},{"value":1220},{"value":335},{"value":656},{"value":1188},{"value":2242},{"value":5402},{"value":10662}]}],"title":{"text":"InsertMany|Mem","subtext":"Lower is Better (allocs/op)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
 
-    goecharts_IhywVMYWTAuI.setOption(option_IhywVMYWTAuI);
+    goecharts_EWakwZPOUEFv.setOption(option_EWakwZPOUEFv);
 </script>
 <style>
     .container {margin-top:30px; display: flex;justify-content: center;align-items: center;}

docs/public/bench_postgres_insertmany_cpu.html

@@ -9,13 +9,13 @@
 </head>
 
 <body><div class="container">
-    <div class="item" id="ruMiZnVEmQgz" style="width:576px;height:320px;"></div>
+    <div class="item" id="DohQFGVHPfSO" style="width:576px;height:320px;"></div>
 </div><script type="text/javascript">
     "use strict";
-    let goecharts_ruMiZnVEmQgz = echarts.init(document.getElementById('ruMiZnVEmQgz'), "shine", { renderer: "canvas" });
-    let option_ruMiZnVEmQgz = {"legend":{},"series":[{"name":"MangoPQ","type":"line","data":[{"value":7399},{"value":5061},{"value":3449},{"value":2194},{"value":1181},{"value":472},{"value":234},{"value":734},{"value":5388},{"value":3944},{"value":2561},{"value":1559},{"value":676},{"value":329}]},{"name":"GormPGX","type":"line","data":[{"value":2437},{"value":1857},{"value":1403},{"value":952},{"value":553},{"value":214},{"value":127},{"value":606},{"value":4474},{"value":2861},{"value":1925},{"value":1011},{"value":404},{"value":213}]},{"name":"MangoPGX","type":"line","data":[{"value":6889},{"value":4763},{"value":3319},{"value":2074},{"value":1146},{"value":457},{"value":220},{"value":662},{"value":4938},{"value":3742},{"value":2585},{"value":1580},{"value":660},{"value":319}]}],"title":{"text":"InsertMany|CPU","subtext":"Higher is Better (op/s)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
+    let goecharts_DohQFGVHPfSO = echarts.init(document.getElementById('DohQFGVHPfSO'), "shine", { renderer: "canvas" });
+    let option_DohQFGVHPfSO = {"legend":{},"series":[{"name":"GormPGX","type":"line","data":[{"value":2429},{"value":1908},{"value":1453},{"value":971},{"value":561},{"value":219},{"value":128},{"value":604},{"value":4173},{"value":2932},{"value":1922},{"value":1045},{"value":432},{"value":185}]},{"name":"MangoPGX","type":"line","data":[{"value":6711},{"value":4795},{"value":3234},{"value":2133},{"value":1154},{"value":449},{"value":223},{"value":651},{"value":4948},{"value":3678},{"value":2582},{"value":1515},{"value":659},{"value":306}]},{"name":"MangoPQ","type":"line","data":[{"value":7443},{"value":5004},{"value":3393},{"value":2158},{"value":1197},{"value":477},{"value":238},{"value":719},{"value":5477},{"value":3483},{"value":2623},{"value":1582},{"value":675},{"value":307}]}],"title":{"text":"InsertMany|CPU","subtext":"Higher is Better (op/s)"},"toolbox":{},"tooltip":{},"xAxis":[{"data":["10","25","50","100","250","500"]}],"yAxis":[{}]}
 
-    goecharts_ruMiZnVEmQgz.setOption(option_ruMiZnVEmQgz);
+    goecharts_DohQFGVHPfSO.setOption(option_DohQFGVHPfSO);
 </script>
 <style>
     .container {margin-top:30px; display: flex;justify-content: center;align-items: center;}