Compare · 006

JSON columns: CockroachDB and ClickHouse

Every file of the CockroachDB and ClickHouse versions side by side, with the lines that differ marked. 8 parameter or column types differ in Go.

Compare CockroachDB withSQLitePostgreSQLTimescaleDBMySQLMariaDBDuckDBClickHouse

Configuration

sgl.yamldiffers
CockroachDB
ClickHouse
1version: 1
1version: 1
2
2
3databases:
3databases:
4 - name: orders
4 - name: orders
5 dialect: postgres
5 dialect: clickhouse
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
12 json_tags:
13 case: camel
14 omitempty: true
15 struct_tags:
16 db: "{name}"
17 empty_slices: true

Migrations

db/migrations/0001_orders.up.sqldiffers
CockroachDB
ClickHouse
1CREATE TABLE orders (
1CREATE TABLE orders (
2 id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
2 id UInt64,
3 customer TEXT NOT NULL,
3 customer String,
4 basket JSONB NOT NULL,
4 basket String,
5 delivery JSONB
5 delivery Nullable(String)
6);
6) ENGINE = MergeTree() ORDER BY id;
db/migrations/0001_orders.down.sqlidentical
CockroachDB
ClickHouse
1DROP TABLE orders;
1DROP TABLE orders;

Queries

PlaceOrderdiffers
CockroachDB · db/queries/orders.sql
ClickHouse · db/queries/orders.sql
1-- sgl.query(PlaceOrder, exec)
1-- sgl.query(PlaceOrder, exec)
2INSERT INTO orders (customer, basket, delivery) VALUES ($1, $2, $3);
2INSERT INTO orders (id, customer, basket, delivery)
3VALUES ({id:UInt64}, {customer:String}, {basket:String}, {delivery:Nullable(String)});
GetOrderdiffers
CockroachDB · db/queries/orders.sql
ClickHouse · db/queries/orders.sql
1-- sgl.query(GetOrder, one)
1-- sgl.query(GetOrder, one)
2SELECT id, customer, basket, delivery FROM orders WHERE id = $1;
2SELECT id, customer, basket, delivery FROM orders WHERE id = {id:UInt64};
OrdersWithFishdiffers
CockroachDB · db/queries/orders.sql
ClickHouse · db/queries/orders.sql
1-- sgl.query(OrdersWithFish, many)
1-- sgl.query(OrdersWithFish, many)
2-- $1 as sgl.param(fish, type: text)
3SELECT
2SELECT
4 id,
3 id,
5 customer,
4 customer,
6 basket -> 'extras' AS extras,
5 JSONExtractRaw(basket, 'extras') AS extras,
7 delivery ->> 'address' AS delivery_address
6 JSONExtractString(delivery, 'address') AS address
8FROM orders
7FROM orders
9WHERE basket ->> 'fish' = $1
8WHERE JSONExtractString(basket, 'fish') = {fish:String}
10ORDER BY id;
9ORDER BY id;
OrdersContainingonly CockroachDB
CockroachDB · db/queries/orders.sql
ClickHouse · not in this version
1-- sgl.query(OrdersContaining, many)
2-- $1 as sgl.param(subset)
3SELECT id, customer
4FROM orders
5WHERE basket @> $1::jsonb
6ORDER BY id;

What sgl generates

PlaceOrderdiffers
CockroachDB
ClickHouse
1func (queries *Queries) PlaceOrder(ctx context.Context, params PlaceOrderParams) error
1func (queries *Queries) PlaceOrder(ctx context.Context, params PlaceOrderParams) error
2
2
3type PlaceOrderParams struct {
3type PlaceOrderParams struct {
4 ID uint64
4 Customer string
5 Customer string
5 Basket JSON
6 Basket string
6 Delivery JSON
7 Delivery *string
7}
8}
8
9type JSON []byte
GetOrderdiffers
CockroachDB
ClickHouse
1func (queries *Queries) GetOrder(ctx context.Context, id int64) (GetOrderRow, error)
1func (queries *Queries) GetOrder(ctx context.Context, id uint64) (GetOrderRow, error)
2
2
3type GetOrderRow struct {
3type GetOrderRow struct {
4 ID int64 `json:"id,omitempty" db:"id"`
4 ID uint64 `json:"id"`
5 Customer string `json:"customer,omitempty" db:"customer"`
5 Customer string `json:"customer"`
6 Basket JSON `json:"basket,omitempty" db:"basket"`
6 Basket string `json:"basket"`
7 Delivery JSON `json:"delivery,omitempty" db:"delivery"`
7 Delivery *string `json:"delivery"`
8}
8}
9
10type JSON []byte
OrdersWithFishdiffers
CockroachDB
ClickHouse
1func (queries *Queries) OrdersWithFish(ctx context.Context, fish string) ([]OrdersWithFishRow, error)
1func (queries *Queries) OrdersWithFish(ctx context.Context, fish string) ([]OrdersWithFishRow, error)
2
2
3type OrdersWithFishRow struct {
3type OrdersWithFishRow struct {
4 ID int64 `json:"id,omitempty" db:"id"`
4 ID uint64 `json:"id"`
5 Customer string `json:"customer,omitempty" db:"customer"`
5 Customer string `json:"customer"`
6 Extras JSON `json:"extras,omitempty" db:"extras"`
6 Extras string `json:"extras"`
7 DeliveryAddress *string `json:"deliveryAddress,omitempty" db:"delivery_address"`
7 Address *string `json:"address"`
8}
8}
9
10type JSON []byte
OrdersContainingonly CockroachDB
CockroachDB
ClickHouse · not in this version
1func (queries *Queries) OrdersContaining(ctx context.Context, subset JSON) ([]OrdersContainingRow, error)
2
3type JSON []byte
4
5type OrdersContainingRow struct {
6 ID int64 `json:"id,omitempty" db:"id"`
7 Customer string `json:"customer,omitempty" db:"customer"`
8}

The program

example.godiffers
CockroachDB
ClickHouse
1package main
1package main
2
2
3import (
3import (
4 "context"
4 "context"
5 "database/sql"
5 "database/sql"
6 "encoding/json"
6 "encoding/json"
7 "fmt"
7 "fmt"
8 "io"
8 "io"
9 "reflect"
10 "strings"
11
9
12 "seagull.sh/seagull/examples/postgres/006_json/internal/store"
10 "seagull.sh/seagull/examples/clickhouse/006_json/internal/store"
13)
11)
14
12
15// basket is the document an order's basket column holds.
13// basket is the document an order's basket column holds.
16type basket struct {
14type basket struct {
17 // Fish is the fish the order is for.
15 // Fish is the fish the order is for.
18 Fish string `json:"fish"`
16 Fish string `json:"fish"`
19
17
20 // Portions is how many portions of fish and chips.
18 // Portions is how many portions of fish and chips.
21 Portions int `json:"portions"`
19 Portions int `json:"portions"`
22
20
23 // Extras lists the sides.
21 // Extras lists the sides.
24 Extras []string `json:"extras"`
22 Extras []string `json:"extras"`
25}
23}
26
24
27// delivery is the document an order's delivery column holds, when the order is delivered.
25// delivery is the document an order's delivery column holds, when the order is delivered.
28type delivery struct {
26type delivery struct {
29 // Address is where the order goes.
27 // Address is where the order goes.
30 Address string `json:"address"`
28 Address string `json:"address"`
31}
29}
32
30
33// run places three chip shop orders and reads them back. A JSONB column becomes the
31// run places three chip shop orders and reads them back. The documents live in String
34// generated store.JSON type, which holds the raw document as bytes: encode a value into
32// columns, the usual home for JSON text in ClickHouse, so Basket is a string and
35// it with json.Marshal and decode it with json.Unmarshal. A nil store.JSON is SQL NULL.
33// Delivery, a Nullable(String), is *string: encode a value into it with json.Marshal and
36//
34// decode it with json.Unmarshal. A nil Delivery is SQL NULL.
37// JSONB stores a parsed document, not the text it was sent, and writes it back in its own
38// form: a space after each comma and colon, keys reordered and duplicate keys dropped, so
39// compare documents by decoding them, not by their bytes.
40//
41// OrdersWithFish filters with ->>, which extracts a value as text, and selects with ->,
42// which extracts a JSONB fragment, so Extras is store.JSON again. DeliveryAddress is
43// *string because ->> gives NULL when the delivery column or its address is missing. The
44// ->> comparison's parameter is pinned with sgl.param(fish, type: text), as inference
45// leaves it as any. OrdersContaining uses @>, which matches a document containing the one
46// bound to $1::jsonb.
47//
35//
48// The rows go straight out as JSON, as an HTTP handler would send them, so sgl.yaml
36// OrdersWithFish reads inside the documents with ClickHouse's JSON functions instead of
49// shapes the generated structs for that: go.json_tags writes each field's json tag in
37// operators: JSONExtractString(basket, 'fish') extracts a value as text, and
50// camel case with omitempty, so delivery_address is "deliveryAddress" and a nil one is
38// JSONExtractRaw(basket, 'extras') extracts the fragment's JSON text. Both return a
51// left out; go.struct_tags adds a db tag holding the column's name, {name}, for libraries
39// String, which is empty for a missing key rather than NULL, so Extras is a string.
52// that map columns by tag; and go.empty_slices makes a many method return an empty slice
40// Address is *string because the delivery column is Nullable(String), and a JSON function
53// when no row matches, which encodes as [] rather than null.
41// given NULL returns NULL.
54//
42//
55// Takes database (*sql.DB) which is a migrated database.
43// Takes database (*sql.DB) which is a migrated database.
56// Takes output (io.Writer) which receives the decoded orders and the searches.
44// Takes output (io.Writer) which receives the decoded orders and the search.
57//
45//
58// Returns error when a query fails or a document does not encode or decode.
46// Returns error when a query fails or a document does not encode or decode.
59func run(ctx context.Context, database *sql.DB, output io.Writer) error {
47func run(ctx context.Context, database *sql.DB, output io.Writer) error {
60 queries := store.New(database)
48 queries := store.New(database)
61
49
62 orders := []struct {
50 orders := []struct {
63 customer string
51 customer string
64 basket basket
52 basket basket
65 delivery *delivery
53 delivery *delivery
66 }{
54 }{
67 {customer: "Steven", basket: basket{Fish: "cod", Portions: 2, Extras: []string{"mushy peas", "curry sauce"}}},
55 {customer: "Steven", basket: basket{Fish: "cod", Portions: 2, Extras: []string{"mushy peas", "curry sauce"}}},
68 {customer: "Gwen", basket: basket{Fish: "haddock", Portions: 1, Extras: []string{}}},
56 {customer: "Gwen", basket: basket{Fish: "haddock", Portions: 1, Extras: []string{}}},
69 {customer: "Morwenna", basket: basket{Fish: "cod", Portions: 1, Extras: []string{"pickled egg"}}, delivery: &delivery{Address: "4 Harbour Row"}},
57 {customer: "Morwenna", basket: basket{Fish: "cod", Portions: 1, Extras: []string{"pickled egg"}}, delivery: &delivery{Address: "4 Harbour Row"}},
70 }
58 }
71 for _, order := range orders {
59 for index, order := range orders {
72 encodedBasket, err := json.Marshal(order.basket)
60 encodedBasket, err := json.Marshal(order.basket)
73 if err != nil {
61 if err != nil {
74 return fmt.Errorf("encoding %s's basket: %w", order.customer, err)
62 return fmt.Errorf("encoding %s's basket: %w", order.customer, err)
75 }
63 }
76 parameters := store.PlaceOrderParams{Customer: order.customer, Basket: encodedBasket, Delivery: nil}
64 parameters := store.PlaceOrderParams{ID: uint64(index + 1), Customer: order.customer, Basket: string(encodedBasket), Delivery: nil}
77 if order.delivery != nil {
65 if order.delivery != nil {
78 encodedDelivery, err := json.Marshal(order.delivery)
66 encodedDelivery, err := json.Marshal(order.delivery)
79 if err != nil {
67 if err != nil {
80 return fmt.Errorf("encoding %s's delivery: %w", order.customer, err)
68 return fmt.Errorf("encoding %s's delivery: %w", order.customer, err)
81 }
69 }
82 parameters.Delivery = encodedDelivery
70 parameters.Delivery = new(string(encodedDelivery))
83 }
71 }
84 if err := queries.PlaceOrder(ctx, parameters); err != nil {
72 if err := queries.PlaceOrder(ctx, parameters); err != nil {
85 return fmt.Errorf("placing %s's order: %w", order.customer, err)
73 return fmt.Errorf("placing %s's order: %w", order.customer, err)
86 }
74 }
87 }
75 }
88
76
89 first, err := queries.GetOrder(ctx, 1)
77 first, err := queries.GetOrder(ctx, 1)
90 if err != nil {
78 if err != nil {
91 return fmt.Errorf("getting order 1: %w", err)
79 return fmt.Errorf("getting order 1: %w", err)
92 }
80 }
93 var decoded basket
81 var decoded basket
94 if err := json.Unmarshal(first.Basket, &decoded); err != nil {
82 if err := json.Unmarshal([]byte(first.Basket), &decoded); err != nil {
95 return fmt.Errorf("decoding order 1's basket: %w", err)
83 return fmt.Errorf("decoding order 1's basket: %w", err)
96 }
84 }
97 fmt.Fprintf(output, "order 1 decoded: %d x %s with %v, delivery is NULL: %t\n", decoded.Portions, decoded.Fish, decoded.Extras, first.Delivery == nil)
85 fmt.Fprintf(output, "order 1 stored %s\n", first.Basket)
86 fmt.Fprintf(output, "decoded: %d x %s with %v, delivery is NULL: %t\n", decoded.Portions, decoded.Fish, decoded.Extras, first.Delivery == nil)
98
87
99 cod, err := queries.OrdersWithFish(ctx, "cod")
88 cod, err := queries.OrdersWithFish(ctx, "cod")
100 if err != nil {
89 if err != nil {
101 return fmt.Errorf("finding cod orders: %w", err)
90 return fmt.Errorf("finding cod orders: %w", err)
102 }
91 }
103 fmt.Fprintln(output, "\ncod orders:")
92 fmt.Fprintln(output, "\ncod orders:")
104 for _, order := range cod {
93 for _, order := range cod {
105 address := "collecting"
94 address := "collecting"
106 if order.DeliveryAddress != nil {
95 if order.Address != nil {
107 address = "to " + *order.DeliveryAddress
96 address = "to " + *order.Address
108 }
97 }
109 fmt.Fprintf(output, " order %d %-9s extras %-30s %s\n", order.ID, order.Customer, order.Extras, address)
98 fmt.Fprintf(output, " order %d %-9s extras %-30s %s\n", order.ID, order.Customer, order.Extras, address)
110 }
99 }
111 if err := writeJSON(output, "cod orders as JSON", cod); err != nil {
112 return err
113 }
114
115 plaice, err := queries.OrdersWithFish(ctx, "plaice")
116 if err != nil {
117 return fmt.Errorf("finding plaice orders: %w", err)
118 }
119 if err := writeJSON(output, "plaice orders as JSON", plaice); err != nil {
120 return err
121 }
122 field, _ := reflect.TypeFor[store.OrdersWithFishRow]().FieldByName("DeliveryAddress")
123 fmt.Fprintf(output, "DeliveryAddress is tagged %s\n", field.Tag)
124
125 subset := store.JSON(`{"extras": ["pickled egg"]}`)
126 containing, err := queries.OrdersContaining(ctx, subset)
127 if err != nil {
128 return fmt.Errorf("finding orders containing %s: %w", subset, err)
129 }
130 customers := make([]string, 0, len(containing))
131 for _, order := range containing {
132 customers = append(customers, order.Customer)
133 }
134 fmt.Fprintf(output, "\norders containing %s: %s\n", subset, strings.Join(customers, ", "))
135 return nil
100 return nil
136}
101}
137
138// writeJSON writes rows encoded as JSON, as an HTTP handler would send them, after a
139// label.
140//
141// Takes output (io.Writer) which receives the label and the document.
142// Takes label (string) which says what the rows are.
143// Takes rows (any) which are the rows to encode.
144//
145// Returns error when the rows do not encode.
146func writeJSON(output io.Writer, label string, rows any) error {
147 encoded, err := json.Marshal(rows)
148 if err != nil {
149 return fmt.Errorf("encoding %s: %w", label, err)
150 }
151 fmt.Fprintf(output, "%s: %s\n", label, encoded)
152 return nil
153}

Go type differences

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

QueryFieldCockroachDBClickHouse
PlaceOrderparameter basketJSONstring
PlaceOrderparameter deliveryJSON*string
GetOrderparameter idint64uint64
GetOrdercolumn idint64uint64
GetOrdercolumn basketJSONstring
GetOrdercolumn deliveryJSON*string
OrdersWithFishcolumn idint64uint64
OrdersWithFishcolumn extrasJSONstring