Skip to content

feat: Add support for scanning Postgres tuples #479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions typeid/typeid-go/sql.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ package typeid
import (
"database/sql/driver"
"fmt"
"strings"
)

const minTupleStringLength = 40 // (x,00000000-0000-0000-0000-000000000000)

// Scan implements the sql.Scanner interface so the TypeIDs can be read from
// databases transparently. Currently database types that map to string are
// supported.
Expand All @@ -17,10 +20,33 @@ func (tid *TypeID[P]) Scan(src any) error {
return nil
}
return tid.UnmarshalText([]byte(obj))
// TODO: add support for []byte
// we don't just want to store the full string as a byte array. Instead
// we should encode using the UUID bytes. We could add support for
// Binary Marshalling and Unmarshalling at the same time.
case []byte:
if len(obj) == 0 {
return nil
}

// typeid-sql can store TypeIDs as tuples of the form (prefix,uuid).
if len(obj) < minTupleStringLength || obj[0] != '(' || obj[len(obj)-1] != ')' {
// TODO: add support for []byte
// we don't just want to store the full string as a byte array. Instead
// we should encode using the UUID bytes. We could add support for
// Binary Marshalling and Unmarshalling at the same time.
return fmt.Errorf("unsupported format for scan type %T", obj)
}

obj = obj[1 : len(obj)-1]
parts := strings.Split(string(obj), ",")
if len(parts) != 2 {
return fmt.Errorf("invalid TypeID format: %s", obj)
}

parsedID, err := fromUUID[TypeID[P]](parts[0], parts[1])
if err != nil {
return fmt.Errorf("invalid UUID: %s: %w", parts[1], err)
}

*tid = parsedID
return nil
default:
return fmt.Errorf("unsupported scan type %T", obj)
}
Expand Down
12 changes: 9 additions & 3 deletions typeid/typeid-go/sql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,23 @@ import (
)

func TestScan(t *testing.T) {
t.Parallel()

testdata := []struct {
name string
input any
expected typeid.AnyID
}{
{"valid", "prefix_00041061050r3gg28a1c60t3gf", typeid.Must(typeid.FromString("prefix_00041061050r3gg28a1c60t3gf"))},
{"valid_text", "prefix_01jtvs4hppfp8azhhy9x703dc1", typeid.Must(typeid.FromString("prefix_01jtvs4hppfp8azhhy9x703dc1"))},
{"valid_tuple", []byte("(prefix,0196b792-46d6-7d90-afc6-3e4f4e01b581)"), typeid.Must(typeid.FromString("prefix_01jtvs4hppfp8azhhy9x703dc1"))},
{"nil", nil, typeid.AnyID{}},
{"empty string", "", typeid.AnyID{}},
}

for _, td := range testdata {
t.Run(td.name, func(t *testing.T) {
t.Parallel()

var scanned typeid.AnyID
err := scanned.Scan(td.input)
assert.NoError(t, err)
Expand All @@ -31,8 +36,9 @@ func TestScan(t *testing.T) {
}

func TestValuer(t *testing.T) {
expected := "prefix_00041061050r3gg28a1c60t3gf"
tid := typeid.Must(typeid.FromString("prefix_00041061050r3gg28a1c60t3gf"))
t.Parallel()
expected := "prefix_01jtvs4hppfp8azhhy9x703dc1"
tid := typeid.Must(typeid.FromString("prefix_01jtvs4hppfp8azhhy9x703dc1"))
actual, err := tid.Value()
assert.NoError(t, err)
assert.Equal(t, expected, actual)
Expand Down