Stop writing your SQL code inside your Go source files!

midir99 — Mon, 07 Nov 2022 01:02:12 +0000

You are writing Go but you need to write some SQL, so you end up writing SQL inside your Go source code, this is not a problem as long as they are short queries, but when your queries take up more lines of code they become hard to read and to modify, besides the lack of indentation and coloring of the code make it worse.

So... What is the solution?

Keep your SQL code as SQL and your Go code as Go (don't write SQL inside Go).

For this you can use sqload!

File users.sql

-- query: FindUserById
SELECT first_name,
       last_name,
       dob,
       email
  FROM user
 WHERE id = :id;

-- query: UpdateFirstNameById
UPDATE user
   SET first_name = :first_name
 WHERE id = :id;

-- query: DeleteUserById
DELETE FROM user WHERE id = :id;

File main.go

package main

import (
    _ "embed"
    "fmt"

    "github.com/midir99/sqload"
)

//go:embed users.sql
var sqlCode string

var Q = sqload.MustLoadFromString[struct {
    FindUserById        string `query:"FindUserById"`
    UpdateFirstNameById string `query:"UpdateFirstNameById"`
    DeleteUserById      string `query:"DeleteUserById"`
}](sqlCode)

func main() {
    fmt.Printf("- FindUserById\n%s\n\n", Q.FindUserById)
    fmt.Printf("- UpdateFirstNameById\n%s\n\n", Q.UpdateFirstNameById)
    fmt.Printf("- DeleteUserById\n%s\n\n", Q.DeleteUserById)
}

By keeping your SQL and Go separate you get the following advantages:

Better support by your IDE or code editor (because you are now handling SQL code in its own file with its .sql extension).
Your DBA will be able to easily find the code of each query that your project is running.
SQL reuse, simply copy the same .sql files from one project to another.
Keep your Go code free of SQL queries.

sqload is a library with 100% test coverage, free of dependencies
from third parties and their documentation has many examples.

sqload is inspired by Yesql (Clojure).

https://github.com/midir99/sqload
https://pkg.go.dev/github.com/midir99/sqload

Deja de escribir código SQL dentro de código Go, ¡la solución está aquí!

midir99 — Mon, 07 Nov 2022 00:44:53 +0000

Estás escribiendo Go pero necesitas escribir un poco de SQL, por lo que terminas escribiendo código SQL dentro de tu código fuente Go, esto no es un problema mientras sean consultas cortas, pero cuando tus consultas ocupan más líneas de código éstas se vuelven difíciles de leer y de modificar, además la falta de indentación y coloreado del código lo hacen peor.

Entonces... ¿Cuál es la solución?

Mantén tu código SQL como SQL y tu código Go como Go (no escribas SQL dentro de Go).

¡Para esto puedes usar sqload!

Archivo users.sql

-- query: FindUserById
SELECT first_name,
       last_name,
       dob,
       email
  FROM user
 WHERE id = :id;

-- query: UpdateFirstNameById
UPDATE user
   SET first_name = :first_name
 WHERE id = :id;

-- query: DeleteUserById
DELETE FROM user WHERE id = :id;

Archivo main.go

package main

import (
    _ "embed"
    "fmt"

    "github.com/midir99/sqload"
)

//go:embed users.sql
var sqlCode string

var Q = sqload.MustLoadFromString[struct {
    FindUserById        string `query:"FindUserById"`
    UpdateFirstNameById string `query:"UpdateFirstNameById"`
    DeleteUserById      string `query:"DeleteUserById"`
}](sqlCode)

func main() {
    fmt.Printf("- FindUserById\n%s\n\n", Q.FindUserById)
    fmt.Printf("- UpdateFirstNameById\n%s\n\n", Q.UpdateFirstNameById)
    fmt.Printf("- DeleteUserById\n%s\n\n", Q.DeleteUserById)
}

Manteniendo tu SQL y Go separados obtienes las siguientes ventajas:

Mejor soporte por parte de tu IDE o editor de código (porque ahora estás manejando código SQL en su propio archivo con su extensión .sql).
Tu DBA podrá encontrar fácilmente el código de cada consulta que tu proyecto está corriendo.
Reúso de SQL, simplemente copia los mismos archivos .sql de un proyecto a otro.
Mantén tu código Go libre de consultas SQL.

sqload es una librería con 100% de test coverage, libre de dependencias
de terceros y su documentación cuenta con muchos ejemplos.

sqload está inspirada en Yesql (Clojure).

https://github.com/midir99/sqload
https://pkg.go.dev/github.com/midir99/sqload

DEV Community: midir99

Stop writing your SQL code inside your Go source files!

Deja de escribir código SQL dentro de código Go, ¡la solución está aquí!