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

Author: asmyasnikov

CHANGELOG.md

@@ -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

internal/bind/params.go

@@ -3,6 +3,7 @@ package bind
 import (
 	"database/sql"
 	"database/sql/driver"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"net/url"
@@ -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 (
@@ -164,10 +166,19 @@ 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))
 		}
 	}
 
+	if json, ok := v.(json.Marshaler); ok {
+		bytes, err := json.MarshalJSON()
+		if err != nil {
+			return nil, xerrors.WithStackTrace(fmt.Errorf("json.Marshaller error: %w", err))
+		}
+
+		return value.JSONValue(xstring.FromBytes(bytes)), err
+	}
+
 	if x, ok := asUUID(v); ok {
 		return x, nil
 	}
@@ -255,6 +266,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 {
@@ -301,6 +319,18 @@ func toValue(v any) (_ value.Value, err error) {
 		case reflect.Struct:
 			v := reflect.ValueOf(x)
 
+			if v.CanAddr() {
+				addr := v.Addr()
+				if x, has := addr.Interface().(json.Marshaler); has {
+					bytes, err := x.MarshalJSON()
+					if err != nil {
+						return nil, xerrors.WithStackTrace(err)
+					}
+
+					return value.JSONValue(xstring.FromBytes(bytes)), nil
+				}
+			}
+
 			fields := make([]value.StructValueField, v.NumField())
 
 			for i := range fields {

internal/bind/positional_args.go

@@ -57,6 +57,10 @@ func (m PositionalArgs) ToYdb(sql string, args ...any) (
 		}
 	}
 
+	if position == 0 {
+		return sql, args, nil
+	}
+
 	if len(args) != position {
 		return "", nil, xerrors.WithStackTrace(
 			fmt.Errorf("%w: (positional args %d, query args %d)", ErrInconsistentArgs, position, len(args)),

tests/integration/database_sql_json_test.go

@@ -0,0 +1,127 @@
+//go:build integration
+// +build integration
+
+package integration
+
+import (
+	"encoding/json"
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3"
+	"github.com/ydb-platform/ydb-go-sdk/v3/table"
+	"github.com/ydb-platform/ydb-go-sdk/v3/table/types"
+)
+
+var (
+	_ json.Marshaler = (*testJson)(nil)
+)
+
+type testJson struct {
+	a int64  `json:"a"`
+	b string `json:"b"`
+}
+
+func (t testJson) MarshalJSON() ([]byte, error) {
+	return []byte(fmt.Sprintf(`{"a":%d,"b":"%s"}`, t.a, t.b)), nil
+}
+
+func TestDatabaseSqlJson(t *testing.T) {
+	var (
+		scope = newScope(t)
+		db    = scope.SQLDriver(
+			ydb.WithQueryService(true),
+			ydb.WithPositionalArgs(),
+		)
+	)
+
+	t.Run("table/types", func(t *testing.T) {
+		t.Run("named param", func(t *testing.T) {
+			t.Run("check ydb type", func(t *testing.T) {
+				row := db.QueryRowContext(scope.Ctx, "SELECT FormatType(TypeOf($a))",
+					table.ValueParam("$a", types.JSONDocumentValue(`{"a":1,"b":"2"}`)),
+				)
+				var act string
+				require.NoError(t, row.Scan(&act))
+				require.NoError(t, row.Err())
+				require.Equal(t, `JsonDocument`, act)
+			})
+			t.Run("get json value", func(t *testing.T) {
+				row := db.QueryRowContext(scope.Ctx, "SELECT $a",
+					table.ValueParam("$a", types.JSONDocumentValue(`{"a":1,"b":"2"}`)),
+				)
+				var act string
+				require.NoError(t, row.Scan(&act))
+				require.NoError(t, row.Err())
+				require.Equal(t, `{"a":1,"b":"2"}`, act)
+			})
+		})
+		t.Run("unnamed param", func(t *testing.T) {
+			t.Run("check ydb type", func(t *testing.T) {
+				row := db.QueryRowContext(scope.Ctx, "SELECT FormatType(TypeOf(?))",
+					types.JSONDocumentValue(`{"a":1,"b":"2"}`),
+				)
+				var act string
+				require.NoError(t, row.Scan(&act))
+				require.NoError(t, row.Err())
+				require.Equal(t, `JsonDocument`, act)
+			})
+			t.Run("get json value", func(t *testing.T) {
+				row := db.QueryRowContext(scope.Ctx, "SELECT ?",
+					types.JSONDocumentValue(`{"a":1,"b":"2"}`),
+				)
+				var act string
+				require.NoError(t, row.Scan(&act))
+				require.NoError(t, row.Err())
+				require.Equal(t, `{"a":1,"b":"2"}`, act)
+			})
+		})
+	})
+
+	t.Run("ydb.ParamsBuilder()", func(t *testing.T) {
+		t.Run("check ydb type", func(t *testing.T) {
+			row := db.QueryRowContext(scope.Ctx, "SELECT FormatType(TypeOf($a))",
+				ydb.ParamsBuilder().Param("$a").JSON(`{"a":1,"b":"2"}`).Build(),
+			)
+			var act string
+			require.NoError(t, row.Scan(&act))
+			require.NoError(t, row.Err())
+			require.Equal(t, `Json`, act)
+		})
+		t.Run("get json value", func(t *testing.T) {
+			row := db.QueryRowContext(scope.Ctx, "SELECT $a",
+				ydb.ParamsBuilder().Param("$a").JSON(`{"a":1,"b":"2"}`).Build(),
+			)
+			var act string
+			require.NoError(t, row.Scan(&act))
+			require.NoError(t, row.Err())
+			require.Equal(t, `{"a":1,"b":"2"}`, act)
+		})
+	})
+
+	t.Run("json.Marshaler", func(t *testing.T) {
+		t.Run("check ydb type", func(t *testing.T) {
+			row := db.QueryRowContext(scope.Ctx, "SELECT FormatType(TypeOf(?))", testJson{a: 1, b: "2"})
+			var act string
+			require.NoError(t, row.Scan(&act))
+			require.NoError(t, row.Err())
+			require.Equal(t, `Json`, act)
+		})
+		t.Run("struct param", func(t *testing.T) {
+			row := db.QueryRowContext(scope.Ctx, "SELECT ?", testJson{a: 1, b: "2"})
+			var act string
+			require.NoError(t, row.Scan(&act))
+			require.NoError(t, row.Err())
+			require.Equal(t, `{"a":1,"b":"2"}`, act)
+		})
+		t.Run("pointer to struct param", func(t *testing.T) {
+			row := db.QueryRowContext(scope.Ctx, "SELECT ?", &testJson{a: 1, b: "2"})
+			var act string
+			require.NoError(t, row.Scan(&act))
+			require.NoError(t, row.Err())
+			require.Equal(t, `{"a":1,"b":"2"}`, act)
+		})
+	})
+}