Skip to content

* Supported json.Marshaller query parameter in database/sql driver #1740

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

Merged
merged 1 commit into from
May 4, 2025
Merged
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
* Supported `json.Marshaller` query parameter in `database/sql` driver

## v3.108.0
* Added `query.EmptyTxControl()` for empty transaction control (server-side defines transaction control by internal logic)
* Marked as deprecated `query.NoTx()` because this is wrong name for server-side transaction control inference
Expand Down
22 changes: 17 additions & 5 deletions internal/bind/bind.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
package bind

import (
"database/sql/driver"
"sort"

"github.com/ydb-platform/ydb-go-sdk/v3/internal/params"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/xslices"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
)

Expand All @@ -29,15 +31,25 @@ type Bind interface {
type Bindings []Bind

func (bindings Bindings) ToYdb(sql string, args ...any) (
yql string, params params.Params, err error,
yql string, pp params.Params, err error,
) {
if len(bindings) == 0 {
params, err = Params(args...)
pp, err = Params(args...)
if err != nil {
return "", nil, xerrors.WithStackTrace(err)
}

return sql, params, nil
return sql, pp, nil
}

if len(args) == 1 {
if nv, has := args[0].(driver.NamedValue); has {
if pp, has := nv.Value.(*params.Params); has {
args = xslices.Transform(*pp, func(v *params.Parameter) any {
return v
})
}
}
}

buffer := xstring.Buffer()
Expand All @@ -51,12 +63,12 @@ func (bindings Bindings) ToYdb(sql string, args ...any) (
}
}

params, err = Params(args...)
pp, err = Params(args...)
if err != nil {
return "", nil, xerrors.WithStackTrace(err)
}

return sql, params, nil
return sql, pp, nil
}

func Sort(bindings []Bind) []Bind {
Expand Down
28 changes: 19 additions & 9 deletions internal/bind/params.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package bind
import (
"database/sql"
"database/sql/driver"
"encoding/json"
"errors"
"fmt"
"net/url"
Expand All @@ -16,6 +17,7 @@ import (
"github.com/ydb-platform/ydb-go-sdk/v3/internal/types"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/value"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
)

var (
Expand Down Expand Up @@ -164,7 +166,7 @@ func toValue(v any) (_ value.Value, err error) {
if valuer, ok := v.(driver.Valuer); ok {
v, err = valuer.Value()
if err != nil {
return nil, fmt.Errorf("ydb: driver.Valuer error: %w", err)
return nil, xerrors.WithStackTrace(fmt.Errorf("driver.Valuer error: %w", err))
}
}

Expand Down Expand Up @@ -255,6 +257,13 @@ func toValue(v any) (_ value.Value, err error) {
return value.TimestampValueFromTime(x), nil
case time.Duration:
return value.IntervalValueFromDuration(x), nil
case json.Marshaler:
bytes, err := x.MarshalJSON()
if err != nil {
return nil, xerrors.WithStackTrace(err)
}

return value.JSONValue(xstring.FromBytes(bytes)), nil
default:
kind := reflect.TypeOf(x).Kind()
switch kind {
Expand All @@ -266,7 +275,7 @@ func toValue(v any) (_ value.Value, err error) {
list[i], err = toValue(v.Index(i).Interface())
if err != nil {
return nil, xerrors.WithStackTrace(
fmt.Errorf("cannot parse %d item of slice %T: %w",
fmt.Errorf("cannot parse item #%d of slice %T: %w",
i, x, err,
),
)
Expand Down Expand Up @@ -307,8 +316,8 @@ func toValue(v any) (_ value.Value, err error) {
kk, has := v.Type().Field(i).Tag.Lookup("sql")
if !has {
return nil, xerrors.WithStackTrace(
fmt.Errorf("cannot parse %q as key field of struct: %w",
v.Type().Field(i).Name, errUnsupportedType,
fmt.Errorf("cannot parse %q as key field of struct %T: %w",
v.Type().Field(i).Name, x, errUnsupportedType,
),
)
}
Expand Down Expand Up @@ -348,15 +357,16 @@ func supportNewTypeLink(x any) string {
}

func toYdbParam(name string, value any) (*params.Parameter, error) {
switch tv := value.(type) {
case driver.NamedValue:
n, v := tv.Name, tv.Value
if nv, has := value.(driver.NamedValue); has {
n, v := nv.Name, nv.Value
if n != "" {
name = n
}
value = v
case *params.Parameter:
return tv, nil
}

if nv, ok := value.(params.NamedValue); ok {
return params.Named(nv.Name(), nv.Value()), nil
}

v, err := toValue(value)
Expand Down
Loading
Loading