Merge pull request #1643 from ydb-platform/driver-value

Fixed compatibility of propose database/sql driver after drop-in replacement from legacy database/sql driver

Author: asmyasnikov

.github/workflows/slo.yml

@@ -32,42 +32,42 @@ jobs:
     strategy:
       matrix:
         sdk:
-          - id: database_sql_legacy
-            name: database-sql-legacy
-            path: ./database/sql/legacy
-            label: database/sql/legacy
-          - id: database_sql_propose
-            name: database-sql-propose
-            path: ./database/sql/propose
-            label: database/sql/propose
+          - id: database_sql_table
+            name: database-sql-table
+            path: ./database/sql/table
+            label: database/sql/table
+          - id: database_sql_query
+            name: database-sql-query
+            path: ./database/sql/query
+            label: database/sql/query
           - id: native_query
             name: native-query
             path: ./native/query
             label: native/query
-          - id: native_table_legacy
-            name: native-table-legacy
-            path: ./native/table/legacy
-            label: native/table/legacy
-          - id: native_table_propose
-            name: native-table-propose
-            path: ./native/table/propose
-            label: native/table/propose
-          - id: gorm_legacy
-            name: gorm-legacy
-            path: ./gorm/legacy
-            label: gorm/legacy
-          - id: gorm_propose
-            name: gorm-propose
-            path: ./gorm/propose
-            label: gorm/propose
-          - id: xorm_legacy
-            name: xorm-legacy
-            path: ./xorm/legacy
-            label: xorm/legacy
-          - id: xorm_propose
-            name: xorm-propose
-            path: ./xorm/propose
-            label: xorm/propose
+          - id: native_table
+            name: native-table
+            path: ./native/table
+            label: native/table
+          - id: native_table_over_query_service
+            name: native-table-over-query-service
+            path: ./native/table/over/query/service
+            label: native/table/over/query/service
+          - id: gorm_table
+            name: gorm-table
+            path: ./gorm/table
+            label: gorm/table
+          - id: gorm_query
+            name: gorm-query
+            path: ./gorm/query
+            label: gorm/query
+          - id: xorm_table
+            name: xorm-table
+            path: ./xorm/table
+            label: xorm/table
+          - id: xorm_query
+            name: xorm-query
+            path: ./xorm/query
+            label: xorm/query
 
     concurrency:
       group: slo-${{ github.ref }}-${{ matrix.sdk.name }}

dsn_test.go

@@ -9,8 +9,8 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/config"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/bind"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xsql"
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xsql/legacy"
-	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xsql/propose"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xsql/xquery"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xsql/xtable"
 )
 
 func TestParse(t *testing.T) {
@@ -26,11 +26,11 @@ func TestParse(t *testing.T) {
 
 		return c
 	}
-	newLegacyConn := func(opts ...legacy.Option) *legacy.Conn {
-		return legacy.New(context.Background(), nil, nil, opts...)
+	newLegacyConn := func(opts ...xtable.Option) *xtable.Conn {
+		return xtable.New(context.Background(), nil, nil, opts...)
 	}
-	newQueryConn := func(opts ...propose.Option) *propose.Conn {
-		return propose.New(context.Background(), nil, nil, opts...)
+	newQueryConn := func(opts ...xquery.Option) *xquery.Conn {
+		return xquery.New(context.Background(), nil, nil, opts...)
 	}
 	compareConfigs := func(t *testing.T, lhs, rhs *config.Config) {
 		require.Equal(t, lhs.Secure(), rhs.Secure())
@@ -71,7 +71,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 			},
 			err: nil,
 		},
@@ -83,7 +83,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 				xsql.WithQueryBind(bind.TablePathPrefix("path/to/tables")),
 			},
 			err: nil,
@@ -96,7 +96,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 				xsql.WithQueryBind(bind.TablePathPrefix("path/to/tables")),
 				xsql.WithQueryBind(bind.NumericArgs{}),
 			},
@@ -110,7 +110,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 				xsql.WithQueryBind(bind.TablePathPrefix("path/to/tables")),
 				xsql.WithQueryBind(bind.PositionalArgs{}),
 			},
@@ -124,7 +124,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 				xsql.WithQueryBind(bind.TablePathPrefix("path/to/tables")),
 				xsql.WithQueryBind(bind.AutoDeclare{}),
 			},
@@ -138,7 +138,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 				xsql.WithQueryBind(bind.TablePathPrefix("path/to/tables")),
 			},
 			err: nil,
@@ -151,7 +151,7 @@ func TestParse(t *testing.T) {
 				config.WithDatabase("/local"),
 			},
 			connectorOpts: []xsql.Option{
-				xsql.WithDefaultQueryMode(legacy.ScriptingQueryMode),
+				xsql.WithDefaultQueryMode(xtable.ScriptingQueryMode),
 				xsql.WithQueryBind(bind.TablePathPrefix("path/to/tables")),
 				xsql.WithQueryBind(bind.PositionalArgs{}),
 				xsql.WithQueryBind(bind.AutoDeclare{}),
@@ -183,15 +183,15 @@ func TestParse(t *testing.T) {
 				exp := newConnector(tt.connectorOpts...)
 				act := newConnector(d.databaseSQLOptions...)
 				t.Run("tableOptions", func(t *testing.T) {
-					require.Equal(t, newLegacyConn(exp.LegacyOpts...), newLegacyConn(act.LegacyOpts...))
+					require.Equal(t, newLegacyConn(exp.TableOpts...), newLegacyConn(act.TableOpts...))
 				})
 				t.Run("queryOptions", func(t *testing.T) {
-					require.Equal(t, newQueryConn(exp.Options...), newQueryConn(act.Options...))
+					require.Equal(t, newQueryConn(exp.QueryOpts...), newQueryConn(act.QueryOpts...))
 				})
-				exp.LegacyOpts = nil
-				exp.Options = nil
-				act.LegacyOpts = nil
-				act.Options = nil
+				exp.TableOpts = nil
+				exp.QueryOpts = nil
+				act.TableOpts = nil
+				act.QueryOpts = nil
 				require.Equal(t, exp.Bindings(), act.Bindings())
 				require.Equal(t, exp, act)
 				compareConfigs(t, config.New(tt.opts...), d.config)

examples/migrations/goose/main.go

@@ -7,6 +7,7 @@ import (
 	"database/sql"
 	"embed"
 	"log"
+	"net/url"
 	"os"
 
 	"github.com/pressly/goose/v3"
@@ -20,16 +21,18 @@ func main() {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
-	nativeDriver, err := ydb.Open(ctx, os.Getenv("YDB_CONNECTION_STRING"))
+	connectionString := os.Getenv("YDB_CONNECTION_STRING")
+
+	nativeDriver, err := ydb.Open(ctx, connectionString)
 	if err != nil {
 		panic(err)
 	}
 
 	defer nativeDriver.Close(ctx)
 
 	connector, err := ydb.Connector(nativeDriver,
-		ydb.WithDefaultQueryMode(ydb.ScriptingQueryMode),
-		ydb.WithFakeTx(ydb.ScriptingQueryMode),
+		ydb.WithQueryService(true),
+		ydb.WithFakeTx(ydb.QueryExecuteQueryMode),
 		ydb.WithAutoDeclare(),
 		ydb.WithNumericArgs(),
 	)
@@ -46,9 +49,40 @@ func main() {
 		panic(err)
 	}
 
-	for _, command := range []string{"status", "up", "status"} {
+	dsn := func() string {
+		dsn, err := url.Parse(connectionString)
+		if err != nil {
+			panic(err)
+		}
+
+		q := dsn.Query()
+		q.Set("go_query_mode", "query")
+		q.Set("go_fake_tx", "query")
+		q.Set("go_query_bind", "declare")
+		q.Add("go_query_bind", "numeric")
+		dsn.RawQuery = q.Encode()
+
+		return dsn.String()
+	}()
+
+	for _, command := range []string{
+		"version",
+		"up-by-one",
+		"status",
+		"up",
+		"status",
+		"version",
+		"down",
+		"version",
+		"down",
+		"version",
+		"reset",
+		"version",
+		"status",
+	} {
+		log.Printf("try to run command `goose ydb \"%s\" %s`...", dsn, command)
 		if err := goose.RunContext(ctx, command, db, "schema"); err != nil {
-			log.Fatalf("goose %v: %v", "", err)
+			log.Fatalf("goose %v: %v", command, err)
 		}
 	}
 }

examples/migrations/goose/schema/00009_i.sql

@@ -0,0 +1,21 @@
+-- +goose Up
+CREATE TABLE `goose/orders` (
+    id String,
+    doc String,
+    PRIMARY KEY(id)
+);
+
+CREATE TABLE `goose/events` (
+    id String,
+    name Utf8,
+    service String,
+    channel Int64,
+    created Timestamp,
+    state Json,
+    INDEX sample_index GLOBAL ON (service, channel, created),
+    PRIMARY KEY(id, name)
+);
+
+-- +goose Down
+DROP TABLE `goose/events`;
+DROP TABLE `goose/orders`;

examples/migrations/goose/schema/00010_j.sql

@@ -0,0 +1,20 @@
+-- +goose Up
+CREATE TABLE `goose/records` (
+    id Utf8,
+    name Utf8,
+    str String,
+    num Uint64,
+    PRIMARY KEY(id, name)
+);
+
+ALTER TABLE `goose/records` ADD CHANGEFEED `changefeed` WITH (
+    FORMAT = 'JSON',
+    MODE = 'NEW_AND_OLD_IMAGES'
+);
+
+-- ALTER TOPIC `goose/records/changefeed` ADD CONSUMER `sample-consumer`;
+
+-- +goose Down
+-- ALTER TOPIC `goose/records/changefeed` DROP CONSUMER `sample-consumer`;
+ALTER TABLE `goose/records` DROP CHANGEFEED `changefeed`;
+DROP TABLE `goose/records`;

examples/migrations/goose/schema/00011_k.sql

@@ -0,0 +1,11 @@
+-- +goose Up
+CREATE TABLE `goose/tbl_with_pk_uuid` (
+    id Uuid,
+    value Double,
+    PRIMARY KEY(id)
+);
+UPSERT INTO `goose/tbl_with_pk_uuid` (id, value) VALUES (CAST('00000000-0000-0000-0000-000000000001' AS Uuid), 1.0);
+
+-- +goose Down
+DELETE FROM `goose/tbl_with_pk_uuid` WHERE id=CAST('00000000-0000-0000-0000-000000000001' AS Uuid);
+DROP TABLE `goose/tbl_with_pk_uuid`;

internal/node/id.go

@@ -0,0 +1,5 @@
+package node
+
+type ID interface {
+	NodeID() uint32
+}

internal/pool/pool.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/closer"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/endpoint"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/node"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/stack"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xcontext"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
@@ -22,9 +23,9 @@ import (
 type (
 	Item interface {
 		closer.Closer
+		node.ID
 
 		IsAlive() bool
-		NodeID() uint32
 	}
 	ItemConstraint[T any] interface {
 		*T

internal/query/execute_query.go

@@ -25,7 +25,7 @@ type executeSettings interface {
 	ExecMode() options.ExecMode
 	StatsMode() options.StatsMode
 	StatsCallback() func(stats stats.QueryStats)
-	TxControl() *query.TransactionControl
+	TxControl() options.TxControl
 	Syntax() options.Syntax
 	Params() params.Parameters
 	CallOptions() []grpc.CallOption