1 Commits

Author SHA1 Message Date
81cf698072 added in few field wraping functions 2025-07-29 21:45:32 +05:30
6 changed files with 68 additions and 155 deletions

View File

@@ -2,6 +2,3 @@ run:
go run ./cmd -o ./example/db ./example/schema.sql go run ./cmd -o ./example/db ./example/schema.sql
bench-select: bench-select:
go test ./example -bench BenchmarkSelect -memprofile memprofile.out -cpuprofile profile.out go test ./example -bench BenchmarkSelect -memprofile memprofile.out -cpuprofile profile.out
test:
go test ./playground

View File

@@ -1,57 +1,51 @@
# pgm - PostgreSQL Query Mapper # pgm - PostgreSQL query mapper
A simple ORM that will work on top of [jackc/pgx](https://github.com/jackc/pgx) db connection pool.
A lightweight ORM built on top of [jackc/pgx](https://github.com/jackc/pgx) database connection pool.
## ORMs I Like in the Go Ecosystem ## ORMs in go eco system tha I like
- [ent](https://github.com/ent/ent)
- [sqlc](https://github.com/sqlc-dev/sqlc)
- [ent](https://github.com/ent/ent) ## Why not to use ent?
- [sqlc](https://github.com/sqlc-dev/sqlc) ent is feature loadedm, you can easily define complex schemas, it has nice integration with graphQL.
Very nice auto migration feature. Basically all the things you need in an ORM.
## Why Not Use `ent`? But to me its overkill for simple apps, I have seen ent related code is taking significatn space in app binary(feels bloated).
`ent` is a feature-rich ORM with schema definition, automatic migrations, integration with `gqlgen` (GraphQL server), and more. It provides nearly everything you could want in an ORM.
However, it can be overkill. The generated code supports a wide range of features, many of which you may not use, significantly increasing the compiled binary size. ## Why not to use sqlc?
sqlc is nice as well, but using it will start feeling that now your DB layer has its own Models and you need map you apps model with it or have no choice but to sart using DB layer models, which to me is not a good thing.
## Why Not Use `sqlc`? ## Things that I am not happy with
`sqlc` is a great tool, but it often feels like the database layer introduces its own models. This forces you to either map your applications models to these database models or use the database models directly, which may not align with your applications design. - Auto migrations, at many points you will see ORM is either not providing or have a complex way to do the simple db schema related changes. Its like obscure db schema. you can simply tell and test it in sql query editor.
## Issues with Existing ORMs DB must be a in form sql statement that you see, fine tune and event run/test in sql query editor.
Thers is lots of mature tools available in Go ecosystem, [dbmate](https://github.com/amacneil/dbmate) is one of them, its a nice tool to manage migrations, can be use in code or in cli
Here are some common pain points with ORMs: - To much extra code is generated for various condition and scenarios that you may not use
- **Auto Migrations**: Many ORMs either lack robust migration support or implement complex methods for simple schema changes. This can obscure the database schema, making it harder to understand and maintain. A database schema should be defined in clear SQL statements that can be tested in a SQL query editor. Tools like [dbmate](https://github.com/amacneil/dbmate) provide a mature solution for managing migrations, usable via CLI or in code. - Auto genearted models for select queries that will now force you to either use them or to map them to required model.
- **Excessive Code Generation**: ORMs often generate excessive code for various conditions and scenarios, much of which goes unused. ## Okay, what to do now, plain old sql queries?
Yes and No may hybrid. Plain old sql queries are not bad, just have have few concerns
- **Generated Models for Queries**: Auto-generated models for `SELECT` queries force you to either adopt them or map them to your applications models, adding complexity. - Change in schema are not detected well.
- Sql in jection issue if not using parameterized queries.
## A Hybrid Approach: Plain SQL Queries with `pgm` We can address these issues using pgm, pgm cli will help to cream light weight DB schema go files that will help in writing sql queries this can help keeping eye on schema changes, goal is not to hard code table and table.column names
Plain SQL queries are not inherently bad but come with challenges:
- **Schema Change Detection**: Changes in the database schema are not easily detected.
- **SQL Injection Risks**: Without parameterized queries, SQL injection becomes a concern.
`pgm` addresses these issues by providing a lightweight CLI tool that generates Go files for your database schema. These files help you write SQL queries while keeping track of schema changes, avoiding hardcoded table and column names.
## Generating `pgm` Schema Files
Run the following command to generate schema files:
## Generate pgm schema files
run following command to generate pgm schema files
```bash ```bash
go run code.partial.tech/go/pgm/cmd -o ./db ./schema.sql go run code.patial.tech/go/pgm/cmd -o ./db ./schema.sql
``` ```
once you have the schama files created you can use `pgm` as It will create bunch of files and filders under `./db` directory
```go ```go
package main package main
import "code.patial.tech/go/pgm"
import (
"code.partial.tech/go/pgm"
"myapp/db/user" // scham create by pgm/cmd
)
type MyModel struct { type MyModel struct {
ID string ID string
@@ -59,23 +53,22 @@ type MyModel struct {
} }
func main() { func main() {
println("Initializing pgx connection pool") println("init pgx connection pool")
pgm.InitPool(pgm.Config{ pgm.InitPool(pgm.Config{
ConnString: url, ConnString: url,
}) })
// Select query to fetch the first record // Select query with first record to scan
// Assumes the schema is defined in the "db" package with a User table // it is assuming that schema is already created and is in "db" package and has User table init
var v MyModel var v MyModel
err := db.User.Select(user.ID, user.Email). err := db.User.Select(user.ID, user.Email).
Where(user.Email.Like("anki%")). Where(user.Email.Like("anki%")).
First(context.TODO(), &v.ID, &v.Email) First(context.TODO(), &v.Email, &v.ID)
if err != nil { if err != nil {
println("Error:", err.Error()) println("error, ", err.Error())
return return
} }
println("User email:", v.Email) println("user email", v.Email)
} }
``` ```

29
pgm.go
View File

@@ -44,21 +44,6 @@ func (f Field) Count() Field {
return Field("COUNT(" + f.String() + ")") return Field("COUNT(" + f.String() + ")")
} }
// StringEscape will return a empty string for null value
func (f Field) StringEscape() Field {
return Field("COALESCE(" + f.String() + ", '')")
}
// NumberEscape will return a zero string for null value
func (f Field) NumberEscape() Field {
return Field("COALESCE(" + f.String() + ", 0)")
}
// BooleanEscape will return a false for null value
func (f Field) BooleanEscape() Field {
return Field("COALESCE(" + f.String() + ", FALSE)")
}
// Avg fn wrapping of field // Avg fn wrapping of field
func (f Field) Avg() Field { func (f Field) Avg() Field {
return Field("AVG(" + f.String() + ")") return Field("AVG(" + f.String() + ")")
@@ -88,24 +73,14 @@ func (f Field) Trim() Field {
return Field("TRIM(" + f.String() + ")") return Field("TRIM(" + f.String() + ")")
} }
func (f Field) IsNull() Conditioner {
col := f.String()
return &Cond{Field: col, op: " IS NULL", len: len(col) + 8}
}
func (f Field) IsNotNull() Conditioner {
col := f.String()
return &Cond{Field: col, op: " IS NOT NULL", len: len(col) + 12}
}
// Eq is equal // Eq is equal
func (f Field) Eq(val any) Conditioner { func (f Field) Eq(val any) Conditioner {
col := f.String() col := f.String()
return &Cond{Field: col, Val: val, op: " = $", len: len(col) + 5} return &Cond{Field: col, Val: val, op: " = $", len: len(col) + 5}
} }
// EqualFold will use LOWER(column_name) = LOWER(val) for comparision // EqualFold will user LOWER() for comparision
func (f Field) EqFold(val string) Conditioner { func (f Field) EqFold(val any) Conditioner {
col := f.String() col := f.String()
return &Cond{Field: "LOWER(" + col + ")", Val: val, op: " = LOWER($", action: CondActionNeedToClose, len: len(col) + 5} return &Cond{Field: "LOWER(" + col + ")", Val: val, op: " = LOWER($", action: CondActionNeedToClose, len: len(col) + 5}
} }

View File

@@ -30,7 +30,6 @@ func TestQryBuilder2(t *testing.T) {
Where( Where(
user.LastName.NEq(7), user.LastName.NEq(7),
user.Phone.Like("%123%"), user.Phone.Like("%123%"),
user.UpdatedAt.IsNotNull(),
user.Email.NotInSubQuery(db.User.Select(user.ID).Where(user.ID.Eq(123))), user.Email.NotInSubQuery(db.User.Select(user.ID).Where(user.ID.Eq(123))),
). ).
Limit(10). Limit(10).
@@ -40,7 +39,7 @@ func TestQryBuilder2(t *testing.T) {
expected := "SELECT users.email, users.first_name FROM users JOIN user_sessions ON users.id = user_sessions.user_id" + expected := "SELECT users.email, users.first_name FROM users JOIN user_sessions ON users.id = user_sessions.user_id" +
" JOIN branch_users ON users.id = branch_users.user_id WHERE users.id = $1 AND (users.status_id = $2 OR users.updated_at = $3)" + " JOIN branch_users ON users.id = branch_users.user_id WHERE users.id = $1 AND (users.status_id = $2 OR users.updated_at = $3)" +
" AND users.mfa_kind = $4 AND (users.first_name = $5 OR users.middle_name = $6) AND users.last_name != $7 AND users.phone" + " AND users.mfa_kind = $4 AND (users.first_name = $5 OR users.middle_name = $6) AND users.last_name != $7 AND users.phone" +
" LIKE $8 AND users.updated_at IS NOT NULL AND users.email NOT IN(SELECT users.id FROM users WHERE users.id = $9) LIMIT 10 OFFSET 100" " LIKE $8 AND users.email NOT IN(SELECT users.id FROM users WHERE users.id = $9) LIMIT 10 OFFSET 100"
if expected != got { if expected != got {
t.Errorf("\nexpected: %q\ngot: %q", expected, got) t.Errorf("\nexpected: %q\ngot: %q", expected, got)
} }
@@ -60,31 +59,7 @@ func TestSelectWithHaving(t *testing.T) {
} }
} }
func TestSelectWithJoin(t *testing.T) { // BenchmarkSelect-12 668817 1753 ns/op 4442 B/op 59 allocs/op
got := db.User.Select(user.Email, user.FirstName).
Join(db.UserSession, user.ID, usersession.UserID).
LeftJoin(db.BranchUser, user.ID, branchuser.UserID, pgm.Or(branchuser.RoleID.Eq("1"), branchuser.RoleID.Eq("2"))).
Where(
user.ID.Eq(3),
pgm.Or(
user.StatusID.Eq(4),
user.UpdatedAt.Eq(5),
),
).
Limit(10).
Offset(100).
String()
expected := "SELECT users.email, users.first_name " +
"FROM users JOIN user_sessions ON users.id = user_sessions.user_id " +
"LEFT JOIN branch_users ON users.id = branch_users.user_id AND (branch_users.role_id = $1 OR branch_users.role_id = $2) " +
"WHERE users.id = $3 AND (users.status_id = $4 OR users.updated_at = $5) " +
"LIMIT 10 OFFSET 100"
if expected != got {
t.Errorf("\nexpected: %q\ngot: %q", expected, got)
}
}
// BenchmarkSelect-12 638901 1860 ns/op 4266 B/op 61 allocs/op // BenchmarkSelect-12 638901 1860 ns/op 4266 B/op 61 allocs/op
func BenchmarkSelect(b *testing.B) { func BenchmarkSelect(b *testing.B) {
for b.Loop() { for b.Loop() {

14
qry.go
View File

@@ -21,10 +21,10 @@ type (
SelectClause interface { SelectClause interface {
// Join and Inner Join are same // Join and Inner Join are same
Join(m Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause Join(m Table, t1Field, t2Field Field) SelectClause
LeftJoin(m Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause LeftJoin(m Table, t1Field, t2Field Field) SelectClause
RightJoin(m Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause RightJoin(m Table, t1Field, t2Field Field) SelectClause
FullJoin(m Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause FullJoin(m Table, t1Field, t2Field Field) SelectClause
CrossJoin(m Table) SelectClause CrossJoin(m Table) SelectClause
WhereClause WhereClause
OrderByClause OrderByClause
@@ -208,17 +208,13 @@ func (cv *Cond) Condition(args *[]any, argIdx int) string {
} }
// 2. normal condition // 2. normal condition
var op string
if cv.Val != nil {
*args = append(*args, cv.Val) *args = append(*args, cv.Val)
var op string
if strings.HasSuffix(cv.op, "$") { if strings.HasSuffix(cv.op, "$") {
op = cv.op + strconv.Itoa(argIdx+1) op = cv.op + strconv.Itoa(argIdx+1)
} else { } else {
op = strings.Replace(cv.op, "$", "$"+strconv.Itoa(argIdx+1), 1) op = strings.Replace(cv.op, "$", "$"+strconv.Itoa(argIdx+1), 1)
} }
} else {
op = cv.op
}
if cv.action == CondActionNeedToClose { if cv.action == CondActionNeedToClose {
return cv.Field + op + ")" return cv.Field + op + ")"

View File

@@ -62,46 +62,23 @@ func (t Table) Select(field ...Field) SelectClause {
return qb return qb
} }
func (q *selectQry) Join(t Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause { func (q *selectQry) Join(t Table, t1Field, t2Field Field) SelectClause {
return q.buildJoin(t, "JOIN", t1Field, t2Field, cond...) q.join = append(q.join, "JOIN "+t.Name+" ON "+t1Field.String()+" = "+t2Field.String())
}
func (q *selectQry) LeftJoin(t Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause {
return q.buildJoin(t, "LEFT JOIN", t1Field, t2Field, cond...)
}
func (q *selectQry) RightJoin(t Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause {
return q.buildJoin(t, "RIGHT JOIN", t1Field, t2Field, cond...)
}
func (q *selectQry) FullJoin(t Table, t1Field, t2Field Field, cond ...Conditioner) SelectClause {
return q.buildJoin(t, "FULL JOIN", t1Field, t2Field, cond...)
}
func (q *selectQry) buildJoin(t Table, joinKW string, t1Field, t2Field Field, cond ...Conditioner) SelectClause {
str := joinKW + " " + t.Name + " ON " + t1Field.String() + " = " + t2Field.String()
if len(cond) == 0 { // Join with no condition
q.join = append(q.join, str)
return q return q
} }
// Join has condition(s) func (q *selectQry) LeftJoin(t Table, t1Field, t2Field Field) SelectClause {
sb := getSB() q.join = append(q.join, "LEFT JOIN "+t.Name+" ON "+t1Field.String()+" = "+t2Field.String())
defer putSB(sb) return q
sb.Grow(len(str) * 2) }
sb.WriteString(str + " AND ") func (q *selectQry) RightJoin(t Table, t1Field, t2Field Field) SelectClause {
q.join = append(q.join, "RIGHT JOIN "+t.Name+" ON "+t1Field.String()+" = "+t2Field.String())
return q
}
var argIdx int func (q *selectQry) FullJoin(t Table, t1Field, t2Field Field) SelectClause {
for i, c := range cond { q.join = append(q.join, "FULL JOIN "+t.Name+" ON "+t1Field.String()+" = "+t2Field.String())
argIdx = len(q.args)
if i > 0 {
sb.WriteString(" AND ")
}
sb.WriteString(c.Condition(&q.args, argIdx))
}
q.join = append(q.join, sb.String())
return q return q
} }