snapshot of https://github.com/sqlc-dev/sqlc.git (main, 2026-09-16; blobs > 131072B omitted)

examples/authors/mysql/db.go

@@ -0,0 +1,31 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package authors
+
+import (
+	"context"
+	"database/sql"
+)
+
+type DBTX interface {
+	ExecContext(context.Context, string, ...any) (sql.Result, error)
+	PrepareContext(context.Context, string) (*sql.Stmt, error)
+	QueryContext(context.Context, string, ...any) (*sql.Rows, error)
+	QueryRowContext(context.Context, string, ...any) *sql.Row
+}
+
+func New(db DBTX) *Queries {
+	return &Queries{db: db}
+}
+
+type Queries struct {
+	db DBTX
+}
+
+func (q *Queries) WithTx(tx *sql.Tx) *Queries {
+	return &Queries{
+		db: tx,
+	}
+}

examples/authors/mysql/db_test.go

@@ -0,0 +1,53 @@
+//go:build examples
+
+package authors
+
+import (
+	"context"
+	"database/sql"
+	"testing"
+
+	_ "github.com/go-sql-driver/mysql"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest/local"
+)
+
+func TestAuthors(t *testing.T) {
+	ctx := context.Background()
+	uri := local.MySQL(t, []string{"schema.sql"})
+	sdb, err := sql.Open("mysql", uri)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer sdb.Close()
+
+	db := New(sdb)
+
+	// list all authors
+	authors, err := db.ListAuthors(ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(authors)
+
+	// create an author
+	result, err := db.CreateAuthor(ctx, CreateAuthorParams{
+		Name: "Brian Kernighan",
+		Bio:  sql.NullString{String: "Co-author of The C Programming Language and The Go Programming Language", Valid: true},
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	authorID, err := result.LastInsertId()
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(authorID)
+
+	// get the author we just inserted
+	fetchedAuthor, err := db.GetAuthor(ctx, authorID)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(fetchedAuthor)
+}

examples/authors/mysql/models.go

@@ -0,0 +1,15 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package authors
+
+import (
+	"database/sql"
+)
+
+type Author struct {
+	ID   int64
+	Name string
+	Bio  sql.NullString
+}

examples/authors/mysql/query.sql

@@ -0,0 +1,18 @@
+/* name: GetAuthor :one */
+SELECT * FROM authors
+WHERE id = ? LIMIT 1;
+
+/* name: ListAuthors :many */
+SELECT * FROM authors
+ORDER BY name;
+
+/* name: CreateAuthor :execresult */
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ? 
+);
+
+/* name: DeleteAuthor :exec */
+DELETE FROM authors
+WHERE id = ?;

examples/authors/mysql/query.sql.go

@@ -0,0 +1,78 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: query.sql
+
+package authors
+
+import (
+	"context"
+	"database/sql"
+)
+
+const createAuthor = `-- name: CreateAuthor :execresult
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ? 
+)
+`
+
+type CreateAuthorParams struct {
+	Name string
+	Bio  sql.NullString
+}
+
+func (q *Queries) CreateAuthor(ctx context.Context, arg CreateAuthorParams) (sql.Result, error) {
+	return q.db.ExecContext(ctx, createAuthor, arg.Name, arg.Bio)
+}
+
+const deleteAuthor = `-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = ?
+`
+
+func (q *Queries) DeleteAuthor(ctx context.Context, id int64) error {
+	_, err := q.db.ExecContext(ctx, deleteAuthor, id)
+	return err
+}
+
+const getAuthor = `-- name: GetAuthor :one
+SELECT id, name, bio FROM authors
+WHERE id = ? LIMIT 1
+`
+
+func (q *Queries) GetAuthor(ctx context.Context, id int64) (Author, error) {
+	row := q.db.QueryRowContext(ctx, getAuthor, id)
+	var i Author
+	err := row.Scan(&i.ID, &i.Name, &i.Bio)
+	return i, err
+}
+
+const listAuthors = `-- name: ListAuthors :many
+SELECT id, name, bio FROM authors
+ORDER BY name
+`
+
+func (q *Queries) ListAuthors(ctx context.Context) ([]Author, error) {
+	rows, err := q.db.QueryContext(ctx, listAuthors)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []Author
+	for rows.Next() {
+		var i Author
+		if err := rows.Scan(&i.ID, &i.Name, &i.Bio); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}

examples/authors/mysql/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE authors (
+          id   BIGINT PRIMARY KEY AUTO_INCREMENT,
+          name text      NOT NULL,
+          bio  text
+);

examples/authors/postgresql/db.go

@@ -0,0 +1,32 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package authors
+
+import (
+	"context"
+
+	"github.com/jackc/pgx/v5"
+	"github.com/jackc/pgx/v5/pgconn"
+)
+
+type DBTX interface {
+	Exec(context.Context, string, ...any) (pgconn.CommandTag, error)
+	Query(context.Context, string, ...any) (pgx.Rows, error)
+	QueryRow(context.Context, string, ...any) pgx.Row
+}
+
+func New(db DBTX) *Queries {
+	return &Queries{db: db}
+}
+
+type Queries struct {
+	db DBTX
+}
+
+func (q *Queries) WithTx(tx pgx.Tx) *Queries {
+	return &Queries{
+		db: tx,
+	}
+}

examples/authors/postgresql/db_test.go

@@ -0,0 +1,49 @@
+//go:build examples
+
+package authors
+
+import (
+	"context"
+	"testing"
+
+	"github.com/jackc/pgx/v5"
+	"github.com/jackc/pgx/v5/pgtype"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest/local"
+)
+
+func TestAuthors(t *testing.T) {
+	ctx := context.Background()
+	uri := local.PostgreSQL(t, []string{"schema.sql"})
+	db, err := pgx.Connect(ctx, uri)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer db.Close(ctx)
+
+	q := New(db)
+
+	// list all authors
+	authors, err := q.ListAuthors(ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(authors)
+
+	// create an author
+	insertedAuthor, err := q.CreateAuthor(ctx, CreateAuthorParams{
+		Name: "Brian Kernighan",
+		Bio:  pgtype.Text{String: "Co-author of The C Programming Language and The Go Programming Language", Valid: true},
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(insertedAuthor)
+
+	// get the author we just inserted
+	fetchedAuthor, err := q.GetAuthor(ctx, insertedAuthor.ID)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(fetchedAuthor)
+}

examples/authors/postgresql/models.go

@@ -0,0 +1,15 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package authors
+
+import (
+	"github.com/jackc/pgx/v5/pgtype"
+)
+
+type Author struct {
+	ID   int64
+	Name string
+	Bio  pgtype.Text
+}

examples/authors/postgresql/query.sql

@@ -0,0 +1,19 @@
+-- name: GetAuthor :one
+SELECT * FROM authors
+WHERE id = $1 LIMIT 1;
+
+-- name: ListAuthors :many
+SELECT * FROM authors
+ORDER BY name;
+
+-- name: CreateAuthor :one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  $1, $2
+)
+RETURNING *;
+
+-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1;

examples/authors/postgresql/query.sql.go

@@ -0,0 +1,80 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: query.sql
+
+package authors
+
+import (
+	"context"
+
+	"github.com/jackc/pgx/v5/pgtype"
+)
+
+const createAuthor = `-- name: CreateAuthor :one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  $1, $2
+)
+RETURNING id, name, bio
+`
+
+type CreateAuthorParams struct {
+	Name string
+	Bio  pgtype.Text
+}
+
+func (q *Queries) CreateAuthor(ctx context.Context, arg CreateAuthorParams) (Author, error) {
+	row := q.db.QueryRow(ctx, createAuthor, arg.Name, arg.Bio)
+	var i Author
+	err := row.Scan(&i.ID, &i.Name, &i.Bio)
+	return i, err
+}
+
+const deleteAuthor = `-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1
+`
+
+func (q *Queries) DeleteAuthor(ctx context.Context, id int64) error {
+	_, err := q.db.Exec(ctx, deleteAuthor, id)
+	return err
+}
+
+const getAuthor = `-- name: GetAuthor :one
+SELECT id, name, bio FROM authors
+WHERE id = $1 LIMIT 1
+`
+
+func (q *Queries) GetAuthor(ctx context.Context, id int64) (Author, error) {
+	row := q.db.QueryRow(ctx, getAuthor, id)
+	var i Author
+	err := row.Scan(&i.ID, &i.Name, &i.Bio)
+	return i, err
+}
+
+const listAuthors = `-- name: ListAuthors :many
+SELECT id, name, bio FROM authors
+ORDER BY name
+`
+
+func (q *Queries) ListAuthors(ctx context.Context) ([]Author, error) {
+	rows, err := q.db.Query(ctx, listAuthors)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []Author
+	for rows.Next() {
+		var i Author
+		if err := rows.Scan(&i.ID, &i.Name, &i.Bio); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}

examples/authors/postgresql/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE authors (
+          id   BIGSERIAL PRIMARY KEY,
+          name text      NOT NULL,
+          bio  text
+);

examples/authors/sqlc.yaml

@@ -0,0 +1,52 @@
+version: '2'
+cloud:
+  project: "01HAQMMECEYQYKFJN8MP16QC41"
+sql:
+- name: postgresql
+  schema: postgresql/schema.sql
+  queries: postgresql/query.sql
+  engine: postgresql
+  database:
+    uri: "${VET_TEST_EXAMPLES_POSTGRES_AUTHORS}"
+  analyzer:
+    database: false
+  rules:
+  - sqlc/db-prepare
+  - postgresql-query-too-costly
+  gen:
+    go:
+      package: authors
+      sql_package: pgx/v5
+      out: postgresql
+- name: mysql
+  schema: mysql/schema.sql
+  queries: mysql/query.sql
+  engine: mysql
+  database:
+    uri: "${VET_TEST_EXAMPLES_MYSQL_AUTHORS}"
+  rules:
+  - sqlc/db-prepare
+  # - mysql-query-too-costly
+  gen:
+    go:
+      package: authors
+      out: mysql
+- name: sqlite
+  schema: sqlite/schema.sql
+  queries: sqlite/query.sql
+  engine: sqlite
+  database:
+    uri: file:authors?mode=memory&cache=shared
+  rules:
+  - sqlc/db-prepare
+  gen:
+    go:
+      package: authors
+      out: sqlite
+rules:
+- name: postgresql-query-too-costly
+  message: "Too costly"
+  rule: "postgresql.explain.plan.total_cost > 300.0"
+- name: mysql-query-too-costly
+  message: "Too costly"
+  rule: "has(mysql.explain.query_block.cost_info) && double(mysql.explain.query_block.cost_info.query_cost) > 2.0"

examples/authors/sqlite/db.go

@@ -0,0 +1,31 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package authors
+
+import (
+	"context"
+	"database/sql"
+)
+
+type DBTX interface {
+	ExecContext(context.Context, string, ...any) (sql.Result, error)
+	PrepareContext(context.Context, string) (*sql.Stmt, error)
+	QueryContext(context.Context, string, ...any) (*sql.Rows, error)
+	QueryRowContext(context.Context, string, ...any) *sql.Row
+}
+
+func New(db DBTX) *Queries {
+	return &Queries{db: db}
+}
+
+type Queries struct {
+	db DBTX
+}
+
+func (q *Queries) WithTx(tx *sql.Tx) *Queries {
+	return &Queries{
+		db: tx,
+	}
+}

examples/authors/sqlite/db_test.go

@@ -0,0 +1,48 @@
+//go:build examples
+
+package authors
+
+import (
+	"context"
+	"database/sql"
+	"testing"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest"
+)
+
+func TestAuthors(t *testing.T) {
+	sdb, cleanup := sqltest.SQLite(t, []string{"schema.sql"})
+	defer sdb.Close()
+	defer cleanup()
+
+	ctx := context.Background()
+	db := New(sdb)
+
+	// list all authors
+	authors, err := db.ListAuthors(ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(authors)
+
+	// create an author
+	result, err := db.CreateAuthor(ctx, CreateAuthorParams{
+		Name: "Brian Kernighan",
+		Bio:  sql.NullString{String: "Co-author of The C Programming Language and The Go Programming Language", Valid: true},
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	authorID, err := result.LastInsertId()
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(authorID)
+
+	// get the author we just inserted
+	fetchedAuthor, err := db.GetAuthor(ctx, authorID)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(fetchedAuthor)
+}

examples/authors/sqlite/models.go

@@ -0,0 +1,15 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package authors
+
+import (
+	"database/sql"
+)
+
+type Author struct {
+	ID   int64
+	Name string
+	Bio  sql.NullString
+}

examples/authors/sqlite/query.sql

@@ -0,0 +1,18 @@
+/* name: GetAuthor :one */
+SELECT * FROM authors
+WHERE id = ? LIMIT 1;
+
+/* name: ListAuthors :many */
+SELECT * FROM authors
+ORDER BY name;
+
+/* name: CreateAuthor :execresult */
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ? 
+);
+
+/* name: DeleteAuthor :exec */
+DELETE FROM authors
+WHERE id = ?;

examples/authors/sqlite/query.sql.go

@@ -0,0 +1,78 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: query.sql
+
+package authors
+
+import (
+	"context"
+	"database/sql"
+)
+
+const createAuthor = `-- name: CreateAuthor :execresult
+INSERT INTO authors (
+  name, bio
+) VALUES (
+  ?, ? 
+)
+`
+
+type CreateAuthorParams struct {
+	Name string
+	Bio  sql.NullString
+}
+
+func (q *Queries) CreateAuthor(ctx context.Context, arg CreateAuthorParams) (sql.Result, error) {
+	return q.db.ExecContext(ctx, createAuthor, arg.Name, arg.Bio)
+}
+
+const deleteAuthor = `-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = ?
+`
+
+func (q *Queries) DeleteAuthor(ctx context.Context, id int64) error {
+	_, err := q.db.ExecContext(ctx, deleteAuthor, id)
+	return err
+}
+
+const getAuthor = `-- name: GetAuthor :one
+SELECT id, name, bio FROM authors
+WHERE id = ? LIMIT 1
+`
+
+func (q *Queries) GetAuthor(ctx context.Context, id int64) (Author, error) {
+	row := q.db.QueryRowContext(ctx, getAuthor, id)
+	var i Author
+	err := row.Scan(&i.ID, &i.Name, &i.Bio)
+	return i, err
+}
+
+const listAuthors = `-- name: ListAuthors :many
+SELECT id, name, bio FROM authors
+ORDER BY name
+`
+
+func (q *Queries) ListAuthors(ctx context.Context) ([]Author, error) {
+	rows, err := q.db.QueryContext(ctx, listAuthors)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []Author
+	for rows.Next() {
+		var i Author
+		if err := rows.Scan(&i.ID, &i.Name, &i.Bio); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}

examples/authors/sqlite/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE authors (
+          id   integer    PRIMARY KEY AUTOINCREMENT,
+          name text   NOT NULL,
+          bio  text
+);