refactor(ksuid): replace BinExpr with top-level expr helpers

Adds StringKSUIDExpr and BinaryKSUIDExpr for use with ExprValues, plus
Expr() methods on both types. Removes ExprStringKSUIDs and BinExpr.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
2026-06-29 18:47:18 -07:00
parent eafe84ef31
commit a712ccc38f
8 changed files with 75 additions and 35 deletions
+1 -1
View File
@@ -16,7 +16,7 @@
- `Query`, `MustQuery`, and `UpdateOne` helpers (+ Context variants).
- `WithTxValue` for transactional functions that return a value.
- `QueryCount`, `BuildQueryCountFn`, and `CountResult` for pagination counts.
- `BinaryKSUID.BinExpr`, `ExprStringKSUIDs`, and flexible `Parse*Any` KSUID parsers.
- `StringKSUIDExpr`, `BinaryKSUIDExpr`, and flexible `Parse*Any` KSUID parsers.
- `MarshalUint64` and `UnmarshalUint64` for JS-safe GraphQL uint64 scalars.
- Context-aware variants for all query and mutation helpers.
- `Delete`, `DeleteAffected`, `WithTx`, `ContainsCol`, and `CurrentDialect()`.
+1 -1
View File
@@ -45,7 +45,7 @@ For Postgres, use `dbx.DialectPostgres` and blank-import `dbxp` instead of `dbxm
| Query | `Fetch`, `MustFetch`, `FetchOne`, `MustFetchOne`, `Query`, `MustQuery` (+ `*Context` variants) |
| Mutations | `Insert`, `InsertReturning`, `Update`, `UpdateAffected`, `UpdateOne`, `UpdateReturning`, `Delete`, `DeleteAffected` (+ `*Context` variants) |
| Transactions | `WithTx`, `WithTxValue` |
| Columns | `NormalCols`, `ContainsCol`, `ExprValues`, `ExprStringers`, `ExprStringKSUIDs`, `QueryCount`, `BuildQueryCountFn` |
| Columns | `NormalCols`, `ContainsCol`, `ExprValues`, `ExprStringers`, `StringKSUIDExpr`, `BinaryKSUIDExpr`, `QueryCount`, `BuildQueryCountFn` |
| Partial update | `ApplyPtr`, `ApplyComplexPtr`, `ApplyInterfacePtr`, `ApplyVal` |
| Pointers | `Ptr`, `Val`, `NowPtr`, `TrimPtr`, `TrimPtrToNil`, `IsZero` |
| Types | `StringKSUID`, `BinaryKSUID`, `JSONB` |
+4 -2
View File
@@ -16,7 +16,8 @@
// # Jet column utilities
//
// Dialect-neutral type aliases ([Column], [ColumnList]) and helpers for column
// lists ([NormalCols], [ContainsCol]) and expression building ([ExprValues]).
// lists ([NormalCols], [ContainsCol]) and expression building ([ExprValues],
// [StringKSUIDExpr], [BinaryKSUIDExpr]).
// [QueryCount] and [BuildQueryCountFn] support pagination total counts.
//
// Partial-update helpers ([ApplyPtr], [ApplyVal]) track changed fields for
@@ -26,7 +27,8 @@
//
// [StringKSUID] and [BinaryKSUID] wrap segmentio/ksuid with storage-specific
// SQL encoding. Both implement [ApplyInterface] via Equal and IsZero for use
// with [ApplyInterfacePtr]. Both share identical GraphQL string scalar transit.
// with [ApplyInterfacePtr]. Expr returns a Jet expression via [StringKSUIDExpr]
// or [BinaryKSUIDExpr]. Both share identical GraphQL string scalar transit.
// Choose StringKSUID for text columns (VARCHAR, TEXT); choose BinaryKSUID for
// binary columns (BINARY(20), BYTEA). [ParseStringKSUIDAny] and
// [ParseBinaryKSUIDAny] accept flexible input for API boundaries.
+13 -6
View File
@@ -25,11 +25,18 @@ func ExprStringers(values []fmt.Stringer) []Expression {
return expressions
}
// ExprStringKSUIDs converts StringKSUID pointers to Jet string expressions.
func ExprStringKSUIDs(ids []*StringKSUID) []Expression {
expressions := make([]Expression, len(ids))
for i, id := range ids {
expressions[i] = mysql.String(id.String())
// StringKSUIDExpr returns a Jet expression for a string-encoded KSUID column.
func StringKSUIDExpr(id StringKSUID) Expression {
if id.IsNil() {
return mysql.StringExp(mysql.NULL)
}
return expressions
return mysql.String(id.String())
}
// BinaryKSUIDExpr returns a Jet expression for a binary-encoded KSUID column.
func BinaryKSUIDExpr(id BinaryKSUID) Expression {
if id.IsNil() {
return mysql.StringExp(mysql.NULL)
}
return mysql.String(string(id.Bytes()))
}
+46
View File
@@ -0,0 +1,46 @@
package dbx
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestStringKSUIDExpr(t *testing.T) {
id := NewStringKSUID()
expr := StringKSUIDExpr(id)
require.NotNil(t, expr)
assert.Equal(t, expr, id.Expr())
nilExpr := StringKSUIDExpr(NilStringKSUID)
require.NotNil(t, nilExpr)
assert.Equal(t, nilExpr, NilStringKSUID.Expr())
}
func TestBinaryKSUIDExpr(t *testing.T) {
id := NewBinaryKSUID()
expr := BinaryKSUIDExpr(id)
require.NotNil(t, expr)
assert.Equal(t, expr, id.Expr())
nilExpr := BinaryKSUIDExpr(NilBinaryKSUID)
require.NotNil(t, nilExpr)
assert.Equal(t, nilExpr, NilBinaryKSUID.Expr())
}
func TestExprValues_StringKSUID(t *testing.T) {
a := NewStringKSUID()
b := NewStringKSUID()
exprs := ExprValues([]*StringKSUID{&a, &b}, func(id *StringKSUID) Expression {
return id.Expr()
})
require.Len(t, exprs, 2)
}
func TestExprValues_BinaryKSUID(t *testing.T) {
a := NewBinaryKSUID()
exprs := ExprValues([]BinaryKSUID{a}, BinaryKSUIDExpr)
require.Len(t, exprs, 1)
assert.NotNil(t, exprs[0])
}
+5 -9
View File
@@ -5,7 +5,6 @@ import (
"fmt"
"io"
"github.com/go-jet/jet/v2/mysql"
"github.com/segmentio/ksuid"
)
@@ -44,19 +43,16 @@ func ParseBinaryKSUID(b []byte) (BinaryKSUID, error) {
return BinaryKSUID{KSUID: id}, nil
}
// BinExpr returns a Jet string expression for binary-encoded IN clauses.
func (b BinaryKSUID) BinExpr() mysql.StringExpression {
if b.IsNil() {
return mysql.StringExp(mysql.NULL)
}
return mysql.String(string(b.Bytes()))
}
// AsStringKSUID returns a StringKSUID view of the same identifier.
func (b BinaryKSUID) AsStringKSUID() StringKSUID {
return StringKSUID{KSUID: b.KSUID}
}
// Expr returns a Jet expression for this BinaryKSUID. See [BinaryKSUIDExpr].
func (b BinaryKSUID) Expr() Expression {
return BinaryKSUIDExpr(b)
}
// Scan implements sql.Scanner for binary-backed KSUID columns.
func (b *BinaryKSUID) Scan(src any) error {
switch v := src.(type) {
-16
View File
@@ -52,19 +52,3 @@ func TestParseStringKSUIDAny_InvalidType(t *testing.T) {
_, err := ParseStringKSUIDAny(123)
assert.Error(t, err)
}
func TestBinaryKSUID_BinExpr(t *testing.T) {
id := NewBinaryKSUID()
expr := id.BinExpr()
require.NotNil(t, expr)
nilExpr := NilBinaryKSUID.BinExpr()
require.NotNil(t, nilExpr)
}
func TestExprStringKSUIDs(t *testing.T) {
a := NewStringKSUID()
b := NewStringKSUID()
exprs := ExprStringKSUIDs([]*StringKSUID{&a, &b})
require.Len(t, exprs, 2)
}
+5
View File
@@ -48,6 +48,11 @@ func (s StringKSUID) AsBinaryKSUID() BinaryKSUID {
return BinaryKSUID{KSUID: s.KSUID}
}
// Expr returns a Jet expression for this StringKSUID. See [StringKSUIDExpr].
func (s StringKSUID) Expr() Expression {
return StringKSUIDExpr(s)
}
// Scan implements sql.Scanner for string-backed KSUID columns.
func (s *StringKSUID) Scan(src any) error {
switch v := src.(type) {