Transactions: MariaDB and DuckDB
Every file of the MariaDB and DuckDB versions side by side, with the lines that differ marked.
Configuration
sgl.yamldiffers
MariaDB
DuckDB
1
version: 11
version: 12
2
3
databases:3
databases:4
- name: bank4
- name: bank5
dialect: mysql5
dialect: duckdb6
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
MariaDB
DuckDB
1
CREATE SEQUENCE account_ids;2
1
CREATE TABLE accounts (3
CREATE TABLE accounts (2
id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY,4
id BIGINT PRIMARY KEY DEFAULT nextval('account_ids'),3
owner VARCHAR(50) NOT NULL,5
owner VARCHAR NOT NULL,4
balance INT NOT NULL,6
balance INTEGER NOT NULL CHECK (balance >= 0)5
CONSTRAINT balance_not_negative CHECK (balance >= 0)6
);7
);db/migrations/0001_accounts.down.sqldiffers
MariaDB
DuckDB
1
DROP TABLE accounts;1
DROP TABLE accounts;2
DROP SEQUENCE account_ids;Queries
OpenAccountdiffers
MariaDB · db/queries/accounts.sql
DuckDB · db/queries/accounts.sql
1
-- sgl.query(OpenAccount, execresult)1
-- sgl.query(OpenAccount, one)2
INSERT INTO accounts (owner, balance) VALUES (?, ?);2
INSERT INTO accounts (owner, balance) VALUES ($1, $2) RETURNING id;Depositidentical
MariaDB · db/queries/accounts.sql
DuckDB · 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
MariaDB · db/queries/accounts.sql
DuckDB · 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
MariaDB · db/queries/accounts.sql
DuckDB · 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
MariaDB
DuckDB
1
func (queries *Queries) OpenAccount(ctx context.Context, params OpenAccountParams) (sql.Result, error)1
func (queries *Queries) OpenAccount(ctx context.Context, params OpenAccountParams) (OpenAccountRow, error)2
2
3
type OpenAccountParams struct {3
type OpenAccountParams struct {4
Owner string4
Owner string5
Balance int325
Balance int326
}6
}7
8
type OpenAccountRow struct {9
ID int64 `json:"id"`10
}Depositidentical
MariaDB
DuckDB
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 int324
Amount int325
ID int645
ID int646
}6
}Withdrawidentical
MariaDB
DuckDB
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 int324
Amount int325
ID int645
ID int646
}6
}ListAccountsidentical
MariaDB
DuckDB
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 int32 `json:"balance"`6
Balance int32 `json:"balance"`7
}7
}The program
example.godiffers
MariaDB
DuckDB
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"10
9
11
"seagull.sh/seagull/examples/mysql/023_transactions/internal/store"10
"seagull.sh/seagull/examples/duckdb/023_transactions/internal/store"12
)11
)13
12
14
// run opens two accounts in a transaction it manages itself, then makes two transfers13
// run opens two accounts in a transaction it manages itself, then makes two transfers15
// with RunInTx: one commits, and one breaks the balance check part-way and rolls back.14
// with RunInTx: one commits, and one breaks the balance check part-way and rolls back.16
//15
//17
// Takes database (*sql.DB) which is a migrated database.16
// Takes database (*sql.DB) which is a migrated database.18
// Takes output (io.Writer) which receives each step and the balances.17
// Takes output (io.Writer) which receives each step and the balances.19
//18
//20
// Returns error when a query fails other than as the example expects.19
// Returns error when a query fails other than as the example expects.21
func run(ctx context.Context, database *sql.DB, output io.Writer) error {20
func run(ctx context.Context, database *sql.DB, output io.Writer) error {22
queries := store.New(database)21
queries := store.New(database)23
22
24
pip, gull, err := openAccounts(ctx, database, queries)23
pip, gull, err := openAccounts(ctx, database, queries)25
if err != nil {24
if err != nil {26
return fmt.Errorf("opening accounts: %w", err)25
return fmt.Errorf("opening accounts: %w", err)27
}26
}28
fmt.Fprintln(output, "opened accounts for Pip and Gull: committed")27
fmt.Fprintln(output, "opened accounts for Pip and Gull: committed")29
if err := printBalances(ctx, queries, output); err != nil {28
if err := printBalances(ctx, queries, output); err != nil {30
return err29
return err31
}30
}32
31
33
if err := transfer(ctx, database, queries, pip, gull, 1500); err != nil {32
if err := transfer(ctx, database, queries, pip, gull, 1500); err != nil {34
return fmt.Errorf("first transfer: %w", err)33
return fmt.Errorf("first transfer: %w", err)35
}34
}36
fmt.Fprintln(output, "transferred 1500 from Pip to Gull: committed")35
fmt.Fprintln(output, "transferred 1500 from Pip to Gull: committed")37
if err := printBalances(ctx, queries, output); err != nil {36
if err := printBalances(ctx, queries, output); err != nil {38
return err37
return err39
}38
}40
39
41
// Gull holds 3500, so this transfer credits Pip and then fails the CHECK constraint when40
// Gull holds 3500, so this transfer credits Pip and then fails the CHECK constraint when42
// it debits Gull. RunInTx rolls back, and the credit to Pip that had already run is41
// it debits Gull. RunInTx rolls back, and the credit to Pip that had already run is43
// undone with it. MySQL reports the failure as error 3819, naming the constraint.42
// undone with it.44
// MariaDB words it differently and names the database too, so the example checks for the45
// constraint's name and prints its own line.46
err = transfer(ctx, database, queries, gull, pip, 9000)43
err = transfer(ctx, database, queries, gull, pip, 9000)47
if err == nil {44
if err == nil {48
return errors.New("an overdrawing transfer committed")45
return errors.New("an overdrawing transfer committed")49
}46
}50
if !strings.Contains(err.Error(), "balance_not_negative") {47
fmt.Fprintf(output, "transferred 9000 from Gull to Pip: rolled back (%v)\n", err)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")54
return printBalances(ctx, queries, output)48
return printBalances(ctx, queries, output)55
}49
}56
50
57
// openAccounts opens both accounts in one transaction that it begins and commits itself.51
// openAccounts opens both accounts in one transaction that it begins and commits itself.58
// WithTx returns a copy of queries bound to that transaction, which suits a transaction52
// WithTx returns a copy of queries bound to that transaction, which suits a transaction59
// begun with options or shared with code that does not use Seagull.53
// begun with options or shared with code that does not use Seagull.60
//54
//61
// Takes database (*sql.DB) which begins the transaction.55
// Takes database (*sql.DB) which begins the transaction.62
// Takes queries (*store.Queries) which are bound to it.56
// Takes queries (*store.Queries) which are bound to it.63
//57
//64
// Returns pipID (int64) which is Pip's account ID.58
// Returns pipID (int64) which is Pip's account ID.65
// Returns gullID (int64) which is Gull's account ID.59
// Returns gullID (int64) which is Gull's account ID.66
// Returns err (error) when an account cannot be opened or the commit fails.60
// Returns err (error) when an account cannot be opened or the commit fails.67
func openAccounts(ctx context.Context, database *sql.DB, queries *store.Queries) (pipID, gullID int64, err error) {61
func openAccounts(ctx context.Context, database *sql.DB, queries *store.Queries) (pipID, gullID int64, err error) {68
transaction, err := database.BeginTx(ctx, nil)62
transaction, err := database.BeginTx(ctx, nil)69
if err != nil {63
if err != nil {70
return 0, 0, err64
return 0, 0, err71
}65
}72
// Rollback after a successful Commit does nothing, so deferring it covers every early66
// Rollback after a successful Commit does nothing, so deferring it covers every early73
// return.67
// return.74
defer func() { _ = transaction.Rollback() }()68
defer func() { _ = transaction.Rollback() }()75
69
76
inTransaction := queries.WithTx(transaction)70
inTransaction := queries.WithTx(transaction)77
pip, err := openAccount(ctx, inTransaction, "Pip", 5000)71
pip, err := inTransaction.OpenAccount(ctx, store.OpenAccountParams{Owner: "Pip", Balance: 5000})78
if err != nil {72
if err != nil {79
return 0, 0, err73
return 0, 0, err80
}74
}81
gull, err := openAccount(ctx, inTransaction, "Gull", 2000)75
gull, err := inTransaction.OpenAccount(ctx, store.OpenAccountParams{Owner: "Gull", Balance: 2000})82
if err != nil {76
if err != nil {83
return 0, 0, err77
return 0, 0, err84
}78
}85
return pip, gull, transaction.Commit()79
return pip.ID, gull.ID, transaction.Commit()86
}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
}80
}105
81
106
// transfer moves an amount between two accounts with RunInTx, which begins a transaction,82
// transfer moves an amount between two accounts with RunInTx, which begins a transaction,107
// passes fn a Queries bound to it, and commits when fn returns nil or rolls back when it83
// passes fn a Queries bound to it, and commits when fn returns nil or rolls back when it108
// returns an error.84
// returns an error.109
//85
//110
// Takes database (*sql.DB) which begins the transaction.86
// Takes database (*sql.DB) which begins the transaction.111
// Takes queries (*store.Queries) which run the transfer.87
// Takes queries (*store.Queries) which run the transfer.112
// Takes from (int64) which is the account to debit.88
// Takes from (int64) which is the account to debit.113
// Takes to (int64) which is the account to credit.89
// Takes to (int64) which is the account to credit.114
// Takes amount (int32) which is the sum to move, in pence.90
// Takes amount (int32) which is the sum to move, in pence.115
//91
//116
// Returns error when either update fails; the transaction is then rolled back.92
// Returns error when either update fails; the transaction is then rolled back.117
func transfer(ctx context.Context, database *sql.DB, queries *store.Queries, from, to int64, amount int32) error {93
func transfer(ctx context.Context, database *sql.DB, queries *store.Queries, from, to int64, amount int32) error {118
return queries.RunInTx(ctx, database, func(inTransaction *store.Queries) error {94
return queries.RunInTx(ctx, database, func(inTransaction *store.Queries) error {119
if err := inTransaction.Deposit(ctx, store.DepositParams{Amount: amount, ID: to}); err != nil {95
if err := inTransaction.Deposit(ctx, store.DepositParams{Amount: amount, ID: to}); err != nil {120
return err96
return err121
}97
}122
return inTransaction.Withdraw(ctx, store.WithdrawParams{Amount: amount, ID: from})98
return inTransaction.Withdraw(ctx, store.WithdrawParams{Amount: amount, ID: from})123
})99
})124
}100
}125
101
126
// printBalances writes every account's balance on one line.102
// printBalances writes every account's balance on one line.127
//103
//128
// Takes queries (*store.Queries) which read the accounts.104
// Takes queries (*store.Queries) which read the accounts.129
// Takes output (io.Writer) which receives the line.105
// Takes output (io.Writer) which receives the line.130
//106
//131
// Returns error when the accounts cannot be listed.107
// Returns error when the accounts cannot be listed.132
func printBalances(ctx context.Context, queries *store.Queries, output io.Writer) error {108
func printBalances(ctx context.Context, queries *store.Queries, output io.Writer) error {133
accounts, err := queries.ListAccounts(ctx)109
accounts, err := queries.ListAccounts(ctx)134
if err != nil {110
if err != nil {135
return fmt.Errorf("listing accounts: %w", err)111
return fmt.Errorf("listing accounts: %w", err)136
}112
}137
fmt.Fprint(output, " balances:")113
fmt.Fprint(output, " balances:")138
for _, account := range accounts {114
for _, account := range accounts {139
fmt.Fprintf(output, " %s %d", account.Owner, account.Balance)115
fmt.Fprintf(output, " %s %d", account.Owner, account.Balance)140
}116
}141
fmt.Fprintln(output)117
fmt.Fprintln(output)142
return nil118
return nil143
}119
}