sqlboiler and ent

Author: gmhafiz

Diff for: Makefile

@@ -1,8 +1,26 @@
+.PHONY : init sqlboiler run all
+
 init:
 	go install github.com/kyleconroy/sqlc/cmd/sqlc@latest
 	go get -u gorm.io/gorm
 	go get -u gorm.io/driver/postgres
+	go install github.com/volatiletech/sqlboiler/v4@latest
+	go install github.com/volatiletech/sqlboiler/v4/drivers/sqlboiler-psql@latest
+	go get -d entgo.io/ent/cmd/ent
 	go mod tidy
 
-sqlcgen:
-	sqlc generate
+sqlboiler:
+	sqlboiler --output db/sqlboiler/models psql
+
+run:
+	go mod tidy
+	go vet ./...
+	go fmt ./...
+	go run main.go
+
+all: init sqlboiler
+	go mod tidy
+	go vet ./...
+	go fmt ./...
+	go generate ./...
+	go run main.go

Diff for: README.md

@@ -0,0 +1,44 @@
+#  Introduction
+
+Examples of using various popular database libraries and ORM in Go.
+
+ - [sqlx](https://jmoiron.github.io/sqlx/)
+ - [sqlc](https://docs.sqlc.dev)
+ - [Gorm](https://github.com/go-gorm/gorm)
+ - [sqlboiler](https://github.com/volatiletech/sqlboiler)
+ - [ent](https://entgo.io/docs/getting-started)
+
+The aim is to demonstrate and compare usage for several operations
+
+ 1. Simple CRUD operation
+ 2. 1-1 queries
+ 3. 1-to-Many queries
+ 4. Many-to-many queries
+ 5. Dynamic list filter from query parameter 
+ 6. Transaction
+
+The schema contains optional fields, for example middle name, and a field that must not be returned, for example, a password.
+
+
+# Usage
+
+## Setup
+
+Setup postgres database by either running from docker-compose or manually.
+
+    docker-compose up 
+
+This creates both `postgres` database (which this repo uses) and `ent` database which is used by ent ORM.
+
+Default database credentials are defined in `config/config.go`. These can be overwritten by setting environment variables. For example:
+
+    export DB_NAME=test_db
+
+## Run
+
+Run with
+
+    go run main.go
+
+
+Run examples from `examples` folder.

Diff for: database/01-schema.sql

@@ -1,3 +1,5 @@
+BEGIN;
+
 create table countries
 (
     id   bigint generated always as identity
@@ -17,7 +19,7 @@ create table addresses
     state      text,
     country_id bigint
         constraint addresses_countries_id_fk
-            references countries
+            references countries ON DELETE CASCADE
 );
 
 create table users
@@ -35,12 +37,24 @@ create table user_addresses
 (
     user_id    bigint
         constraint user_addresses_users_id_fk
-            references users,
+            references users ON DELETE CASCADE ,
     address_id bigint
         constraint user_addresses_addresses_id_fk
-            references addresses
+            references addresses ON DELETE CASCADE ,
+    constraint user_addresses_pk
+        primary key (user_id, address_id)
 );
 
+CREATE VIEW country_address as
+select c.id, c.code, c.name,
+       (
+           select array_to_json(array_agg(row_to_json(addresslist.*))) as array_to_json
+           from (
+                    select a.*
+                    from addresses a
+                    where c.id = a.country_id
+                ) addresslist) as addresses
+from countries AS c;
 
 INSERT INTO countries (code, name)
 VALUES ('AU', 'Australia');
@@ -55,4 +69,6 @@ VALUES ('Petronas Twin Towers', '', 50088, 'Kuala Lumpur', 'Wilayah Persekutuan'
 INSERT INTO users (first_name, last_name, email, password)
 VALUES ('John', 'Doe', '[email protected]', '$argon2id$v=19$m=16,t=2,p=1$SHVrWmRXc2tqOW5TWmVrRw$QCPRZ0MmOB/AEEMVB1LudA'); -- password
 INSERT INTO users (first_name, last_name, email, password)
-VALUES ('Jane', 'Doe', '[email protected]', '$argon2id$v=19$m=16,t=2,p=1$UDB3RXNPd3ZEWHQ4ZTRNVg$LhHurQuz9Q9dDEG1VNzbFg'); -- password
+VALUES ('Jane', 'Doe', '[email protected]', '$argon2id$v=19$m=16,t=2,p=1$UDB3RXNPd3ZEWHQ4ZTRNVg$LhHurQuz9Q9dDEG1VNzbFg'); -- password
+
+COMMIT;

Diff for: database/query.sql

@@ -15,5 +15,32 @@ FROM users
 ORDER BY last_name;
 
 -- name: DeleteUser :exec
-DELETE FROM users
-WHERE id = $1;
+DELETE
+FROM users
+WHERE id = $1;
+
+-- name: UpdateUser :exec
+UPDATE users
+SET first_name=$1,
+    middle_name=$2,
+    last_name=$3,
+    email=$4
+WHERE id = $5;
+
+-- name: CountriesWithAddress :many
+SELECT c.id AS country_id,
+       c.name,
+       c.code,
+       a.id AS address_id,
+       a.line_1,
+       a.line_2,
+       a.postcode,
+       a.city,
+       a.state
+FROM countries c
+         LEFT JOIN addresses a on c.id = a.country_id
+ORDER BY c.id;
+
+
+-- name: CountriesWithAddressAggregate :many
+select row_to_json(row) from (select * from country_address) row;

Diff for: db/ent/database.go

@@ -0,0 +1,52 @@
+package ent
+
+import (
+	"context"
+	"database/sql"
+	"fmt"
+	"log"
+	"os"
+
+	"entgo.io/ent/dialect"
+	entsql "entgo.io/ent/dialect/sql"
+
+	"godb/config"
+	"godb/db/ent/ent/gen"
+)
+
+type database struct {
+	db *gen.Client
+}
+
+func New(cfg config.Database) *gen.Client {
+	db, err := sql.Open("pgx", fmt.Sprintf("host=%s port=%d user=%s dbname=%s password=%s sslmode=%s", cfg.Host, cfg.Port, cfg.User, "ent", cfg.Password, cfg.SSLMode))
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	drv := entsql.OpenDB(dialect.Postgres, db)
+
+	client := gen.NewClient(gen.Driver(drv))
+
+	f, err := os.Create("./db/ent/migrate.sql")
+	if err != nil {
+		log.Fatalf("create migrate file: %v", err)
+	}
+	defer f.Close()
+
+	if err := client.Schema.Create(context.Background()); err != nil {
+		log.Fatalf("failed creating schema resources: %v", err)
+	}
+
+	if err := client.Schema.WriteTo(context.Background(), f); err != nil {
+		log.Fatalf("failed printing schema changes: %v", err)
+	}
+
+	return client
+}
+
+func NewRepo(db *gen.Client) *database {
+	return &database{
+		db: db,
+	}
+}