Merge pull request #1575 from ydb-platform/params-from-map

Marked as deprecated `ydb.MustParamsFromMap` + Changed result `ydb.ParamsFromMap` result from tuple <`params.Parameters`, `error`> to `params.Parameters` only

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,6 @@
+* Removed experimental helper `ydb.MustParamsFromMap`
+* Changed result of experimental helper `ydb.ParamsFromMap` from tuple <`params.Parameters`, `error`> to `params.Parameters` only 
+
 ## v3.93.1
 * Published `query.ExecuteOption` as alias to `internal/query/options.Execute`
 

example_test.go

@@ -511,8 +511,7 @@ func ExampleOpen_advanced() {
 	fmt.Printf("connected to %s, database '%s'", db.Endpoint(), db.Name())
 }
 
-// func ExampleParamsMap
-func ExampleMustParamsFromMap() {
+func ExampleParamsFromMap() {
 	ctx := context.TODO()
 	db, err := ydb.Open(
 		ctx,
@@ -532,14 +531,16 @@ func ExampleMustParamsFromMap() {
 	fmt.Printf("connected to %s, database '%s'", db.Endpoint(), db.Name())
 
 	res, err := db.Query().QueryRow(ctx, `
-DECLARE $textArg AS Text;
-DECLARE $intArg AS Int64;
-
-SELECT $textArg AS TextField, $intArg AS IntField
-`, query.WithParameters(ydb.MustParamsFromMap(map[string]any{
-		"$textArg": "asd",
-		"$intArg":  int64(123),
-	})))
+		DECLARE $textArg AS Text;
+		DECLARE $intArg AS Int64;
+		
+		SELECT $textArg AS TextField, $intArg AS IntField
+		`,
+		query.WithParameters(ydb.ParamsFromMap(map[string]any{
+			"$textArg": "asd",
+			"$intArg":  int64(123),
+		})),
+	)
 	if err != nil {
 		fmt.Printf("query failed")
 	}

internal/bind/params.go

@@ -204,7 +204,7 @@ func Params(args ...interface{}) ([]*params.Parameter, error) {
 			}
 			newParam, err = toYdbParam(x.Name, x.Value)
 			newParams = append(newParams, newParam)
-		case *params.Parameters:
+		case *params.Params:
 			if len(args) > 1 {
 				return nil, xerrors.WithStackTrace(errMultipleQueryParameters)
 			}
@@ -230,7 +230,7 @@ func Params(args ...interface{}) ([]*params.Parameter, error) {
 func paramHandleNamedValue(arg driver.NamedValue, paramNumber, argsLen int) ([]*params.Parameter, error) {
 	if arg.Name == "" {
 		switch x := arg.Value.(type) {
-		case *params.Parameters:
+		case *params.Params:
 			if argsLen > 1 {
 				return nil, xerrors.WithStackTrace(errMultipleQueryParameters)
 			}

internal/params/builder.go

@@ -2,11 +2,11 @@ package params
 
 type (
 	Builder struct {
-		params Parameters
+		params Params
 	}
 )
 
-func (b Builder) Build() *Parameters {
+func (b Builder) Build() *Params {
 	return &b.params
 }
 

internal/params/builder_test.go

@@ -417,7 +417,7 @@ func TestBuilder(t *testing.T) {
 			result, ok := xtest.CallMethod(item, tc.method, tc.args...)[0].(Builder)
 			require.True(t, ok)
 
-			params := result.Build().ToYDB(a)
+			params := result.Build().toYDB(a)
 
 			require.Equal(t,
 				xtest.ToJSON(

internal/params/dict_test.go

@@ -440,7 +440,7 @@ func TestDict(t *testing.T) {
 				d, ok := xtest.CallMethod(addedKey, val.method, val.args...)[0].(*dict)
 				require.True(t, ok)
 
-				params := d.EndDict().Build().ToYDB(a)
+				params := d.EndDict().Build().toYDB(a)
 				require.Equal(t, xtest.ToJSON(
 					map[string]*Ydb.TypedValue{
 						"$x": {
@@ -482,7 +482,7 @@ func TestDict_AddPairs(t *testing.T) {
 		},
 	}
 
-	params := Builder{}.Param("$x").BeginDict().AddPairs(pairs...).EndDict().Build().ToYDB(a)
+	params := Builder{}.Param("$x").BeginDict().AddPairs(pairs...).EndDict().Build().toYDB(a)
 
 	require.Equal(t, xtest.ToJSON(
 		map[string]*Ydb.TypedValue{

internal/params/list_test.go

@@ -435,7 +435,7 @@ func TestList(t *testing.T) {
 			result, ok := xtest.CallMethod(item, tc.method, tc.args...)[0].(*list)
 			require.True(t, ok)
 
-			params := result.EndList().Build().ToYDB(a)
+			params := result.EndList().Build().toYDB(a)
 			require.Equal(t, xtest.ToJSON(
 				map[string]*Ydb.TypedValue{
 					"$x": {
@@ -462,7 +462,7 @@ func TestList_AddItems(t *testing.T) {
 	defer a.Free()
 	params := Builder{}.Param("$x").BeginList().
 		AddItems(value.Uint64Value(123), value.Uint64Value(321)).
-		EndList().Build().ToYDB(a)
+		EndList().Build().toYDB(a)
 	require.Equal(t, xtest.ToJSON(
 		map[string]*Ydb.TypedValue{
 			"$x": {

internal/params/optional_test.go

@@ -435,7 +435,7 @@ func TestOptional(t *testing.T) {
 			result, ok := xtest.CallMethod(item, tc.method, tc.args...)[0].(*optionalBuilder)
 			require.True(t, ok)
 
-			params := result.EndOptional().Build().ToYDB(a)
+			params := result.EndOptional().Build().toYDB(a)
 			require.Equal(t, xtest.ToJSON(
 				map[string]*Ydb.TypedValue{
 					"$x": {

internal/params/parameters.go

@@ -23,9 +23,14 @@ type (
 		name   string
 		value  value.Value
 	}
-	Parameters []*Parameter
+	Parameters interface {
+		ToYDB(a *allocator.Allocator) (map[string]*Ydb.TypedValue, error)
+	}
+	Params []*Parameter
 )
 
+var _ Parameters = (*Params)(nil)
+
 func Named(name string, value value.Value) *Parameter {
 	return &Parameter{
 		name:  name,
@@ -41,7 +46,7 @@ func (p *Parameter) Value() value.Value {
 	return p.value
 }
 
-func (p *Parameters) String() string {
+func (p *Params) String() string {
 	buffer := xstring.Buffer()
 	defer buffer.Free()
 
@@ -62,7 +67,20 @@ func (p *Parameters) String() string {
 	return buffer.String()
 }
 
-func (p *Parameters) ToYDB(a *allocator.Allocator) map[string]*Ydb.TypedValue {
+func (p *Params) ToYDB(a *allocator.Allocator) (map[string]*Ydb.TypedValue, error) {
+	if p == nil {
+		return nil, nil //nolint:nilnil
+	}
+
+	parameters := make(map[string]*Ydb.TypedValue, len(*p))
+	for _, param := range *p {
+		parameters[param.name] = value.ToYDB(param.value, a)
+	}
+
+	return parameters, nil
+}
+
+func (p *Params) toYDB(a *allocator.Allocator) map[string]*Ydb.TypedValue {
 	if p == nil {
 		return nil
 	}
@@ -74,7 +92,7 @@ func (p *Parameters) ToYDB(a *allocator.Allocator) map[string]*Ydb.TypedValue {
 	return parameters
 }
 
-func (p *Parameters) Each(it func(name string, v value.Value)) {
+func (p *Params) Each(it func(name string, v value.Value)) {
 	if p == nil {
 		return
 	}
@@ -83,15 +101,15 @@ func (p *Parameters) Each(it func(name string, v value.Value)) {
 	}
 }
 
-func (p *Parameters) Count() int {
+func (p *Params) Count() int {
 	if p == nil {
 		return 0
 	}
 
 	return len(*p)
 }
 
-func (p *Parameters) Add(params ...NamedValue) {
+func (p *Params) Add(params ...NamedValue) {
 	for _, param := range params {
 		*p = append(*p, Named(param.Name(), param.Value()))
 	}

internal/params/parameters_test.go

@@ -18,7 +18,7 @@ func TestParameter(t *testing.T) {
 }
 
 func TestParameters(t *testing.T) {
-	p := &Parameters{}
+	p := &Params{}
 	p.Add(
 		Named("x", value.TextValue("X")),
 		Named("y", value.TextValue("Y")),
@@ -39,15 +39,15 @@ func TestParameters(t *testing.T) {
 func TestNil(t *testing.T) {
 	for _, tt := range []struct {
 		name string
-		p    *Parameters
+		p    *Params
 	}{
 		{
 			name: xtest.CurrentFileLine(),
 			p:    nil,
 		},
 		{
 			name: xtest.CurrentFileLine(),
-			p:    &Parameters{},
+			p:    &Params{},
 		},
 		{
 			name: xtest.CurrentFileLine(),
@@ -64,7 +64,7 @@ func TestNil(t *testing.T) {
 			require.Empty(t, visited)
 			a := allocator.New()
 			defer a.Free()
-			require.Empty(t, tt.p.ToYDB(a))
+			require.Empty(t, tt.p.toYDB(a))
 		})
 	}
 }