dbx

DBX

Wrappers around database/sql for Postgres, SQLite3 and MySQL.

This is not an ORM but a set of granular wrappers for devs that enjoy hand tailor SQL queries but don't want to get bogged down in tedious CRUD operations and mappings.

From the rawest resource to the finest:

• The library code has only one public method:

  • dbx.Open(driver string, source string) *DB

• DB, operates with raw SQL strings and a parameter list:

  • dbx.Open(driver string, source string) *DB
  • DB.Close() error
  • DB.Read(query string, params ...any) []maps[string]any
  • DB.Write(query string, params ...any) int64

• Query, fluent query builder, used by other resources but can be used to assemble SQL queries but doesn't run them.

• Entry, loads a SQL query from and into a native go map(s).

• Record, has simply two methods:

  • Record.Load(id int64), load the record with id into the .Data map
  • Record.Save() bool, updates or creates the loaded record into the database.

  Internally it exposes the SQL row data via its .Data field. Its private .id field tracks if an UPDATE or an INSERT is required for a Save().

Todos

Add an embedded Model that understands its own parent struct fields and supports validation.

Examples

Using SQLite3 and a record:

package main

import (
    "github.com/jpedro/dbx"
)

func main() {
    db := dbx.Open(dbx.DriverSqlite3, "./example.db")
    record := db.Record("users")
    record.Data["name"] = "some record"
    record.Data["password"] = "initial"
    saved := record.Save()
    println("Saved:", saved)

    record.Data["password"] = "UPDATED"
    updated := record.Save()
    println("Updated:", updated)

    rows := db.Read("SELECT * FROM users")
    println("All users:", rows)
    db.Close()
}

Using Postgres and an entry:

package main

import (
    "github.com/jpedro/dbx"
)

func main() {
    db := dbx.Open(dbx.DriverPostgres, "postgres://tests:tests@127.0.0.1:5432/tests?sslmode=disable")
    entry := db.Entry("users")
    newId := entry.Create("users", map[string]any{
        "name": "some entry",
        "age":  456,
    })
    println("Created user:", newId)

    found := entry.Get(newId)
    println("Found entry:", found)

    rows := db.Read("SELECT * FROM users")
    println("All users:", rows)
    db.Close()
}