Transactions: SQLite and MySQL
Every file of the SQLite and MySQL versions side by side, with the lines that differ marked. 4 parameter or column types differ in Go.
Configuration
sgl.yamldiffers
SQLite
MySQL
1
version: 11
version: 12
2
3
databases:3
databases:4
- name: bank4
- name: bank5
dialect: sqlite5
dialect: mysql6
migrations: db/migrations6
migrations: db/migrations7
queries: db/queries7
queries: db/queries8
go:8
go:9
package: store9
package: store10
out: internal/store10
out: internal/storeMigrations
db/migrations/0001_accounts.up.sqldiffers
SQLite
MySQL
1
CREATE TABLE accounts (1
CREATE TABLE accounts (2
id INTEGER PRIMARY KEY,2
id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY,3
owner TEXT NOT NULL,3
owner VARCHAR(50) NOT NULL,4
balance INTEGER NOT NULL CHECK (balance >= 0)4
balance INT NOT NULL,5
CONSTRAINT balance_not_negative CHECK (balance >= 0)5
);6
);db/migrations/0001_accounts.down.sqlidentical
SQLite
MySQL
1
DROP TABLE accounts;1
DROP TABLE accounts;Queries
OpenAccountdiffers
SQLite · db/queries/accounts.sql
MySQL · db/queries/accounts.sql
1
-- sgl.query(OpenAccount, one)1
-- sgl.query(OpenAccount, execresult)2
INSERT INTO accounts (owner, balance) VALUES (?, ?) RETURNING id;2
INSERT INTO accounts (owner, balance) VALUES (?, ?);Depositidentical
SQLite · db/queries/accounts.sql
MySQL · db/queries/accounts.sql
1
-- sgl.query(Deposit, exec)1
-- sgl.query(Deposit, exec)2
UPDATE accounts SET balance = balance + :amount WHERE id = :id;2
UPDATE accounts SET balance = balance + :amount WHERE id = :id;Withdrawidentical
SQLite · db/queries/accounts.sql
MySQL · db/queries/accounts.sql
1
-- sgl.query(Withdraw, exec)1
-- sgl.query(Withdraw, exec)2
UPDATE accounts SET balance = balance - :amount WHERE id = :id;2
UPDATE accounts SET balance = balance - :amount WHERE id = :id;ListAccountsidentical
SQLite · db/queries/accounts.sql
MySQL · db/queries/accounts.sql
1
-- sgl.query(ListAccounts, many)1
-- sgl.query(ListAccounts, many)2
SELECT id, owner, balance FROM accounts ORDER BY id;2
SELECT id, owner, balance FROM accounts ORDER BY id;What sgl generates
OpenAccountdiffers
SQLite
MySQL
1
func (queries *Queries) OpenAccount(ctx context.Context, params OpenAccountParams) (OpenAccountRow, error)1
func (queries *Queries) OpenAccount(ctx context.Context, params OpenAccountParams) (sql.Result, error)2
2
3
type OpenAccountParams struct {3
type OpenAccountParams struct {4
Owner string4
Owner string5
Balance int645
Balance int326
}7
8
type OpenAccountRow struct {9
ID int64 `json:"id"`10
}6
}Depositdiffers
SQLite
MySQL
1
func (queries *Queries) Deposit(ctx context.Context, params DepositParams) error1
func (queries *Queries) Deposit(ctx context.Context, params DepositParams) error2
2
3
type DepositParams struct {3
type DepositParams struct {4
Amount int644
Amount int325
ID int645
ID int646
}6
}Withdrawdiffers
SQLite
MySQL
1
func (queries *Queries) Withdraw(ctx context.Context, params WithdrawParams) error1
func (queries *Queries) Withdraw(ctx context.Context, params WithdrawParams) error2
2
3
type WithdrawParams struct {3
type WithdrawParams struct {4
Amount int644
Amount int325
ID int645
ID int646
}6
}ListAccountsdiffers
SQLite
MySQL
1
func (queries *Queries) ListAccounts(ctx context.Context) ([]ListAccountsRow, error)1
func (queries *Queries) ListAccounts(ctx context.Context) ([]ListAccountsRow, error)2
2
3
type ListAccountsRow struct {3
type ListAccountsRow struct {4
ID int64 `json:"id"`4
ID int64 `json:"id"`5
Owner string `json:"owner"`5
Owner string `json:"owner"`6
Balance int64 `json:"balance"`6
Balance int32 `json:"balance"`7
}7
}The program
example.godiffers
SQLite
MySQL
1
package main1
package main2
2
3
import (3
import (4
"context"4
"context"5
"database/sql"5
"database/sql"6
"errors"6
"errors"7
"fmt"7
"fmt"8
"io"8
"io"9
"strings"9
10
10
"seagull.sh/seagull/examples/sqlite/023_transactions/internal/store"11
"seagull.sh/seagull/examples/mysql/023_transactions/internal/store"11
)12
)12
13
13
// run opens two accounts in a transaction it manages itself, then makes two transfers14
// run opens two accounts in a transaction it manages itself, then makes two transfers14
// with RunInTx: one commits, and one breaks the balance check part-way and rolls back.15
// with RunInTx: one commits, and one breaks the balance check part-way and rolls back.15
//16
//16
// Takes database (*sql.DB) which is a migrated database.17
// Takes database (*sql.DB) which is a migrated database.17
// Takes output (io.Writer) which receives each step and the balances.18
// Takes output (io.Writer) which receives each step and the balances.18
//19
//19
// Returns error when a query fails other than as the example expects.20
// Returns error when a query fails other than as the example expects.20
func run(ctx context.Context, database *sql.DB, output io.Writer) error {21
func run(ctx context.Context, database *sql.DB, output io.Writer) error {21
queries := store.New(database)22
queries := store.New(database)22
23
23
pip, gull, err := openAccounts(ctx, database, queries)24
pip, gull, err := openAccounts(ctx, database, queries)24
if err != nil {25
if err != nil {25
return fmt.Errorf("opening accounts: %w", err)26
return fmt.Errorf("opening accounts: %w", err)26
}27
}27
fmt.Fprintln(output, "opened accounts for Pip and Gull: committed")28
fmt.Fprintln(output, "opened accounts for Pip and Gull: committed")28
if err := printBalances(ctx, queries, output); err != nil {29
if err := printBalances(ctx, queries, output); err != nil {29
return err30
return err30
}31
}31
32
32
if err := transfer(ctx, database, queries, pip, gull, 1500); err != nil {33
if err := transfer(ctx, database, queries, pip, gull, 1500); err != nil {33
return fmt.Errorf("first transfer: %w", err)34
return fmt.Errorf("first transfer: %w", err)34
}35
}35
fmt.Fprintln(output, "transferred 1500 from Pip to Gull: committed")36
fmt.Fprintln(output, "transferred 1500 from Pip to Gull: committed")36
if err := printBalances(ctx, queries, output); err != nil {37
if err := printBalances(ctx, queries, output); err != nil {37
return err38
return err38
}39
}39
40
40
// Gull holds 3500, so this transfer credits Pip and then fails the CHECK constraint when41
// Gull holds 3500, so this transfer credits Pip and then fails the CHECK constraint when41
// it debits Gull. RunInTx rolls back, and the credit to Pip that had already run is42
// it debits Gull. RunInTx rolls back, and the credit to Pip that had already run is42
// undone with it.43
// undone with it. MySQL reports the failure as error 3819, naming the constraint.44
// MariaDB words it differently and names the database too, so the example checks for the45
// constraint's name and prints its own line.43
err = transfer(ctx, database, queries, gull, pip, 9000)46
err = transfer(ctx, database, queries, gull, pip, 9000)44
if err == nil {47
if err == nil {45
return errors.New("an overdrawing transfer committed")48
return errors.New("an overdrawing transfer committed")46
}49
}47
fmt.Fprintf(output, "transferred 9000 from Gull to Pip: rolled back (%v)\n", err)50
if !strings.Contains(err.Error(), "balance_not_negative") {51
return fmt.Errorf("second transfer failed other than at the balance check: %w", err)52
}53
fmt.Fprintln(output, "transferred 9000 from Gull to Pip: rolled back, as the debit broke balance_not_negative")48
return printBalances(ctx, queries, output)54
return printBalances(ctx, queries, output)49
}55
}50
56
51
// openAccounts opens both accounts in one transaction that it begins and commits itself.57
// openAccounts opens both accounts in one transaction that it begins and commits itself.52
// WithTx returns a copy of queries bound to that transaction, which suits a transaction58
// WithTx returns a copy of queries bound to that transaction, which suits a transaction53
// begun with options or shared with code that does not use Seagull.59
// begun with options or shared with code that does not use Seagull.54
//60
//55
// Takes database (*sql.DB) which begins the transaction.61
// Takes database (*sql.DB) which begins the transaction.56
// Takes queries (*store.Queries) which are bound to it.62
// Takes queries (*store.Queries) which are bound to it.57
//63
//58
// Returns pipID (int64) which is Pip's account ID.64
// Returns pipID (int64) which is Pip's account ID.59
// Returns gullID (int64) which is Gull's account ID.65
// Returns gullID (int64) which is Gull's account ID.60
// Returns err (error) when an account cannot be opened or the commit fails.66
// Returns err (error) when an account cannot be opened or the commit fails.61
func openAccounts(ctx context.Context, database *sql.DB, queries *store.Queries) (pipID, gullID int64, err error) {67
func openAccounts(ctx context.Context, database *sql.DB, queries *store.Queries) (pipID, gullID int64, err error) {62
transaction, err := database.BeginTx(ctx, nil)68
transaction, err := database.BeginTx(ctx, nil)63
if err != nil {69
if err != nil {64
return 0, 0, err70
return 0, 0, err65
}71
}66
// Rollback after a successful Commit does nothing, so deferring it covers every early72
// Rollback after a successful Commit does nothing, so deferring it covers every early67
// return.73
// return.68
defer func() { _ = transaction.Rollback() }()74
defer func() { _ = transaction.Rollback() }()69
75
70
inTransaction := queries.WithTx(transaction)76
inTransaction := queries.WithTx(transaction)71
pip, err := inTransaction.OpenAccount(ctx, store.OpenAccountParams{Owner: "Pip", Balance: 5000})77
pip, err := openAccount(ctx, inTransaction, "Pip", 5000)72
if err != nil {78
if err != nil {73
return 0, 0, err79
return 0, 0, err74
}80
}75
gull, err := inTransaction.OpenAccount(ctx, store.OpenAccountParams{Owner: "Gull", Balance: 2000})81
gull, err := openAccount(ctx, inTransaction, "Gull", 2000)76
if err != nil {82
if err != nil {77
return 0, 0, err83
return 0, 0, err78
}84
}79
return pip.ID, gull.ID, transaction.Commit()85
return pip, gull, transaction.Commit()80
}86
}81
87
88
// openAccount opens an account and returns the id MySQL gave it. MySQL has no RETURNING,89
// so OpenAccount is execresult, and LastInsertId reads the AUTO_INCREMENT id from the90
// result of the INSERT, on the transaction's own connection.91
//92
// Takes queries (*store.Queries) which run the INSERT.93
// Takes owner (string) which names the account holder.94
// Takes balance (int32) which is the opening balance, in pence.95
//96
// Returns int64 which is the new account's ID.97
// Returns error when the INSERT fails.98
func openAccount(ctx context.Context, queries *store.Queries, owner string, balance int32) (int64, error) {99
result, err := queries.OpenAccount(ctx, store.OpenAccountParams{Owner: owner, Balance: balance})100
if err != nil {101
return 0, err102
}103
return result.LastInsertId()104
}105
82
// transfer moves an amount between two accounts with RunInTx, which begins a transaction,106
// transfer moves an amount between two accounts with RunInTx, which begins a transaction,83
// passes fn a Queries bound to it, and commits when fn returns nil or rolls back when it107
// passes fn a Queries bound to it, and commits when fn returns nil or rolls back when it84
// returns an error.108
// returns an error.85
//109
//86
// Takes database (*sql.DB) which begins the transaction.110
// Takes database (*sql.DB) which begins the transaction.87
// Takes queries (*store.Queries) which run the transfer.111
// Takes queries (*store.Queries) which run the transfer.88
// Takes from (int64) which is the account to debit.112
// Takes from (int64) which is the account to debit.89
// Takes to (int64) which is the account to credit.113
// Takes to (int64) which is the account to credit.90
// Takes amount (int64) which is the sum to move, in pence.114
// Takes amount (int32) which is the sum to move, in pence.91
//115
//92
// Returns error when either update fails; the transaction is then rolled back.116
// Returns error when either update fails; the transaction is then rolled back.93
func transfer(ctx context.Context, database *sql.DB, queries *store.Queries, from, to, amount int64) error {117
func transfer(ctx context.Context, database *sql.DB, queries *store.Queries, from, to int64, amount int32) error {94
return queries.RunInTx(ctx, database, func(inTransaction *store.Queries) error {118
return queries.RunInTx(ctx, database, func(inTransaction *store.Queries) error {95
if err := inTransaction.Deposit(ctx, store.DepositParams{Amount: amount, ID: to}); err != nil {119
if err := inTransaction.Deposit(ctx, store.DepositParams{Amount: amount, ID: to}); err != nil {96
return err120
return err97
}121
}98
return inTransaction.Withdraw(ctx, store.WithdrawParams{Amount: amount, ID: from})122
return inTransaction.Withdraw(ctx, store.WithdrawParams{Amount: amount, ID: from})99
})123
})100
}124
}101
125
102
// printBalances writes every account's balance on one line.126
// printBalances writes every account's balance on one line.103
//127
//104
// Takes queries (*store.Queries) which read the accounts.128
// Takes queries (*store.Queries) which read the accounts.105
// Takes output (io.Writer) which receives the line.129
// Takes output (io.Writer) which receives the line.106
//130
//107
// Returns error when the accounts cannot be listed.131
// Returns error when the accounts cannot be listed.108
func printBalances(ctx context.Context, queries *store.Queries, output io.Writer) error {132
func printBalances(ctx context.Context, queries *store.Queries, output io.Writer) error {109
accounts, err := queries.ListAccounts(ctx)133
accounts, err := queries.ListAccounts(ctx)110
if err != nil {134
if err != nil {111
return fmt.Errorf("listing accounts: %w", err)135
return fmt.Errorf("listing accounts: %w", err)112
}136
}113
fmt.Fprint(output, " balances:")137
fmt.Fprint(output, " balances:")114
for _, account := range accounts {138
for _, account := range accounts {115
fmt.Fprintf(output, " %s %d", account.Owner, account.Balance)139
fmt.Fprintf(output, " %s %d", account.Owner, account.Balance)116
}140
}117
fmt.Fprintln(output)141
fmt.Fprintln(output)118
return nil142
return nil119
}143
}Go type differences
The same SQL types map to different Go types, because each database reports them differently.
| Query | Field | SQLite | MySQL |
|---|---|---|---|
| OpenAccount | parameter balance | int64 | int32 |
| Deposit | parameter amount | int64 | int32 |
| Withdraw | parameter amount | int64 | int32 |
| ListAccounts | column balance | int64 | int32 |