├── LICENSE
├── README.md
├── _examples
├── authors
│ ├── README.md
│ ├── pgx
│ │ ├── Dockerfile
│ │ ├── configs
│ │ │ └── reflex.conf
│ │ ├── docker-compose.yml
│ │ ├── gen.sh
│ │ ├── go.mod
│ │ ├── go.sum
│ │ ├── internal
│ │ │ ├── authors
│ │ │ │ ├── db.go
│ │ │ │ ├── models.go
│ │ │ │ ├── querier.go
│ │ │ │ ├── queries.sql.go
│ │ │ │ ├── routes.go
│ │ │ │ ├── service.go
│ │ │ │ └── service_factory.go
│ │ │ └── server
│ │ │ │ └── encoding.go
│ │ ├── main.go
│ │ ├── migration.go
│ │ ├── openapi.yml
│ │ ├── registry.go
│ │ ├── sql
│ │ │ ├── migrations
│ │ │ │ ├── 001_authors.down.sql
│ │ │ │ └── 001_authors.up.sql
│ │ │ └── queries.sql
│ │ └── sqlc.yaml
│ ├── sqlite-frontend
│ │ ├── README.md
│ │ ├── gen.sh
│ │ ├── go.mod
│ │ ├── go.sum
│ │ ├── internal
│ │ │ ├── authors
│ │ │ │ ├── db.go
│ │ │ │ ├── models.go
│ │ │ │ ├── queries.sql.go
│ │ │ │ ├── routes.go
│ │ │ │ ├── service.go
│ │ │ │ └── service_factory.go
│ │ │ └── server
│ │ │ │ └── encoding.go
│ │ ├── main.go
│ │ ├── migration.go
│ │ ├── openapi.yml
│ │ ├── registry.go
│ │ ├── sql
│ │ │ ├── migrations
│ │ │ │ └── 001_authors.sql
│ │ │ └── queries.sql
│ │ ├── sqlc.yaml
│ │ └── view
│ │ │ ├── breadcrumbs.go
│ │ │ ├── content.go
│ │ │ ├── etag
│ │ │ └── etag.go
│ │ │ ├── message.go
│ │ │ ├── pagination.go
│ │ │ ├── static
│ │ │ ├── css
│ │ │ │ ├── bootstrap-icons.css
│ │ │ │ ├── bootstrap.min.css
│ │ │ │ ├── fonts
│ │ │ │ │ ├── bootstrap-icons.woff
│ │ │ │ │ └── bootstrap-icons.woff2
│ │ │ │ └── style.css
│ │ │ ├── js
│ │ │ │ ├── bootstrap.bundle.min.js
│ │ │ │ ├── htmx.min.js
│ │ │ │ └── init.js
│ │ │ └── swagger
│ │ │ │ └── index.html
│ │ │ ├── templates
│ │ │ ├── app
│ │ │ │ └── authors
│ │ │ │ │ ├── create_author.html
│ │ │ │ │ ├── delete_author.html
│ │ │ │ │ ├── get_author.html
│ │ │ │ │ ├── list_authors.html
│ │ │ │ │ ├── update_author.html
│ │ │ │ │ └── update_author_bio.html
│ │ │ ├── authors.html
│ │ │ ├── authors
│ │ │ │ └── {id}.html
│ │ │ ├── components
│ │ │ │ ├── breadcrumbs.html
│ │ │ │ ├── hx-context.html
│ │ │ │ ├── message.html
│ │ │ │ └── messages-context.html
│ │ │ ├── index.html
│ │ │ └── layout
│ │ │ │ ├── base.html
│ │ │ │ ├── content.html
│ │ │ │ ├── footer.html
│ │ │ │ └── header.html
│ │ │ ├── view.go
│ │ │ └── watcher
│ │ │ └── watcher.go
│ └── sqlite
│ │ ├── Dockerfile
│ │ ├── configs
│ │ └── reflex.conf
│ │ ├── docker-compose.yml
│ │ ├── gen.sh
│ │ ├── go.mod
│ │ ├── go.sum
│ │ ├── internal
│ │ ├── authors
│ │ │ ├── db.go
│ │ │ ├── models.go
│ │ │ ├── queries.sql.go
│ │ │ ├── routes.go
│ │ │ ├── service.go
│ │ │ └── service_factory.go
│ │ └── server
│ │ │ ├── encoding.go
│ │ │ ├── litefs
│ │ │ ├── forward.go
│ │ │ └── litefs.go
│ │ │ └── litestream
│ │ │ └── litestream.go
│ │ ├── main.go
│ │ ├── migration.go
│ │ ├── openapi.yml
│ │ ├── registry.go
│ │ ├── sql
│ │ ├── migrations
│ │ │ └── 001_authors.sql
│ │ └── queries.sql
│ │ └── sqlc.yaml
└── booktest
│ ├── Dockerfile
│ ├── README.md
│ ├── configs
│ ├── grafana
│ │ ├── dashboards
│ │ │ ├── dashboard.yml
│ │ │ └── grpc-dashboard.json
│ │ └── datasources
│ │ │ └── datasource.yml
│ ├── prometheus.yml
│ └── reflex.conf
│ ├── docker-compose.yml
│ ├── gen.sh
│ ├── go.mod
│ ├── go.sum
│ ├── internal
│ ├── books
│ │ ├── db.go
│ │ ├── models.go
│ │ ├── queries.sql.go
│ │ ├── routes.go
│ │ ├── service.go
│ │ └── service_factory.go
│ └── server
│ │ ├── encoding.go
│ │ └── instrumentation
│ │ ├── metric
│ │ └── metric.go
│ │ └── trace
│ │ └── tracing.go
│ ├── main.go
│ ├── openapi.yml
│ ├── registry.go
│ ├── sql
│ ├── queries.sql
│ └── schema.sql
│ └── sqlc.yaml
├── engine.go
├── go.mod
├── go.sum
├── main.go
├── metadata
├── bind.go
├── converter.go
├── frontend
│ ├── funcs.go
│ └── service_ui.go
└── openapi.go
├── templates
├── internal
│ └── server
│ │ ├── encoding.go.tmpl
│ │ ├── instrumentation
│ │ ├── metric
│ │ │ └── metric.go.tmpl
│ │ └── trace
│ │ │ └── tracing.go.tmpl
│ │ ├── litefs
│ │ ├── forward.go.tmpl
│ │ └── litefs.go.tmpl
│ │ └── litestream
│ │ └── litestream.go.tmpl
├── main.go.tmpl
├── migration.go.tmpl
├── openapi.yml.tmpl
├── registry.go.tmpl
├── routes.go.tmpl
├── service.go.tmpl
├── service_factory.go.tmpl
├── templates.go
└── view
│ ├── breadcrumbs.go.tmpl
│ ├── content.go.tmpl
│ ├── etag
│ └── etag.go
│ ├── message.go.tmpl
│ ├── pagination.go.tmpl
│ ├── static
│ ├── css
│ │ ├── bootstrap-icons.css
│ │ ├── bootstrap.min.css
│ │ ├── fonts
│ │ │ ├── bootstrap-icons.woff
│ │ │ └── bootstrap-icons.woff2
│ │ └── style.css
│ ├── js
│ │ ├── bootstrap.bundle.min.js
│ │ ├── htmx.min.js
│ │ └── init.js
│ └── swagger
│ │ └── index.html.tmpl
│ ├── templates
│ ├── app
│ │ ├── request.html.tmpl
│ │ └── response.html.tmpl
│ ├── components
│ │ ├── breadcrumbs.html.tmpl
│ │ ├── hx-context.html
│ │ ├── message.html
│ │ └── messages-context.html
│ ├── index.html.tmpl
│ └── layout
│ │ ├── base.html
│ │ ├── content.html
│ │ ├── footer.html
│ │ └── header.html.tmpl
│ ├── view.go.tmpl
│ └── watcher
│ └── watcher.go.tmpl
└── version.go
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2024 Walter Wanderley
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## sqlc-http
2 |
3 | Create a **net/http Server** from the generated code by the awesome [sqlc](https://sqlc.dev/) project. If you’re searching for a SQLC plugin, use [sqlc-gen-go-server](https://github.com/walterwanderley/sqlc-gen-go-server/).
4 |
5 | ### Requirements
6 |
7 | - Go 1.23 or superior
8 | - [sqlc](https://sqlc.dev/)
9 |
10 | ```sh
11 | go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
12 | ```
13 |
14 | ### Installation
15 |
16 | ```sh
17 | go install github.com/walterwanderley/sqlc-http@latest
18 | ```
19 |
20 | ### Fullstack application example (HTMX)
21 |
22 | If you want to generate a complete application (including htmx frontend), check [this example](https://github.com/walterwanderley/sqlc-http/blob/main/_examples/authors/sqlite-frontend/README.md).
23 |
24 | ### Example
25 |
26 | 1. Create a queries.sql file:
27 |
28 | ```sql
29 | --queries.sql
30 |
31 | CREATE TABLE authors (
32 | id BIGSERIAL PRIMARY KEY,
33 | name text NOT NULL,
34 | bio text,
35 | created_at TIMESTAMP
36 | );
37 |
38 | -- name: GetAuthor :one
39 | -- http: GET /authors/{id}
40 | SELECT * FROM authors
41 | WHERE id = $1 LIMIT 1;
42 |
43 | -- name: ListAuthors :many
44 | -- http: GET /authors
45 | SELECT * FROM authors
46 | ORDER BY name;
47 |
48 | -- name: CreateAuthor :one
49 | -- http: POST /authors
50 | INSERT INTO authors (
51 | name, bio, created_at
52 | ) VALUES (
53 | $1, $2, $3
54 | )
55 | RETURNING *;
56 |
57 | -- name: DeleteAuthor :exec
58 | -- http: DELETE /authors/{id}
59 | DELETE FROM authors
60 | WHERE id = $1;
61 |
62 | -- name: UpdateAuthorBio :exec
63 | -- http: PATCH /authors/{id}/bio
64 | UPDATE authors
65 | SET bio = $1
66 | WHERE id = $2;
67 | ```
68 |
69 | 2. Create a sqlc.yaml file
70 |
71 | ```yaml
72 | version: "2"
73 | sql:
74 | - schema: "./queries.sql"
75 | queries: "./queries.sql"
76 | engine: "postgresql"
77 | gen:
78 | go:
79 | out: "internal/author"
80 | ```
81 |
82 | 3. Execute sqlc
83 |
84 | ```sh
85 | sqlc generate
86 | ```
87 |
88 | 4. Execute sqlc-http
89 |
90 | ```sh
91 | sqlc-http -m "mymodule"
92 | ```
93 |
94 | If you want to generate the frontend (htmx):
95 |
96 | ```sh
97 | sqlc-http -m "mymodule" -frontend
98 | ```
99 |
100 |
101 | 5. Run the generated server
102 |
103 | ```sh
104 | go run . -db [Database Connection URL] -dev
105 | ```
106 |
107 | 6. Enjoy!
108 |
109 | If you do not generate the frontend in step 4?
110 |
111 | - Swagger UI: [http://localhost:5000/swagger](http://localhost:5000/swagger)
112 |
113 | If you generate the frontend in step 4:
114 |
115 | - [HTMX](https://htmx.org) frontend: [http://localhost:5000](http://localhost:5000)
116 | - Swagger UI: [http://localhost:5000/static/swagger](http://localhost:5000/static/swagger)
117 |
118 | ### Customizing HTTP endpoints
119 |
120 | You can customize the HTTP endpoints by adding comments to the queries.
121 |
122 | ```sql
123 | -- http: Method Path
124 | ```
125 |
126 | Here’s an example of a queries file that has a custom HTTP endpoint:
127 | ```sql
128 | -- name: ListAuthors :many
129 | -- http: GET /authors
130 | SELECT * FROM authors
131 | ORDER BY name;
132 |
133 | -- name: UpdateAuthorBio :exec
134 | -- http: PATCH /authors/{id}/bio
135 | UPDATE authors
136 | SET bio = $1
137 | WHERE id = $2;
138 | ```
139 |
140 |
141 | ### Editing the generated code
142 |
143 | - It's safe to edit any generated code that doesn't have the `DO NOT EDIT` indication at the very first line.
144 |
145 | - After modify a SQL file, execute these commands below:
146 |
147 | ```sh
148 | sqlc generate
149 | go generate
150 | ```
151 |
152 | ### Similar Projects
153 |
154 | - [sqlc-connect](https://github.com/walterwanderley/sqlc-connect)
155 | - [sqlc-grpc](https://github.com/walterwanderley/sqlc-grpc)
156 | - [xo-grpc](https://github.com/walterwanderley/xo-grpc)
--------------------------------------------------------------------------------
/_examples/authors/README.md:
--------------------------------------------------------------------------------
1 | # About
2 |
3 | Author example taken from [sqlc][sqlc] Git repository [examples][sqlc-git].
4 |
5 | [sqlc]: https://sqlc.dev
6 | [sqlc-git]: https://github.com/sqlc-dev/sqlc/tree/main/examples/authors
7 |
8 | ## Running
9 |
10 | ```sh
11 | ./gen.sh
12 | docker compose up
13 | ```
14 |
15 | ### Exploring the API
16 |
17 | http://localhost:8080/swagger
18 |
19 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM golang:1.24
2 |
3 | RUN go install github.com/cespare/reflex@latest
4 |
5 | WORKDIR /app
6 | COPY go.mod .
7 | COPY go.sum .
8 |
9 | RUN go mod download -x
10 |
11 | COPY configs/reflex.conf /
12 |
13 | ENTRYPOINT ["reflex", "-c", "/reflex.conf"]
--------------------------------------------------------------------------------
/_examples/authors/pgx/configs/reflex.conf:
--------------------------------------------------------------------------------
1 | -r '(\.go$|go\.mod)' -s -- sh -c 'go run . -db postgres://postgres:secret@postgres:5432/postgres?sslmode=disable -port 8080 -dev'
2 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: '3'
2 | services:
3 | app:
4 | build: .
5 | ports:
6 | - "8080:8080"
7 | volumes:
8 | - .:/app
9 | depends_on:
10 | - postgres
11 |
12 | postgres:
13 | image: postgres
14 | environment:
15 | - POSTGRES_USER=postgres
16 | - POSTGRES_PASSWORD=secret
17 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/gen.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | set -u
3 | set -e
4 | set -x
5 |
6 | go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
7 |
8 | rm -rf internal proto api go.mod go.sum main.go registry.go openapi.yml
9 |
10 | sqlc generate
11 | sqlc-http -m authors -migration-path sql/migrations -migration-lib migrate
12 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/go.mod:
--------------------------------------------------------------------------------
1 | module authors
2 |
3 | go 1.24.3
4 |
5 | require (
6 | github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b
7 | github.com/go-playground/form/v4 v4.2.1
8 | github.com/golang-migrate/migrate/v4 v4.18.3
9 | github.com/jackc/pgx/v5 v5.7.5
10 | go.uber.org/automaxprocs v1.6.0
11 | )
12 |
13 | require (
14 | github.com/hashicorp/errwrap v1.1.0 // indirect
15 | github.com/hashicorp/go-multierror v1.1.1 // indirect
16 | github.com/jackc/pgerrcode v0.0.0-20220416144525-469b46aa5efa // indirect
17 | github.com/jackc/pgpassfile v1.0.0 // indirect
18 | github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
19 | github.com/jackc/puddle/v2 v2.2.2 // indirect
20 | go.uber.org/atomic v1.7.0 // indirect
21 | golang.org/x/crypto v0.37.0 // indirect
22 | golang.org/x/sync v0.13.0 // indirect
23 | golang.org/x/text v0.24.0 // indirect
24 | )
25 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/db.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 |
5 | package authors
6 |
7 | import (
8 | "context"
9 |
10 | "github.com/jackc/pgx/v5"
11 | "github.com/jackc/pgx/v5/pgconn"
12 | )
13 |
14 | type DBTX interface {
15 | Exec(context.Context, string, ...interface{}) (pgconn.CommandTag, error)
16 | Query(context.Context, string, ...interface{}) (pgx.Rows, error)
17 | QueryRow(context.Context, string, ...interface{}) pgx.Row
18 | }
19 |
20 | func New() *Queries {
21 | return &Queries{}
22 | }
23 |
24 | type Queries struct {
25 | }
26 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/models.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 |
5 | package authors
6 |
7 | import (
8 | "github.com/jackc/pgx/v5/pgtype"
9 | )
10 |
11 | type Authors struct {
12 | ID int64 `json:"id"`
13 | Name string `json:"name"`
14 | Bio pgtype.Text `json:"bio"`
15 | }
16 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/querier.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 |
5 | package authors
6 |
7 | import (
8 | "context"
9 | )
10 |
11 | type Querier interface {
12 | CreateAuthor(ctx context.Context, db DBTX, arg *CreateAuthorParams) (*Authors, error)
13 | DeleteAuthor(ctx context.Context, db DBTX, id int64) error
14 | GetAuthor(ctx context.Context, db DBTX, id int64) (*Authors, error)
15 | ListAuthors(ctx context.Context, db DBTX) ([]*Authors, error)
16 | }
17 |
18 | var _ Querier = (*Queries)(nil)
19 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/queries.sql.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 | // source: queries.sql
5 |
6 | package authors
7 |
8 | import (
9 | "context"
10 |
11 | "github.com/jackc/pgx/v5/pgtype"
12 | )
13 |
14 | const CreateAuthor = `-- name: CreateAuthor :one
15 | INSERT INTO authors (
16 | name, bio
17 | ) VALUES (
18 | $1, $2
19 | )
20 | RETURNING id, name, bio
21 | `
22 |
23 | type CreateAuthorParams struct {
24 | Name string `json:"name"`
25 | Bio pgtype.Text `json:"bio"`
26 | }
27 |
28 | func (q *Queries) CreateAuthor(ctx context.Context, db DBTX, arg *CreateAuthorParams) (*Authors, error) {
29 | row := db.QueryRow(ctx, CreateAuthor, arg.Name, arg.Bio)
30 | var i Authors
31 | err := row.Scan(&i.ID, &i.Name, &i.Bio)
32 | return &i, err
33 | }
34 |
35 | const DeleteAuthor = `-- name: DeleteAuthor :exec
36 | DELETE FROM authors
37 | WHERE id = $1
38 | `
39 |
40 | func (q *Queries) DeleteAuthor(ctx context.Context, db DBTX, id int64) error {
41 | _, err := db.Exec(ctx, DeleteAuthor, id)
42 | return err
43 | }
44 |
45 | const GetAuthor = `-- name: GetAuthor :one
46 | SELECT id, name, bio FROM authors
47 | WHERE id = $1 LIMIT 1
48 | `
49 |
50 | func (q *Queries) GetAuthor(ctx context.Context, db DBTX, id int64) (*Authors, error) {
51 | row := db.QueryRow(ctx, GetAuthor, id)
52 | var i Authors
53 | err := row.Scan(&i.ID, &i.Name, &i.Bio)
54 | return &i, err
55 | }
56 |
57 | const ListAuthors = `-- name: ListAuthors :many
58 | SELECT id, name, bio FROM authors
59 | ORDER BY name
60 | `
61 |
62 | func (q *Queries) ListAuthors(ctx context.Context, db DBTX) ([]*Authors, error) {
63 | rows, err := db.Query(ctx, ListAuthors)
64 | if err != nil {
65 | return nil, err
66 | }
67 | defer rows.Close()
68 | items := []*Authors{}
69 | for rows.Next() {
70 | var i Authors
71 | if err := rows.Scan(&i.ID, &i.Name, &i.Bio); err != nil {
72 | return nil, err
73 | }
74 | items = append(items, &i)
75 | }
76 | if err := rows.Err(); err != nil {
77 | return nil, err
78 | }
79 | return items, nil
80 | }
81 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/routes.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http). DO NOT EDIT.
2 |
3 | package authors
4 |
5 | import "net/http"
6 |
7 | func (s *Service) RegisterHandlers(mux *http.ServeMux) {
8 | mux.HandleFunc("POST /author", s.handleCreateAuthor())
9 | mux.HandleFunc("DELETE /author/{id}", s.handleDeleteAuthor())
10 | mux.HandleFunc("GET /author/{id}", s.handleGetAuthor())
11 | mux.HandleFunc("GET /authors", s.handleListAuthors())
12 | }
13 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/service.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http). DO NOT EDIT.
2 |
3 | package authors
4 |
5 | import (
6 | "log/slog"
7 | "net/http"
8 | "strconv"
9 |
10 | "github.com/jackc/pgx/v5/pgtype"
11 | "github.com/jackc/pgx/v5/pgxpool"
12 |
13 | "authors/internal/server"
14 | )
15 |
16 | type Service struct {
17 | querier Querier
18 | db *pgxpool.Pool
19 | }
20 |
21 | func (s *Service) handleCreateAuthor() http.HandlerFunc {
22 | type request struct {
23 | Name string `json:"name"`
24 | Bio *string `json:"bio"`
25 | }
26 | type response struct {
27 | ID int64 `json:"id,omitempty"`
28 | Name string `json:"name,omitempty"`
29 | Bio *string `json:"bio,omitempty"`
30 | }
31 |
32 | return func(w http.ResponseWriter, r *http.Request) {
33 | req, err := server.Decode[request](r)
34 | if err != nil {
35 | http.Error(w, err.Error(), http.StatusUnprocessableEntity)
36 | return
37 | }
38 | arg := new(CreateAuthorParams)
39 | arg.Name = req.Name
40 | if req.Bio != nil {
41 | arg.Bio = pgtype.Text{Valid: true, String: *req.Bio}
42 | }
43 |
44 | result, err := s.querier.CreateAuthor(r.Context(), s.db, arg)
45 | if err != nil {
46 | slog.Error("sql call failed", "error", err, "method", "CreateAuthor")
47 | http.Error(w, err.Error(), http.StatusInternalServerError)
48 | return
49 | }
50 |
51 | var res response
52 | res.ID = result.ID
53 | res.Name = result.Name
54 | if result.Bio.Valid {
55 | res.Bio = &result.Bio.String
56 | }
57 | server.Encode(w, r, http.StatusOK, res)
58 | }
59 | }
60 |
61 | func (s *Service) handleDeleteAuthor() http.HandlerFunc {
62 | type request struct {
63 | Id int64 `json:"id"`
64 | }
65 |
66 | return func(w http.ResponseWriter, r *http.Request) {
67 | var req request
68 | if str := r.PathValue("id"); str != "" {
69 | if v, err := strconv.ParseInt(str, 10, 64); err != nil {
70 | http.Error(w, err.Error(), http.StatusBadRequest)
71 | return
72 | } else {
73 | req.Id = v
74 | }
75 | }
76 | id := req.Id
77 |
78 | err := s.querier.DeleteAuthor(r.Context(), s.db, id)
79 | if err != nil {
80 | slog.Error("sql call failed", "error", err, "method", "DeleteAuthor")
81 | http.Error(w, err.Error(), http.StatusInternalServerError)
82 | return
83 | }
84 |
85 | }
86 | }
87 |
88 | func (s *Service) handleGetAuthor() http.HandlerFunc {
89 | type request struct {
90 | Id int64 `json:"id"`
91 | }
92 | type response struct {
93 | ID int64 `json:"id,omitempty"`
94 | Name string `json:"name,omitempty"`
95 | Bio *string `json:"bio,omitempty"`
96 | }
97 |
98 | return func(w http.ResponseWriter, r *http.Request) {
99 | var req request
100 | if str := r.PathValue("id"); str != "" {
101 | if v, err := strconv.ParseInt(str, 10, 64); err != nil {
102 | http.Error(w, err.Error(), http.StatusBadRequest)
103 | return
104 | } else {
105 | req.Id = v
106 | }
107 | }
108 | id := req.Id
109 |
110 | result, err := s.querier.GetAuthor(r.Context(), s.db, id)
111 | if err != nil {
112 | slog.Error("sql call failed", "error", err, "method", "GetAuthor")
113 | http.Error(w, err.Error(), http.StatusInternalServerError)
114 | return
115 | }
116 |
117 | var res response
118 | res.ID = result.ID
119 | res.Name = result.Name
120 | if result.Bio.Valid {
121 | res.Bio = &result.Bio.String
122 | }
123 | server.Encode(w, r, http.StatusOK, res)
124 | }
125 | }
126 |
127 | func (s *Service) handleListAuthors() http.HandlerFunc {
128 | type response struct {
129 | ID int64 `json:"id,omitempty"`
130 | Name string `json:"name,omitempty"`
131 | Bio *string `json:"bio,omitempty"`
132 | }
133 |
134 | return func(w http.ResponseWriter, r *http.Request) {
135 |
136 | result, err := s.querier.ListAuthors(r.Context(), s.db)
137 | if err != nil {
138 | slog.Error("sql call failed", "error", err, "method", "ListAuthors")
139 | http.Error(w, err.Error(), http.StatusInternalServerError)
140 | return
141 | }
142 |
143 | res := make([]response, 0)
144 | for _, r := range result {
145 | var item response
146 | item.ID = r.ID
147 | item.Name = r.Name
148 | if r.Bio.Valid {
149 | item.Bio = &r.Bio.String
150 | }
151 | res = append(res, item)
152 | }
153 | server.Encode(w, r, http.StatusOK, res)
154 | }
155 | }
156 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/authors/service_factory.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package authors
4 |
5 | import (
6 | "github.com/jackc/pgx/v5/pgxpool"
7 | )
8 |
9 | // NewService is a constructor of a interface { func RegisterHandlers(*http.ServeMux) } implementation.
10 | // Use this function to customize the server by adding middlewares to it.
11 | func NewService(querier Querier, db *pgxpool.Pool) *Service {
12 | return &Service{querier: querier, db: db}
13 | }
14 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/internal/server/encoding.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package server
4 |
5 | import (
6 | "encoding/json"
7 | "fmt"
8 | "net/http"
9 |
10 | "github.com/go-playground/form/v4"
11 | )
12 |
13 | var formDecoder *form.Decoder
14 |
15 | func init() {
16 | formDecoder = form.NewDecoder()
17 | formDecoder.SetTagName("json")
18 |
19 | }
20 |
21 | func Decode[T any](r *http.Request) (T, error) {
22 | var v T
23 | if r.Header.Get("Content-Type") == "application/x-www-form-urlencoded" {
24 | if err := r.ParseForm(); err != nil {
25 | return v, fmt.Errorf("parse form: %w", err)
26 | }
27 | if err := formDecoder.Decode(&v, r.Form); err != nil {
28 | return v, fmt.Errorf("decode form: %w", err)
29 | }
30 | } else {
31 | if err := json.NewDecoder(r.Body).Decode(&v); err != nil {
32 | return v, fmt.Errorf("decode json: %w", err)
33 | }
34 | }
35 | return v, nil
36 | }
37 |
38 | func Encode[T any](w http.ResponseWriter, r *http.Request, status int, v T) error {
39 |
40 | w.Header().Set("Content-Type", "application/json")
41 | w.WriteHeader(status)
42 | if err := json.NewEncoder(w).Encode(v); err != nil {
43 | return fmt.Errorf("encode json: %w", err)
44 | }
45 | return nil
46 | }
47 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/main.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package main
4 |
5 | import (
6 | "context"
7 | "database/sql"
8 | _ "embed"
9 | "errors"
10 | "flag"
11 | "fmt"
12 | "log/slog"
13 | "net/http"
14 | "os"
15 | "os/signal"
16 | "runtime"
17 | "syscall"
18 | "time"
19 |
20 | "github.com/flowchartsman/swaggerui"
21 | "go.uber.org/automaxprocs/maxprocs"
22 |
23 | // database driver
24 | "github.com/jackc/pgx/v5/pgxpool"
25 | _ "github.com/jackc/pgx/v5/stdlib"
26 | )
27 |
28 | //go:generate sqlc-http -m authors -migration-path sql/migrations -migration-lib migrate -append
29 |
30 | const serviceName = "authors"
31 |
32 | var (
33 | dev bool
34 | dbURL string
35 | port int
36 |
37 | //go:embed openapi.yml
38 | openAPISpec []byte
39 | )
40 |
41 | func main() {
42 | flag.StringVar(&dbURL, "db", "", "The Database connection URL")
43 | flag.IntVar(&port, "port", 5000, "The server port")
44 |
45 | flag.BoolVar(&dev, "dev", false, "Set logger to development mode")
46 |
47 | flag.Parse()
48 |
49 | initLogger()
50 |
51 | if err := run(); err != nil && !errors.Is(err, http.ErrServerClosed) {
52 | slog.Error("server error", "error", err)
53 | os.Exit(1)
54 | }
55 | }
56 |
57 | func run() error {
58 | _, err := maxprocs.Set()
59 | if err != nil {
60 | slog.Warn("startup", "error", err)
61 | }
62 | slog.Info("startup", "GOMAXPROCS", runtime.GOMAXPROCS(0))
63 |
64 | db, err := pgxpool.New(context.Background(), dbURL)
65 | if err != nil {
66 | return err
67 | }
68 | defer db.Close()
69 |
70 | dbMigration, err := sql.Open("pgx", dbURL)
71 | if err != nil {
72 | return err
73 | }
74 | err = ensureSchema(dbMigration)
75 | if err != nil {
76 | slog.Error("migration error", "error", err)
77 | }
78 | dbMigration.Close()
79 |
80 | mux := http.NewServeMux()
81 | registerHandlers(mux, db)
82 |
83 | mux.Handle("GET /swagger/", http.StripPrefix("/swagger", swaggerui.Handler(openAPISpec)))
84 |
85 | server := &http.Server{
86 | Addr: fmt.Sprintf(":%d", port),
87 | Handler: mux,
88 | // Please, configure timeouts!
89 | }
90 |
91 | done := make(chan os.Signal, 1)
92 | signal.Notify(done, os.Interrupt, syscall.SIGINT, syscall.SIGTERM)
93 | go func() {
94 | sig := <-done
95 | slog.Warn("signal detected...", "signal", sig)
96 | ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
97 | defer cancel()
98 | server.Shutdown(ctx)
99 | }()
100 | slog.Info("Listening...", "port", port)
101 | return server.ListenAndServe()
102 | }
103 |
104 | func initLogger() {
105 | var handler slog.Handler
106 | opts := slog.HandlerOptions{
107 | AddSource: true,
108 | }
109 | switch {
110 | case dev:
111 | handler = slog.NewTextHandler(os.Stderr, &opts)
112 | default:
113 | handler = slog.NewJSONHandler(os.Stderr, &opts)
114 | }
115 |
116 | logger := slog.New(handler)
117 | slog.SetDefault(logger)
118 | }
119 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/migration.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package main
4 |
5 | import (
6 | "database/sql"
7 | "embed"
8 |
9 | "github.com/golang-migrate/migrate/v4"
10 | driver "github.com/golang-migrate/migrate/v4/database/pgx/v5"
11 | "github.com/golang-migrate/migrate/v4/source/iofs"
12 | )
13 |
14 | //go:embed sql/migrations
15 | var migrations embed.FS
16 |
17 | func ensureSchema(db *sql.DB) error {
18 | source, err := iofs.New(migrations, "sql/migrations")
19 | if err != nil {
20 | return err
21 | }
22 | target, err := driver.WithInstance(db, new(driver.Config))
23 | if err != nil {
24 | return err
25 | }
26 | m, err := migrate.NewWithInstance("iofs", source, "postgresql", target)
27 | if err != nil {
28 | return err
29 | }
30 | err = m.Up()
31 | if err != nil && err != migrate.ErrNoChange {
32 | return err
33 | }
34 | return source.Close()
35 | }
36 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/openapi.yml:
--------------------------------------------------------------------------------
1 | openapi: 3.0.3
2 | info:
3 | description: authors Services
4 | title: authors
5 | version: 0.0.1
6 | contact:
7 | name: sqlc-http
8 | url: https://github.com/walterwanderley/sqlc-http
9 | tags:
10 | - authors
11 |
12 | paths:
13 | /author:
14 | post:
15 | tags:
16 | - authors
17 | summary: CreateAuthor
18 | requestBody:
19 | content:
20 | application/json:
21 | schema:
22 | type: object
23 | properties:
24 | name:
25 | type: string
26 | bio:
27 | type: string
28 | application/x-www-form-urlencoded:
29 | schema:
30 | type: object
31 | properties:
32 | name:
33 | type: string
34 | bio:
35 | type: string
36 |
37 | responses:
38 | "200":
39 | description: OK
40 | content:
41 | application/json:
42 | schema:
43 | $ref: "#/components/schemas/authorsAuthors"
44 |
45 | "default":
46 | description: Error message
47 | content:
48 | text/plain:
49 | schema:
50 | type: string
51 |
52 | /author/{id}:
53 | delete:
54 | tags:
55 | - authors
56 | summary: DeleteAuthor
57 | parameters:
58 | - name: id
59 | in: path
60 | schema:
61 | type: integer
62 | format: int64
63 |
64 | responses:
65 | "200":
66 | description: OK
67 |
68 | "default":
69 | description: Error message
70 | content:
71 | text/plain:
72 | schema:
73 | type: string
74 | get:
75 | tags:
76 | - authors
77 | summary: GetAuthor
78 | parameters:
79 | - name: id
80 | in: path
81 | schema:
82 | type: integer
83 | format: int64
84 |
85 | responses:
86 | "200":
87 | description: OK
88 | content:
89 | application/json:
90 | schema:
91 | $ref: "#/components/schemas/authorsAuthors"
92 |
93 | "default":
94 | description: Error message
95 | content:
96 | text/plain:
97 | schema:
98 | type: string
99 |
100 | /authors:
101 | get:
102 | tags:
103 | - authors
104 | summary: ListAuthors
105 |
106 | responses:
107 | "200":
108 | description: OK
109 | content:
110 | application/json:
111 | schema:
112 | type: array
113 | items:
114 | $ref: "#/components/schemas/authorsAuthors"
115 |
116 | "default":
117 | description: Error message
118 | content:
119 | text/plain:
120 | schema:
121 | type: string
122 |
123 |
124 | components:
125 | schemas:
126 | authorsAuthors:
127 | type: object
128 | properties:
129 | id:
130 | type: integer
131 | format: int64
132 | name:
133 | type: string
134 | bio:
135 | type: string
136 |
137 |
138 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/registry.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http). DO NOT EDIT.
2 |
3 | package main
4 |
5 | import (
6 | "net/http"
7 |
8 | "github.com/jackc/pgx/v5/pgxpool"
9 |
10 | authors_app "authors/internal/authors"
11 | )
12 |
13 | func registerHandlers(mux *http.ServeMux, db *pgxpool.Pool) {
14 | authorsService := authors_app.NewService(authors_app.New(), db)
15 | authorsService.RegisterHandlers(mux)
16 | }
17 |
--------------------------------------------------------------------------------
/_examples/authors/pgx/sql/migrations/001_authors.down.sql:
--------------------------------------------------------------------------------
1 | DROP TABLE IF EXISTS authors;
--------------------------------------------------------------------------------
/_examples/authors/pgx/sql/migrations/001_authors.up.sql:
--------------------------------------------------------------------------------
1 | CREATE TABLE IF NOT EXISTS authors (
2 | id BIGSERIAL PRIMARY KEY,
3 | name text NOT NULL,
4 | bio text
5 | );
--------------------------------------------------------------------------------
/_examples/authors/pgx/sql/queries.sql:
--------------------------------------------------------------------------------
1 | -- name: GetAuthor :one
2 | SELECT * FROM authors
3 | WHERE id = $1 LIMIT 1;
4 |
5 | -- name: ListAuthors :many
6 | SELECT * FROM authors
7 | ORDER BY name;
8 |
9 | -- name: CreateAuthor :one
10 | INSERT INTO authors (
11 | name, bio
12 | ) VALUES (
13 | $1, $2
14 | )
15 | RETURNING *;
16 |
17 | -- name: DeleteAuthor :exec
18 | DELETE FROM authors
19 | WHERE id = $1;
--------------------------------------------------------------------------------
/_examples/authors/pgx/sqlc.yaml:
--------------------------------------------------------------------------------
1 | version: "2"
2 | sql:
3 | - schema: "./sql/migrations"
4 | queries: "./sql/queries.sql"
5 | engine: "postgresql"
6 | gen:
7 | go:
8 | package: "authors"
9 | out: "internal/authors"
10 | sql_package: "pgx/v5"
11 | emit_interface: true
12 | emit_exact_table_names: true
13 | emit_empty_slices: true
14 | emit_exported_queries: true
15 | emit_json_tags: true
16 | emit_result_struct_pointers: true
17 | emit_params_struct_pointers: true
18 | emit_methods_with_db_argument: true
19 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/README.md:
--------------------------------------------------------------------------------
1 | # Fullstack application go + sqlite + htmx
2 |
3 | The most productive and efficient stack of the world!
4 |
5 | ## Steps to generate the code
6 |
7 | 0. Install the required tools.
8 |
9 | ```sh
10 | go install github.com/walterwanderley/sqlc-http@latest
11 | ```
12 | ```sh
13 | go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
14 | ```
15 |
16 | 1. Create a directory to store SQL scripts.
17 |
18 | ```sh
19 | mkdir -p sql/migrations
20 | ```
21 |
22 | 2. Create migrations scripts using [goose](https://github.com/pressly/goose?tab=readme-ov-file#migrations) rules.
23 |
24 | ```sh
25 | echo "-- +goose Up
26 | CREATE TABLE IF NOT EXISTS authors (
27 | id integer PRIMARY KEY AUTOINCREMENT,
28 | name text NOT NULL,
29 | bio text,
30 | birth_date date
31 | );
32 |
33 | -- +goose Down
34 | DROP TABLE IF EXISTS authors;
35 | " > sql/migrations/001_authors.sql
36 | ```
37 |
38 | 3. Create SQL queries and use [sqlc](https://sqlc.dev/) and [sqlc-http](http://github.com/walterwanderley/sqlc-http) comments syntax.
39 |
40 | ```sh
41 | echo "/* name: GetAuthor :one */
42 | /* http: GET /authors/{id}*/
43 | SELECT * FROM authors
44 | WHERE id = ? LIMIT 1;
45 |
46 | /* name: ListAuthors :many */
47 | /* http: GET /authors */
48 | SELECT * FROM authors
49 | ORDER BY name
50 | LIMIT ? OFFSET ?;
51 |
52 | /* name: CreateAuthor :execresult */
53 | /* http: POST /authors */
54 | INSERT INTO authors (
55 | name, bio, birth_date
56 | ) VALUES (
57 | ?, ?, ?
58 | );
59 |
60 | /* name: UpdateAuthor :execresult */
61 | /* http: PUT /authors/{id} */
62 | UPDATE authors
63 | SET name = ?,
64 | bio = ?,
65 | birth_date = ?
66 | WHERE id = ?;
67 |
68 | /* name: UpdateAuthorBio :execresult */
69 | /* http: PATCH /authors/{id}/bio */
70 | UPDATE authors
71 | SET bio = ?
72 | WHERE id = ?;
73 |
74 | /* name: DeleteAuthor :exec */
75 | /* http: DELETE /authors/{id} */
76 | DELETE FROM authors
77 | WHERE id = ?;
78 | " > sql/queries.sql
79 | ```
80 |
81 | 4. Create the sqlc.yaml configuration file
82 |
83 | ```sh
84 | echo "
85 | version: "2"
86 | sql:
87 | - schema: "./sql/migrations"
88 | queries: "./sql/queries.sql"
89 | engine: "sqlite"
90 | gen:
91 | go:
92 | out: "internal/authors"
93 | " > sqlc.yaml
94 | ```
95 |
96 | 5. Execute sqlc
97 |
98 | ```sh
99 | sqlc generate
100 | ```
101 |
102 | 6. Execute sqlc-http
103 |
104 | ```sh
105 | sqlc-http -m sqlite-htmx -migration-path sql/migrations -frontend
106 | ```
107 |
108 | ## Running
109 |
110 | ```sh
111 | go run . -db test.db
112 | ```
113 |
114 | Go to [http://localhost:5000](http://localhost:5000)
115 |
116 | ## Hot reload
117 |
118 | If you want to automatic refresh the browser after change html files, use the **-dev** parameter:
119 |
120 | ```sh
121 | go run . -db test.db -dev
122 | ```
123 |
124 | "Computers make art, artists make money" (Chico Science)
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/gen.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | set -u
3 | set -e
4 | set -x
5 |
6 | go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
7 |
8 | rm -rf internal view go.mod go.sum *.go openapi.yml
9 |
10 | sqlc generate
11 | sqlc-http -m sqlite-htmx -migration-path sql/migrations -frontend
12 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/go.mod:
--------------------------------------------------------------------------------
1 | module sqlite-htmx
2 |
3 | go 1.24.3
4 |
5 | require (
6 | github.com/fsnotify/fsnotify v1.9.0
7 | github.com/go-playground/form/v4 v4.2.1
8 | github.com/pressly/goose/v3 v3.24.3
9 | go.uber.org/automaxprocs v1.6.0
10 | modernc.org/sqlite v1.37.0
11 | )
12 |
13 | require (
14 | github.com/dustin/go-humanize v1.0.1 // indirect
15 | github.com/google/uuid v1.6.0 // indirect
16 | github.com/mattn/go-isatty v0.0.20 // indirect
17 | github.com/mfridman/interpolate v0.0.2 // indirect
18 | github.com/ncruces/go-strftime v0.1.9 // indirect
19 | github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
20 | github.com/sethvargo/go-retry v0.3.0 // indirect
21 | go.uber.org/multierr v1.11.0 // indirect
22 | golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 // indirect
23 | golang.org/x/sync v0.14.0 // indirect
24 | golang.org/x/sys v0.33.0 // indirect
25 | modernc.org/libc v1.65.0 // indirect
26 | modernc.org/mathutil v1.7.1 // indirect
27 | modernc.org/memory v1.10.0 // indirect
28 | )
29 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/go.sum:
--------------------------------------------------------------------------------
1 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
2 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
3 | github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
4 | github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
5 | github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=
6 | github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0=
7 | github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A=
8 | github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
9 | github.com/go-playground/form/v4 v4.2.1 h1:HjdRDKO0fftVMU5epjPW2SOREcZ6/wLUzEobqUGJuPw=
10 | github.com/go-playground/form/v4 v4.2.1/go.mod h1:q1a2BY+AQUUzhl6xA/6hBetay6dEIhMHjgvJiGo6K7U=
11 | github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e h1:ijClszYn+mADRFY17kjQEVQ1XRhq2/JR1M3sGqeJoxs=
12 | github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
13 | github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
14 | github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
15 | github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
16 | github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
17 | github.com/mfridman/interpolate v0.0.2 h1:pnuTK7MQIxxFz1Gr+rjSIx9u7qVjf5VOoM/u6BbAxPY=
18 | github.com/mfridman/interpolate v0.0.2/go.mod h1:p+7uk6oE07mpE/Ik1b8EckO0O4ZXiGAfshKBWLUM9Xg=
19 | github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
20 | github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
21 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
22 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
23 | github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g=
24 | github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U=
25 | github.com/pressly/goose/v3 v3.24.3 h1:DSWWNwwggVUsYZ0X2VitiAa9sKuqtBfe+Jr9zFGwWlM=
26 | github.com/pressly/goose/v3 v3.24.3/go.mod h1:v9zYL4xdViLHCUUJh/mhjnm6JrK7Eul8AS93IxiZM4E=
27 | github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
28 | github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
29 | github.com/sethvargo/go-retry v0.3.0 h1:EEt31A35QhrcRZtrYFDTBg91cqZVnFL2navjDrah2SE=
30 | github.com/sethvargo/go-retry v0.3.0/go.mod h1:mNX17F0C/HguQMyMyJxcnU471gOZGxCLyYaFyAZraas=
31 | github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
32 | github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
33 | go.uber.org/automaxprocs v1.6.0 h1:O3y2/QNTOdbF+e/dpXNNW7Rx2hZ4sTIPyybbxyNqTUs=
34 | go.uber.org/automaxprocs v1.6.0/go.mod h1:ifeIMSnPZuznNm6jmdzmU3/bfk01Fe2fotchwEFJ8r8=
35 | go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
36 | go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
37 | golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 h1:y5zboxd6LQAqYIhHnB48p0ByQ/GnQx2BE33L8BOHQkI=
38 | golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6/go.mod h1:U6Lno4MTRCDY+Ba7aCcauB9T60gsv5s4ralQzP72ZoQ=
39 | golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
40 | golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
41 | golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ=
42 | golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
43 | golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
44 | golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
45 | golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
46 | golang.org/x/tools v0.33.0 h1:4qz2S3zmRxbGIhDIAgjxvFutSvH5EfnsYrRBj0UI0bc=
47 | golang.org/x/tools v0.33.0/go.mod h1:CIJMaWEY88juyUfo7UbgPqbC8rU2OqfAV1h2Qp0oMYI=
48 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
49 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
50 | modernc.org/cc/v4 v4.26.0 h1:QMYvbVduUGH0rrO+5mqF/PSPPRZNpRtg2CLELy7vUpA=
51 | modernc.org/cc/v4 v4.26.0/go.mod h1:uVtb5OGqUKpoLWhqwNQo/8LwvoiEBLvZXIQ/SmO6mL0=
52 | modernc.org/ccgo/v4 v4.26.0 h1:gVzXaDzGeBYJ2uXTOpR8FR7OlksDOe9jxnjhIKCsiTc=
53 | modernc.org/ccgo/v4 v4.26.0/go.mod h1:Sem8f7TFUtVXkG2fiaChQtyyfkqhJBg/zjEJBkmuAVY=
54 | modernc.org/fileutil v1.3.1 h1:8vq5fe7jdtEvoCf3Zf9Nm0Q05sH6kGx0Op2CPx1wTC8=
55 | modernc.org/fileutil v1.3.1/go.mod h1:HxmghZSZVAz/LXcMNwZPA/DRrQZEVP9VX0V4LQGQFOc=
56 | modernc.org/gc/v2 v2.6.5 h1:nyqdV8q46KvTpZlsw66kWqwXRHdjIlJOhG6kxiV/9xI=
57 | modernc.org/gc/v2 v2.6.5/go.mod h1:YgIahr1ypgfe7chRuJi2gD7DBQiKSLMPgBQe9oIiito=
58 | modernc.org/libc v1.65.0 h1:e183gLDnAp9VJh6gWKdTy0CThL9Pt7MfcR/0bgb7Y1Y=
59 | modernc.org/libc v1.65.0/go.mod h1:7m9VzGq7APssBTydds2zBcxGREwvIGpuUBaKTXdm2Qs=
60 | modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU=
61 | modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg=
62 | modernc.org/memory v1.10.0 h1:fzumd51yQ1DxcOxSO+S6X7+QTuVU+n8/Aj7swYjFfC4=
63 | modernc.org/memory v1.10.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw=
64 | modernc.org/opt v0.1.4 h1:2kNGMRiUjrp4LcaPuLY2PzUfqM/w9N23quVwhKt5Qm8=
65 | modernc.org/opt v0.1.4/go.mod h1:03fq9lsNfvkYSfxrfUhZCWPk1lm4cq4N+Bh//bEtgns=
66 | modernc.org/sortutil v1.2.1 h1:+xyoGf15mM3NMlPDnFqrteY07klSFxLElE2PVuWIJ7w=
67 | modernc.org/sortutil v1.2.1/go.mod h1:7ZI3a3REbai7gzCLcotuw9AC4VZVpYMjDzETGsSMqJE=
68 | modernc.org/sqlite v1.37.0 h1:s1TMe7T3Q3ovQiK2Ouz4Jwh7dw4ZDqbebSDTlSJdfjI=
69 | modernc.org/sqlite v1.37.0/go.mod h1:5YiWv+YviqGMuGw4V+PNplcyaJ5v+vQd7TQOgkACoJM=
70 | modernc.org/strutil v1.2.1 h1:UneZBkQA+DX2Rp35KcM69cSsNES9ly8mQWD71HKlOA0=
71 | modernc.org/strutil v1.2.1/go.mod h1:EHkiggD70koQxjVdSBM3JKM7k6L0FbGE5eymy9i3B9A=
72 | modernc.org/token v1.1.0 h1:Xl7Ap9dKaEs5kLoOQeQmPWevfnk/DM5qcLcYlA8ys6Y=
73 | modernc.org/token v1.1.0/go.mod h1:UGzOrNV1mAFSEB63lOFHIpNRUVMvYTc6yu1SMY/XTDM=
74 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/internal/authors/db.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 |
5 | package authors
6 |
7 | import (
8 | "context"
9 | "database/sql"
10 | )
11 |
12 | type DBTX interface {
13 | ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
14 | PrepareContext(context.Context, string) (*sql.Stmt, error)
15 | QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error)
16 | QueryRowContext(context.Context, string, ...interface{}) *sql.Row
17 | }
18 |
19 | func New(db DBTX) *Queries {
20 | return &Queries{db: db}
21 | }
22 |
23 | type Queries struct {
24 | db DBTX
25 | }
26 |
27 | func (q *Queries) WithTx(tx *sql.Tx) *Queries {
28 | return &Queries{
29 | db: tx,
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/internal/authors/models.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 |
5 | package authors
6 |
7 | import (
8 | "database/sql"
9 | )
10 |
11 | type Author struct {
12 | ID int64
13 | Name string
14 | Bio sql.NullString
15 | BirthDate sql.NullTime
16 | }
17 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/internal/authors/queries.sql.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc. DO NOT EDIT.
2 | // versions:
3 | // sqlc v1.29.0
4 | // source: queries.sql
5 |
6 | package authors
7 |
8 | import (
9 | "context"
10 | "database/sql"
11 | )
12 |
13 | const createAuthor = `-- name: CreateAuthor :execresult
14 | INSERT INTO authors (
15 | name, bio, birth_date
16 | ) VALUES (
17 | ?, ?, ?
18 | )
19 | `
20 |
21 | type CreateAuthorParams struct {
22 | Name string
23 | Bio sql.NullString
24 | BirthDate sql.NullTime
25 | }
26 |
27 | // http: POST /authors
28 | func (q *Queries) CreateAuthor(ctx context.Context, arg CreateAuthorParams) (sql.Result, error) {
29 | return q.db.ExecContext(ctx, createAuthor, arg.Name, arg.Bio, arg.BirthDate)
30 | }
31 |
32 | const deleteAuthor = `-- name: DeleteAuthor :exec
33 | DELETE FROM authors
34 | WHERE id = ?
35 | `
36 |
37 | // http: DELETE /authors/{id}
38 | func (q *Queries) DeleteAuthor(ctx context.Context, id int64) error {
39 | _, err := q.db.ExecContext(ctx, deleteAuthor, id)
40 | return err
41 | }
42 |
43 | const getAuthor = `-- name: GetAuthor :one
44 | SELECT id, name, bio, birth_date FROM authors
45 | WHERE id = ? LIMIT 1
46 | `
47 |
48 | // http: GET /authors/{id}
49 | func (q *Queries) GetAuthor(ctx context.Context, id int64) (Author, error) {
50 | row := q.db.QueryRowContext(ctx, getAuthor, id)
51 | var i Author
52 | err := row.Scan(
53 | &i.ID,
54 | &i.Name,
55 | &i.Bio,
56 | &i.BirthDate,
57 | )
58 | return i, err
59 | }
60 |
61 | const listAuthors = `-- name: ListAuthors :many
62 | SELECT id, name, bio, birth_date FROM authors
63 | ORDER BY name
64 | LIMIT ? OFFSET ?
65 | `
66 |
67 | type ListAuthorsParams struct {
68 | Limit int64
69 | Offset int64
70 | }
71 |
72 | // http: GET /authors
73 | func (q *Queries) ListAuthors(ctx context.Context, arg ListAuthorsParams) ([]Author, error) {
74 | rows, err := q.db.QueryContext(ctx, listAuthors, arg.Limit, arg.Offset)
75 | if err != nil {
76 | return nil, err
77 | }
78 | defer rows.Close()
79 | var items []Author
80 | for rows.Next() {
81 | var i Author
82 | if err := rows.Scan(
83 | &i.ID,
84 | &i.Name,
85 | &i.Bio,
86 | &i.BirthDate,
87 | ); err != nil {
88 | return nil, err
89 | }
90 | items = append(items, i)
91 | }
92 | if err := rows.Close(); err != nil {
93 | return nil, err
94 | }
95 | if err := rows.Err(); err != nil {
96 | return nil, err
97 | }
98 | return items, nil
99 | }
100 |
101 | const updateAuthor = `-- name: UpdateAuthor :execresult
102 | UPDATE authors
103 | SET name = ?,
104 | bio = ?,
105 | birth_date = ?
106 | WHERE id = ?
107 | `
108 |
109 | type UpdateAuthorParams struct {
110 | Name string
111 | Bio sql.NullString
112 | BirthDate sql.NullTime
113 | ID int64
114 | }
115 |
116 | // http: PUT /authors/{id}
117 | func (q *Queries) UpdateAuthor(ctx context.Context, arg UpdateAuthorParams) (sql.Result, error) {
118 | return q.db.ExecContext(ctx, updateAuthor,
119 | arg.Name,
120 | arg.Bio,
121 | arg.BirthDate,
122 | arg.ID,
123 | )
124 | }
125 |
126 | const updateAuthorBio = `-- name: UpdateAuthorBio :execresult
127 | UPDATE authors
128 | SET bio = ?
129 | WHERE id = ?
130 | `
131 |
132 | type UpdateAuthorBioParams struct {
133 | Bio sql.NullString
134 | ID int64
135 | }
136 |
137 | // http: PATCH /authors/{id}/bio
138 | func (q *Queries) UpdateAuthorBio(ctx context.Context, arg UpdateAuthorBioParams) (sql.Result, error) {
139 | return q.db.ExecContext(ctx, updateAuthorBio, arg.Bio, arg.ID)
140 | }
141 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/internal/authors/routes.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http). DO NOT EDIT.
2 |
3 | package authors
4 |
5 | import "net/http"
6 |
7 | func (s *Service) RegisterHandlers(mux *http.ServeMux) {
8 | mux.HandleFunc("POST /authors", s.handleCreateAuthor())
9 | mux.HandleFunc("DELETE /authors/{id}", s.handleDeleteAuthor())
10 | mux.HandleFunc("GET /authors/{id}", s.handleGetAuthor())
11 | mux.HandleFunc("GET /authors", s.handleListAuthors())
12 | mux.HandleFunc("PUT /authors/{id}", s.handleUpdateAuthor())
13 | mux.HandleFunc("PATCH /authors/{id}/bio", s.handleUpdateAuthorBio())
14 | }
15 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/internal/authors/service_factory.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package authors
4 |
5 | // NewService is a constructor of a interface { func RegisterHandlers(*http.ServeMux) } implementation.
6 | // Use this function to customize the server by adding middlewares to it.
7 | func NewService(querier *Queries) *Service {
8 | return &Service{querier: querier}
9 | }
10 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/internal/server/encoding.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package server
4 |
5 | import (
6 | "encoding/json"
7 | "fmt"
8 | "log/slog"
9 | "net/http"
10 | "strings"
11 | "time"
12 |
13 | "github.com/go-playground/form/v4"
14 |
15 | "sqlite-htmx/view"
16 | )
17 |
18 | var formDecoder *form.Decoder
19 |
20 | func init() {
21 | formDecoder = form.NewDecoder()
22 | formDecoder.SetTagName("json")
23 |
24 | formDecoder.RegisterCustomTypeFunc(func(vals []string) (interface{}, error) {
25 | if vals[0] == "" {
26 | return time.Time{}, nil
27 | }
28 | return time.ParseInLocation(time.DateOnly, vals[0], time.Local)
29 | }, time.Time{})
30 | }
31 |
32 | func Decode[T any](r *http.Request) (T, error) {
33 | var v T
34 | if r.Header.Get("Content-Type") == "application/x-www-form-urlencoded" {
35 | if err := r.ParseForm(); err != nil {
36 | return v, fmt.Errorf("parse form: %w", err)
37 | }
38 | if err := formDecoder.Decode(&v, r.Form); err != nil {
39 | return v, fmt.Errorf("decode form: %w", err)
40 | }
41 | } else {
42 | if err := json.NewDecoder(r.Body).Decode(&v); err != nil {
43 | return v, fmt.Errorf("decode json: %w", err)
44 | }
45 | }
46 | return v, nil
47 | }
48 |
49 | func Encode[T any](w http.ResponseWriter, r *http.Request, status int, v T) error {
50 | if !strings.Contains(r.Header.Get("Accept"), "application/json") {
51 | if err := view.RenderHTML(w, r, v); err != nil {
52 | slog.Error("render html", "error", err)
53 | }
54 | return nil
55 | }
56 | w.Header().Set("Content-Type", "application/json")
57 | w.WriteHeader(status)
58 | if err := json.NewEncoder(w).Encode(v); err != nil {
59 | return fmt.Errorf("encode json: %w", err)
60 | }
61 | return nil
62 | }
63 |
64 | func Info(w http.ResponseWriter, r *http.Request, code int, text string) error {
65 | return view.InfoMessage(code, text).Render(w, r)
66 | }
67 |
68 | func Success(w http.ResponseWriter, r *http.Request, code int, text string) error {
69 | return view.SuccessMessage(code, text).Render(w, r)
70 | }
71 |
72 | func Error(w http.ResponseWriter, r *http.Request, code int, text string) error {
73 | return view.ErrorMessage(code, text).Render(w, r)
74 | }
75 |
76 | func Warning(w http.ResponseWriter, r *http.Request, code int, text string) error {
77 | return view.WarningMessage(code, text).Render(w, r)
78 | }
79 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/main.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package main
4 |
5 | import (
6 | "context"
7 | "database/sql"
8 | _ "embed"
9 | "errors"
10 | "flag"
11 | "fmt"
12 | "log/slog"
13 | "net/http"
14 | "os"
15 | "os/signal"
16 | "runtime"
17 | "syscall"
18 | "time"
19 |
20 | "go.uber.org/automaxprocs/maxprocs"
21 | // database driver
22 | _ "modernc.org/sqlite"
23 |
24 | "sqlite-htmx/view"
25 | )
26 |
27 | //go:generate sqlc-http -m sqlite-htmx -migration-path sql/migrations -frontend -append
28 |
29 | const serviceName = "sqlite-htmx"
30 |
31 | var (
32 | dev bool
33 | dbURL string
34 | port int
35 |
36 | //go:embed openapi.yml
37 | openAPISpec []byte
38 | )
39 |
40 | func main() {
41 | flag.StringVar(&dbURL, "db", "", "The Database connection URL")
42 | flag.IntVar(&port, "port", 5000, "The server port")
43 |
44 | flag.BoolVar(&dev, "dev", false, "Set logger to development mode and enable Hot Reload on edit templates files")
45 |
46 | flag.Parse()
47 |
48 | initLogger()
49 |
50 | if err := run(); err != nil && !errors.Is(err, http.ErrServerClosed) {
51 | slog.Error("server error", "error", err)
52 | os.Exit(1)
53 | }
54 | }
55 |
56 | func run() error {
57 | _, err := maxprocs.Set()
58 | if err != nil {
59 | slog.Warn("startup", "error", err)
60 | }
61 | slog.Info("startup", "GOMAXPROCS", runtime.GOMAXPROCS(0))
62 |
63 | db, err := sql.Open("sqlite", dbURL)
64 | if err != nil {
65 | return err
66 | }
67 | defer db.Close()
68 |
69 | if err := ensureSchema(db); err != nil {
70 | return fmt.Errorf("migration error: %w", err)
71 | }
72 |
73 | mux := http.NewServeMux()
74 | registerHandlers(mux, db)
75 |
76 | mux.HandleFunc("GET /openapi.yaml", func(w http.ResponseWriter, r *http.Request) {
77 | w.Header().Set("Content-Type", "application/yaml")
78 | w.Write(openAPISpec)
79 | })
80 |
81 | err = view.RegisterHandlers(mux, dev)
82 | if err != nil {
83 | return fmt.Errorf("frontend templates error: %w", err)
84 | }
85 |
86 | server := &http.Server{
87 | Addr: fmt.Sprintf(":%d", port),
88 | Handler: mux,
89 | // Please, configure timeouts!
90 | }
91 |
92 | done := make(chan os.Signal, 1)
93 | signal.Notify(done, os.Interrupt, syscall.SIGINT, syscall.SIGTERM)
94 | go func() {
95 | sig := <-done
96 | slog.Warn("signal detected...", "signal", sig)
97 | ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
98 | defer cancel()
99 | server.Shutdown(ctx)
100 | }()
101 | slog.Info("Listening...", "port", port)
102 | return server.ListenAndServe()
103 | }
104 |
105 | func initLogger() {
106 | var handler slog.Handler
107 | opts := slog.HandlerOptions{
108 | AddSource: true,
109 | }
110 | switch {
111 | case dev:
112 | handler = slog.NewTextHandler(os.Stderr, &opts)
113 | default:
114 | handler = slog.NewJSONHandler(os.Stderr, &opts)
115 | }
116 |
117 | logger := slog.New(handler)
118 | slog.SetDefault(logger)
119 | }
120 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/migration.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http).
2 |
3 | package main
4 |
5 | import (
6 | "database/sql"
7 | "embed"
8 |
9 | "github.com/pressly/goose/v3"
10 | )
11 |
12 | //go:embed sql/migrations
13 | var migrations embed.FS
14 |
15 | func ensureSchema(db *sql.DB) error {
16 | goose.SetBaseFS(migrations)
17 |
18 | if err := goose.SetDialect("sqlite"); err != nil {
19 | return err
20 | }
21 |
22 | return goose.Up(db, "sql/migrations")
23 |
24 | }
25 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/registry.go:
--------------------------------------------------------------------------------
1 | // Code generated by sqlc-http (https://github.com/walterwanderley/sqlc-http). DO NOT EDIT.
2 |
3 | package main
4 |
5 | import (
6 | "database/sql"
7 | "net/http"
8 |
9 | authors_app "sqlite-htmx/internal/authors"
10 | )
11 |
12 | func registerHandlers(mux *http.ServeMux, db *sql.DB) {
13 | authorsService := authors_app.NewService(authors_app.New(db))
14 | authorsService.RegisterHandlers(mux)
15 | }
16 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/sql/migrations/001_authors.sql:
--------------------------------------------------------------------------------
1 | -- +goose Up
2 | CREATE TABLE IF NOT EXISTS authors (
3 | id integer PRIMARY KEY AUTOINCREMENT,
4 | name text NOT NULL,
5 | bio text,
6 | birth_date date
7 | );
8 |
9 | -- +goose Down
10 | DROP TABLE IF EXISTS authors;
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/sql/queries.sql:
--------------------------------------------------------------------------------
1 | /* name: GetAuthor :one */
2 | /* http: GET /authors/{id}*/
3 | SELECT * FROM authors
4 | WHERE id = ? LIMIT 1;
5 |
6 | /* name: ListAuthors :many */
7 | /* http: GET /authors */
8 | SELECT * FROM authors
9 | ORDER BY name
10 | LIMIT ? OFFSET ?;
11 |
12 | /* name: CreateAuthor :execresult */
13 | /* http: POST /authors */
14 | INSERT INTO authors (
15 | name, bio, birth_date
16 | ) VALUES (
17 | ?, ?, ?
18 | );
19 |
20 | /* name: UpdateAuthor :execresult */
21 | /* http: PUT /authors/{id} */
22 | UPDATE authors
23 | SET name = ?,
24 | bio = ?,
25 | birth_date = ?
26 | WHERE id = ?;
27 |
28 | /* name: UpdateAuthorBio :execresult */
29 | /* http: PATCH /authors/{id}/bio */
30 | UPDATE authors
31 | SET bio = ?
32 | WHERE id = ?;
33 |
34 | /* name: DeleteAuthor :exec */
35 | /* http: DELETE /authors/{id} */
36 | DELETE FROM authors
37 | WHERE id = ?;
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/sqlc.yaml:
--------------------------------------------------------------------------------
1 | version: "2"
2 | sql:
3 | - schema: "./sql/migrations"
4 | queries: "./sql/queries.sql"
5 | engine: "sqlite"
6 | gen:
7 | go:
8 | out: "internal/authors"
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/breadcrumbs.go:
--------------------------------------------------------------------------------
1 | package view
2 |
3 | import "net/http"
4 |
5 | type breadCrumb struct {
6 | Name string
7 | Href string
8 | }
9 |
10 | func breadCrumbsFromRequest(r *http.Request) []breadCrumb {
11 | switch r.Pattern {
12 | case "POST /authors":
13 | return breadCrumbsFromStrings("Authors", "/", "Create Author")
14 | case "DELETE /authors/{id}":
15 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Delete Author")
16 | case "GET /authors/{id}":
17 | serviceName := "Get Author"
18 | if r.URL.Query().Has("edit") {
19 | serviceName = "Update Author"
20 | }
21 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", serviceName)
22 | case "GET /authors":
23 | return breadCrumbsFromStrings("Authors", "/", "List Authors")
24 | case "PUT /authors/{id}":
25 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Update Author")
26 | case "PATCH /authors/{id}/bio":
27 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Get Author", "/authors/"+r.PathValue("id"), "Update Author Bio")
28 | default:
29 | switch r.URL.Path {
30 | case "/app/authors/create_author":
31 | return breadCrumbsFromStrings("Authors", "/", "Create Author")
32 | case "/app/authors/delete_author":
33 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Delete Author")
34 | case "/app/authors/get_author":
35 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Get Author")
36 | case "/app/authors/list_authors":
37 | return breadCrumbsFromStrings("Authors", "/", "List Authors")
38 | case "/app/authors/update_author":
39 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Update Author")
40 | case "/app/authors/update_author_bio":
41 | return breadCrumbsFromStrings("Authors", "/", "List Authors", "/authors", "Update Author Bio")
42 | }
43 | }
44 |
45 | return nil
46 | }
47 |
48 | func breadCrumbsFromStrings(items ...string) []breadCrumb {
49 | breadcrumbs := make([]breadCrumb, 0)
50 | for i := 0; i < len(items); i = i + 2 {
51 | var bc breadCrumb
52 | bc.Name = items[i]
53 | j := i + 1
54 | if j < len(items) {
55 | bc.Href = items[j]
56 | }
57 | breadcrumbs = append(breadcrumbs, bc)
58 | }
59 | return breadcrumbs
60 | }
61 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/content.go:
--------------------------------------------------------------------------------
1 | package view
2 |
3 | import (
4 | "fmt"
5 | "net/http"
6 | "os"
7 | "strings"
8 | )
9 |
10 | type Content[T any] struct {
11 | Data T
12 | Request *http.Request
13 | }
14 |
15 | func (c Content[T]) HxRequest() bool {
16 | return HXRequest(c.Request)
17 | }
18 |
19 | func (c Content[T]) BreadCrumbsFromRequest() []breadCrumb {
20 | return breadCrumbsFromRequest(c.Request)
21 | }
22 |
23 | func (c Content[T]) Pagination() *Pagination {
24 | pagination, _ := c.Request.Context().Value(paginationContext).(*Pagination)
25 | if pagination != nil {
26 | pagination.request = c.Request
27 | }
28 | return pagination
29 | }
30 |
31 | func (c Content[T]) BaseHref() string {
32 | schema := "http"
33 | if forwardedProto := c.Request.Header.Get("X-Forwarded-Proto"); forwardedProto != "" {
34 | schema = forwardedProto
35 | } else if c.Request.TLS != nil {
36 | schema = "https"
37 | }
38 | context := os.Getenv("WEB_CONTEXT")
39 | return fmt.Sprintf("%s://%s%s/", schema, c.Request.Host, strings.TrimSuffix(context, "/"))
40 | }
41 |
42 | func (c Content[T]) HasQuery(key string) bool {
43 | return c.Request.URL.Query().Has(key)
44 | }
45 |
46 | func (c Content[T]) Query(key string) string {
47 | return c.Request.URL.Query().Get(key)
48 | }
49 |
50 | func (c Content[T]) MessageContext() *Message {
51 | if msg, ok := c.Request.Context().Value(messageContext).(Message); ok {
52 | return &msg
53 | }
54 | return nil
55 | }
56 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/etag/etag.go:
--------------------------------------------------------------------------------
1 | package etag
2 |
3 | import (
4 | "crypto/sha1"
5 | "encoding/hex"
6 | "io"
7 | "io/fs"
8 | "log"
9 | "net/http"
10 | )
11 |
12 | func HandlerFunc(fileSystem fs.FS, stripPrefix string) http.HandlerFunc {
13 | etags := generateETags(fileSystem, stripPrefix)
14 | handler := http.FileServer(http.FS(fileSystem))
15 | if stripPrefix != "" {
16 | handler = http.StripPrefix(stripPrefix, handler)
17 | }
18 | return func(w http.ResponseWriter, r *http.Request) {
19 | if sum, ok := etags[r.URL.Path]; ok {
20 | w.Header().Set("ETag", sum)
21 | if r.Header.Get("If-None-Match") == sum {
22 | w.WriteHeader(http.StatusNotModified)
23 | return
24 | }
25 | }
26 | handler.ServeHTTP(w, r)
27 | }
28 | }
29 |
30 | func Handler(fileSystem fs.FS, stripPrefix string) http.Handler {
31 | return http.HandlerFunc(HandlerFunc(fileSystem, stripPrefix))
32 | }
33 |
34 | func generateETags(fileSystem fs.FS, stripPrefix string) map[string]string {
35 | etags := make(map[string]string)
36 | err := fs.WalkDir(fileSystem, ".", func(path string, d fs.DirEntry, err error) error {
37 | if err != nil {
38 | return err
39 | }
40 |
41 | if d.IsDir() {
42 | return nil
43 | }
44 |
45 | in, err := fileSystem.Open(path)
46 | if err != nil {
47 | return err
48 | }
49 | defer in.Close()
50 |
51 | hasher := sha1.New()
52 | if _, err := io.Copy(hasher, in); err != nil {
53 | return err
54 | }
55 |
56 | sum := hex.EncodeToString(hasher.Sum(nil))
57 | etags[stripPrefix+"/"+path] = sum
58 | return nil
59 | })
60 | if err != nil {
61 | log.Println("[error] ETags:", err.Error())
62 | }
63 | return etags
64 | }
65 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/message.go:
--------------------------------------------------------------------------------
1 | package view
2 |
3 | import (
4 | "encoding/json"
5 | "html/template"
6 | "log/slog"
7 | "net/http"
8 | "strings"
9 | )
10 |
11 | const (
12 | retarget = "#messages"
13 | reswap = "beforeend show:body:top"
14 | )
15 |
16 | var (
17 | messageTemplate = template.Must(template.New("message.html").ParseFS(templatesFS, "templates/components/message.html"))
18 | messagesContextTemplate = template.Must(template.New("messages-context.html").ParseFS(templatesFS,
19 | "templates/components/messages-context.html", "templates/components/message.html"))
20 | )
21 |
22 | type MessageType string
23 |
24 | const (
25 | TypeInfo = MessageType("info")
26 | TypeSuccess = MessageType("success")
27 | TypeError = MessageType("error")
28 | TypeWarning = MessageType("warning")
29 | )
30 |
31 | func (t MessageType) Icon() string {
32 | switch t {
33 | case TypeInfo:
34 | return "info-fill"
35 | case TypeSuccess:
36 | return "check-circle-fill"
37 | default:
38 | return "exclamation-triangle-fill"
39 | }
40 | }
41 |
42 | func (t MessageType) Class() string {
43 | switch t {
44 | case TypeInfo:
45 | return "primary"
46 | case TypeSuccess:
47 | return "success"
48 | case TypeError:
49 | return "danger"
50 | default:
51 | return "warning"
52 | }
53 | }
54 |
55 | type Message struct {
56 | Code int `json:"code"`
57 | Text string `json:"text"`
58 | Type MessageType `json:"type"`
59 | }
60 |
61 | func NewMessage(code int, text string, typ MessageType) Message {
62 | return Message{Code: code,
63 | Text: text,
64 | Type: typ}
65 | }
66 |
67 | func ErrorMessage(code int, text string) Message {
68 | return NewMessage(code, text, TypeError)
69 | }
70 |
71 | func InfoMessage(code int, text string) Message {
72 | return NewMessage(code, text, TypeInfo)
73 | }
74 |
75 | func SuccessMessage(code int, text string) Message {
76 | return NewMessage(code, text, TypeSuccess)
77 | }
78 |
79 | func WarningMessage(code int, text string) Message {
80 | return NewMessage(code, text, TypeWarning)
81 | }
82 |
83 | func (m Message) Render(w http.ResponseWriter, r *http.Request) error {
84 | if strings.Contains(r.Header.Get("accept"), "application/json") {
85 | w.WriteHeader(m.Code)
86 | return json.NewEncoder(w).Encode(m)
87 | }
88 |
89 | if HXRequest(r) {
90 | if r.Method == http.MethodDelete {
91 | err := messagesContextTemplate.Execute(w, m)
92 | if err != nil {
93 | slog.Error("render messages-context", "err", err)
94 | }
95 | return err
96 | }
97 | w.Header().Set("HX-Retarget", retarget)
98 | w.Header().Set("HX-Reswap", reswap)
99 | }
100 |
101 | err := messageTemplate.Execute(w, m)
102 | if err != nil {
103 | slog.Error("render message", "err", err)
104 | }
105 | return err
106 | }
107 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/pagination.go:
--------------------------------------------------------------------------------
1 | package view
2 |
3 | import (
4 | "fmt"
5 | "net/http"
6 | "strings"
7 | )
8 |
9 | const defaultLimit = 10
10 |
11 | type Pagination struct {
12 | request *http.Request
13 | Limit int64
14 | Offset int64
15 | }
16 |
17 | func (p *Pagination) From() int64 {
18 | return p.Offset + 1
19 | }
20 |
21 | func (p *Pagination) To() int64 {
22 | return p.Offset + p.validLimit()
23 | }
24 |
25 | func (p *Pagination) Next() int64 {
26 | return p.Offset + p.validLimit()
27 | }
28 |
29 | func (p *Pagination) Prev() int64 {
30 | limit := p.validLimit()
31 | offset := p.Offset - limit
32 | if offset < 0 {
33 | offset = 0
34 | }
35 | return offset
36 | }
37 |
38 | func (p *Pagination) URL(limit, offset int64) string {
39 | if p == nil {
40 | return ""
41 | }
42 | if offset < 0 {
43 | offset = 0
44 | }
45 | if limit == 0 {
46 | limit = defaultLimit
47 | }
48 | var url strings.Builder
49 | url.WriteString(p.request.URL.Path)
50 | url.WriteString("?")
51 | for k := range p.request.URL.Query() {
52 | if k == "limit" || k == "offset" {
53 | continue
54 | }
55 | url.WriteString(fmt.Sprintf("%s=%s&", k, p.request.URL.Query().Get(k)))
56 | }
57 | if limit > 0 {
58 | url.WriteString(fmt.Sprintf("limit=%d&offset=%d", limit, offset))
59 | } else {
60 | url.WriteString(fmt.Sprintf("offset=%d", offset))
61 | }
62 | return url.String()
63 | }
64 |
65 | func (p *Pagination) validLimit() int64 {
66 | limit := p.Limit
67 | if limit == 0 {
68 | limit = 10
69 | }
70 | return limit
71 | }
72 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/static/css/fonts/bootstrap-icons.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/walterwanderley/sqlc-http/f9920c63dbd0a9b7b52a62f093bbd522ef628468/_examples/authors/sqlite-frontend/view/static/css/fonts/bootstrap-icons.woff
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/static/css/fonts/bootstrap-icons.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/walterwanderley/sqlc-http/f9920c63dbd0a9b7b52a62f093bbd522ef628468/_examples/authors/sqlite-frontend/view/static/css/fonts/bootstrap-icons.woff2
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/static/css/style.css:
--------------------------------------------------------------------------------
1 | tr.htmx-swapping td {
2 | opacity: 0;
3 | transition: opacity 1s ease-out;
4 | }
5 |
6 | footer {
7 | position: fixed;
8 | left: 0;
9 | bottom: 0;
10 | width: 100%;
11 | background-color: orange;
12 | color: white;
13 | text-align: center;
14 | }
15 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/static/js/init.js:
--------------------------------------------------------------------------------
1 | loadComponents(document);
2 |
3 | htmx.onLoad(function (content) {
4 | loadComponents(content);
5 | });
6 |
7 | function loadComponents(content) {
8 | const alertList = content.querySelectorAll('.alert')
9 | const alerts = [...alertList].map(element => new bootstrap.Alert(element))
10 | }
11 |
12 | function replacePathParams(event) {
13 | let pathWithParameters = event.detail.path.replace(/{([A-Za-z0-9_]+)}/g, function (_match, parameterName) {
14 | let parameterValue = event.detail.parameters[parameterName]
15 | delete event.detail.parameters[parameterName]
16 | return parameterValue
17 | })
18 | event.detail.path = pathWithParameters
19 | }
20 |
21 | function showMessage(msg) {
22 | var msgIcon = 'exclamation-triangle-fill';
23 | var msgClass = 'warning';
24 | switch (msg.type) {
25 | case 'error':
26 | msgClass = 'danger';
27 | break
28 | case 'info':
29 | msgClass = 'primary';
30 | msgIcon = 'info-fill'
31 | break
32 | case 'success':
33 | msgClass = 'success';
34 | msgIcon = 'check-circle-fill'
35 | break
36 | }
37 |
38 | const messageDiv =
39 | `
40 |
43 |
44 | ` + msg.text + `
45 |
46 |
47 |
Create Author
4 |
25 |
26 |
27 | {{end}}
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/app/authors/delete_author.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 | {{template "hx-context.html" . -}}
3 | Delete Author
4 |
15 |
16 |
17 |
18 |
21 | {{end}}
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/app/authors/get_author.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 | {{template "hx-context.html" . -}}
3 | Get Author
4 |
15 |
16 |
17 |
18 |
21 | {{end}}
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/app/authors/list_authors.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 | {{template "hx-context.html" . -}}
3 | List Authors
4 |
5 |
6 |
7 | {{end}}
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/app/authors/update_author.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 | {{template "hx-context.html" . -}}
3 | Update Author
4 |
29 |
30 |
31 |
32 |
35 | {{end}}
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/app/authors/update_author_bio.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 | {{template "hx-context.html" . -}}
3 | Update Author Bio
4 |
19 |
20 |
21 |
22 |
25 | {{end}}
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/authors.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 | {{template "hx-context.html" .}}
3 | {{$pagination := .Pagination}}{{if $pagination}}
4 |
5 | {{end}}
8 |
9 |
10 |
11 | | ID |
12 | Name |
13 | Bio |
14 | Birth Date |
15 | |
16 |
17 |
18 | {{range .Data}}
19 | | {{.ID}} |
20 | {{.Name}} |
21 | {{.Bio}} |
22 | {{if .BirthDate}}{{.BirthDate.Format "02/01/2006"}}{{end}} |
23 |
24 |
25 |
26 |
27 | |
28 |
{{end}}
29 |
30 |
31 |
32 | {{if $pagination}}
33 |
53 |
Update Author
5 |
27 |
30 | {{- else -}}
31 |
32 |
33 |
34 |
ID: {{.Data.ID}}
35 |
36 |
37 |
38 |
39 |
Name: {{.Data.Name}}
40 |
41 |
42 |
43 |
44 |
Bio: {{.Data.Bio}}
45 |
46 |
47 |
48 |
49 |
Birth Date: {{.Data.BirthDate}}
50 |
51 |
52 |
2 | {{if .BreadCrumbsFromRequest}}
3 |
15 | {{end -}}
16 |
2 |
5 |
6 | {{.Text}}
7 |
8 |
9 |
2 | {{if .}}
3 | {{ template "message.html" .}}
4 | {{end -}}
5 |
--------------------------------------------------------------------------------
/_examples/authors/sqlite-frontend/view/templates/index.html:
--------------------------------------------------------------------------------
1 | {{define "content"}}
2 |
3 | {{template "hx-context.html" .}}
4 |
5 |
Sqlite-htmx
6 |
7 |
8 |
35 |
36 | Loading...
37 |
38 | {{ template "messages-context.html" .Content.MessageContext }}
39 | {{ template "breadcrumbs.html" .Content}}
40 |
41 | {{ template "content" .Content}}
42 |
43 |
40 |
43 |
44 | ` + msg.text + `
45 |
46 |
47 |
{{.Title}}
4 | {{if .AutoSubmit}}
5 | {{else -}}
6 |
10 |
{{end}}
11 |
12 | {{if .HasPathParam}}
13 |
16 | {{end -}}
17 | {{"{{"}}end{{"}}"}}
--------------------------------------------------------------------------------
/templates/view/templates/app/response.html.tmpl:
--------------------------------------------------------------------------------
1 | {{"{{"}}define "content"{{"}}"}}
2 | {{"{{"}}template "hx-context.html" .{{"}}"}}
3 | {{if .HasEditService}}{{"{{- "}}if .HasQuery "edit"{{"}}"}}
4 | {{.EditName}}
5 |
9 |
12 | {{"{{- "}}else{{" -}}"}}
13 | {{range .HtmlOutput}}{{.}}
14 | {{end -}}
15 | {{"{{- "}}end{{" -}}"}}
16 | {{else}}
17 | {{- if .Service | HasPagination}}{{"{{"}}$pagination := .Pagination{{"}}"}}{{"{{"}}if $pagination{{"}}"}}
18 |
19 | {{"{{"}}end{{"}}"}}{{- end -}}
20 | {{range .HtmlOutput}}{{.}}
21 | {{end -}}
22 | {{if .Service | HasPagination}}{{"{{"}}if $pagination{{"}}"}}
23 | {{range .HtmlPagination "#table_response"}}{{.}}
24 | {{end -}}
25 |
26 | {{"{{"}}end{{"}}"}}
27 | {{- end -}}
28 | {{- end -}}
29 | {{"{{"}}end{{"}}"}}
--------------------------------------------------------------------------------
/templates/view/templates/components/breadcrumbs.html.tmpl:
--------------------------------------------------------------------------------
1 |
2 | {{"{{"}}if .BreadCrumbsFromRequest{{"}}"}}
3 |
15 | {{"{{"}}end -{{"}}"}}
16 |
2 |
5 |
6 | {{.Text}}
7 |
8 |
9 |
2 | {{if .}}
3 | {{ template "message.html" .}}
4 | {{end -}}
5 |
--------------------------------------------------------------------------------
/templates/view/templates/index.html.tmpl:
--------------------------------------------------------------------------------
1 | {{"{{"}}define "content"{{"}}"}}
2 |
3 | {{"{{"}}template "hx-context.html" .{{"}}"}}
4 |
5 |
{{.GoModule | PascalCase}}
6 |
7 |
8 |
35 |
36 | Loading...
37 |
38 | {{ template "messages-context.html" .Content.MessageContext }}
39 | {{ template "breadcrumbs.html" .Content}}
40 |
41 | {{ template "content" .Content}}
42 |
43 |