Compare · 012

Validated ORDER BY: TimescaleDB and MariaDB

Every file of the TimescaleDB and MariaDB versions side by side, with the lines that differ marked. 4 parameter or column types differ in Go.

Compare TimescaleDB withSQLite PostgreSQL CockroachDB MySQL MariaDB DuckDB ClickHouse

Configuration

sgl.yamldiffers

TimescaleDB
MariaDB
1version: 1
1version: 1
2
2
3databases:
3databases:
4  - name: regatta
4  - name: regatta
5    dialect: postgres
5    dialect: mysql
6    migrations: db/migrations
6    migrations: db/migrations
7    queries: db/queries
7    queries: db/queries
8    go:
8    go:
9      package: store
9      package: store
10      out: internal/store
10      out: internal/store
11      driver: database/sql

Migrations

db/migrations/0001_entries.up.sqldiffers

TimescaleDB
MariaDB
1CREATE TABLE entries (
1CREATE TABLE entries (
2    id             BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
2    id             BIGINT      NOT NULL AUTO_INCREMENT PRIMARY KEY,
3    boat           TEXT   NOT NULL,
3    boat           VARCHAR(50) NOT NULL,
4    crew           BIGINT NOT NULL,
4    crew           INT         NOT NULL,
5    finish_seconds BIGINT NOT NULL
5    finish_seconds INT         NOT NULL
6);
6);

db/migrations/0001_entries.down.sqlidentical

TimescaleDB
MariaDB
1DROP TABLE entries;
1DROP TABLE entries;

Queries

EnterBoatdiffers

TimescaleDB · db/queries/entries.sql
MariaDB · db/queries/entries.sql
1-- sgl.query(EnterBoat, exec)
1-- sgl.query(EnterBoat, exec)
2INSERT INTO entries (boat, crew, finish_seconds) VALUES ($1, $2, $3);
2INSERT INTO entries (boat, crew, finish_seconds) VALUES (?, ?, ?);

ListEntriesidentical

TimescaleDB · db/queries/entries.sql
MariaDB · db/queries/entries.sql
1-- sgl.query(ListEntries, many)
1-- sgl.query(ListEntries, many)
2-- sgl.sortable(order_by, [boat, crew, finish_seconds])
2-- sgl.sortable(order_by, [boat, crew, finish_seconds])
3SELECT id, boat, crew, finish_seconds FROM entries
3SELECT id, boat, crew, finish_seconds FROM entries

What sgl generates

EnterBoatdiffers

TimescaleDB
MariaDB
1func (queries *Queries) EnterBoat(ctx context.Context, params EnterBoatParams) error
1func (queries *Queries) EnterBoat(ctx context.Context, params EnterBoatParams) error
2
2
3type EnterBoatParams struct {
3type EnterBoatParams struct {
4	Boat          string
4	Boat          string
5	Crew          int64
5	Crew          int32
6	FinishSeconds int64
6	FinishSeconds int32
7}
7}

ListEntriesdiffers

TimescaleDB
MariaDB
1func (queries *Queries) ListEntries(ctx context.Context, params ListEntriesParams) ([]ListEntriesRow, error)
1func (queries *Queries) ListEntries(ctx context.Context, params ListEntriesParams) ([]ListEntriesRow, error)
2
2
3type ListEntriesParams struct {
3type ListEntriesParams struct {
4	OrderBy          ListEntriesOrderBy
4	OrderBy          ListEntriesOrderBy
5	OrderByDirection OrderDirection
5	OrderByDirection OrderDirection
6}
6}
7
7
8type ListEntriesRow struct {
8type ListEntriesRow struct {
9	ID            int64  `json:"id"`
9	ID            int64  `json:"id"`
10	Boat          string `json:"boat"`
10	Boat          string `json:"boat"`
11	Crew          int64  `json:"crew"`
11	Crew          int32  `json:"crew"`
12	FinishSeconds int64  `json:"finish_seconds"`
12	FinishSeconds int32  `json:"finish_seconds"`
13}
13}
14
14
15type ListEntriesOrderBy string
15type ListEntriesOrderBy string
16
16
17type OrderDirection string
17type OrderDirection string

The program

example.godiffers

TimescaleDB
MariaDB
1package main
1package main
2
2
3import (
3import (
4	"context"
4	"context"
5	"database/sql"
5	"database/sql"
6	"fmt"
6	"fmt"
7	"io"
7	"io"
8	"time"
8	"time"
9
9
10	"seagull.sh/seagull/examples/postgres/012_sortable/internal/store"
10	"seagull.sh/seagull/examples/mysql/012_sortable/internal/store"
11)
11)
12
12
13// run lists a regatta's entries in four orders. sgl.sortable(order_by, [boat, crew,
13// run lists a regatta's entries in four orders. sgl.sortable(order_by, [boat, crew,
14// finish_seconds]) has no placeholder: it gives ListEntriesParams an OrderBy field, typed
14// finish_seconds]) has no placeholder: it gives ListEntriesParams an OrderBy field, typed
15// with one constant per allowed column, and an OrderByDirection. The method appends ORDER
15// with one constant per allowed column, and an OrderByDirection. The method appends ORDER
16// BY only when OrderBy is one of the allowed columns, so a value that is not, such as raw
16// BY only when OrderBy is one of the allowed columns, so a value that is not, such as raw
17// text from a request, adds nothing to the SQL and the rows come back in whatever order
17// text from a request, adds nothing to the SQL and the rows come back unsorted. A
18// the server reads them, here the order they were entered. A sortable column the query
18// sortable column the query does not select makes sgl vet report Q011.
19// does not select makes sgl vet report Q011.
20//
19//
21// Takes database (*sql.DB) which is a migrated database.
20// Takes database (*sql.DB) which is a migrated database.
22// Takes output (io.Writer) which receives each listing.
21// Takes output (io.Writer) which receives each listing.
23//
22//
24// Returns error when a query fails.
23// Returns error when a query fails.
25func run(ctx context.Context, database *sql.DB, output io.Writer) error {
24func run(ctx context.Context, database *sql.DB, output io.Writer) error {
26	queries := store.New(database)
25	queries := store.New(database)
27
26
28	entries := []store.EnterBoatParams{
27	entries := []store.EnterBoatParams{
29		{Boat: "Kittiwake", Crew: 4, FinishSeconds: 3725},
28		{Boat: "Kittiwake", Crew: 4, FinishSeconds: 3725},
30		{Boat: "Salty Chip", Crew: 3, FinishSeconds: 3410},
29		{Boat: "Salty Chip", Crew: 3, FinishSeconds: 3410},
31		{Boat: "Gull Wing", Crew: 5, FinishSeconds: 3990},
30		{Boat: "Gull Wing", Crew: 5, FinishSeconds: 3990},
32		{Boat: "Driftwood", Crew: 2, FinishSeconds: 3588},
31		{Boat: "Driftwood", Crew: 2, FinishSeconds: 3588},
33	}
32	}
34	for _, entry := range entries {
33	for _, entry := range entries {
35		if err := queries.EnterBoat(ctx, entry); err != nil {
34		if err := queries.EnterBoat(ctx, entry); err != nil {
36			return fmt.Errorf("entering %s: %w", entry.Boat, err)
35			return fmt.Errorf("entering %s: %w", entry.Boat, err)
37		}
36		}
38	}
37	}
39
38
40	orders := []struct {
39	orders := []struct {
41		label      string
40		label      string
42		parameters store.ListEntriesParams
41		parameters store.ListEntriesParams
43	}{
42	}{
44		{label: "results", parameters: store.ListEntriesParams{OrderBy: store.ListEntriesOrderByFinishSeconds, OrderByDirection: store.OrderAsc}},
43		{label: "results", parameters: store.ListEntriesParams{OrderBy: store.ListEntriesOrderByFinishSeconds, OrderByDirection: store.OrderAsc}},
45		{label: "by boat", parameters: store.ListEntriesParams{OrderBy: store.ListEntriesOrderByBoat, OrderByDirection: store.OrderAsc}},
44		{label: "by boat", parameters: store.ListEntriesParams{OrderBy: store.ListEntriesOrderByBoat, OrderByDirection: store.OrderAsc}},
46		{label: "largest crew first", parameters: store.ListEntriesParams{OrderBy: store.ListEntriesOrderByCrew, OrderByDirection: store.OrderDesc}},
45		{label: "largest crew first", parameters: store.ListEntriesParams{OrderBy: store.ListEntriesOrderByCrew, OrderByDirection: store.OrderDesc}},
47		{label: "raw text, ignored", parameters: store.ListEntriesParams{OrderBy: "boat; DROP TABLE entries", OrderByDirection: store.OrderAsc}},
46		{label: "raw text, ignored", parameters: store.ListEntriesParams{OrderBy: "boat; DROP TABLE entries", OrderByDirection: store.OrderAsc}},
48	}
47	}
49	for _, order := range orders {
48	for _, order := range orders {
50		listed, err := queries.ListEntries(ctx, order.parameters)
49		listed, err := queries.ListEntries(ctx, order.parameters)
51		if err != nil {
50		if err != nil {
52			return fmt.Errorf("listing entries %s: %w", order.label, err)
51			return fmt.Errorf("listing entries %s: %w", order.label, err)
53		}
52		}
54		fmt.Fprintf(output, "%s:\n", order.label)
53		fmt.Fprintf(output, "%s:\n", order.label)
55		for _, entry := range listed {
54		for _, entry := range listed {
56			finish := time.Duration(entry.FinishSeconds) * time.Second
55			finish := time.Duration(entry.FinishSeconds) * time.Second
57			fmt.Fprintf(output, "  %-10s crew %d  %s\n", entry.Boat, entry.Crew, finish)
56			fmt.Fprintf(output, "  %-10s crew %d  %s\n", entry.Boat, entry.Crew, finish)
58		}
57		}
59	}
58	}
60	return nil
59	return nil
61}
60}

Go type differences

The same SQL types map to different Go types, because each database reports them differently.

Query	Field	TimescaleDB	MariaDB
EnterBoat	parameter `crew`	`int64`	`int32`
EnterBoat	parameter `finish_seconds`	`int64`	`int32`
ListEntries	column `crew`	`int64`	`int32`
ListEntries	column `finish_seconds`	`int64`	`int32`