Merge pull request #1583 from ydb-platform/examples

alias for scripting fake txx to query fake tx + refactored examples and SLO's for using database/sql legacy and propose implementations + added example for goose

Author: asmyasnikov

.github/workflows/examples.yml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         ydb-version: [ 24.1, 24.2, 24.3 ]
-        application: [ native/table, native/query, database_sql, gorm, xorm ]
+        application: [ native/table, native/query ]
     services:
       ydb:
         image: ydbplatform/local-ydb:${{ matrix.ydb-version }}
@@ -47,6 +47,48 @@ jobs:
       - name: Run basic example ${{ matrix.application }}
         working-directory: ./examples/basic/${{ matrix.application }}
         run: go run .
+  basic-ydb-database-sql:
+    concurrency:
+      group: basic-ydb-${{ github.ref }}-${{ matrix.ydb-version }}-${{ matrix.application }}-${{ matrix.query_service }}
+      cancel-in-progress: true
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ydb-version: [ 24.1, 24.2, 24.3 ]
+        application: [ database/sql, gorm, xorm ]
+        query_service: [ true, false ]
+    services:
+      ydb:
+        image: ydbplatform/local-ydb:${{ matrix.ydb-version }}
+        ports:
+          - 2135:2135
+          - 2136:2136
+          - 8765:8765
+        volumes:
+          - /tmp/ydb_certs:/ydb_certs
+        env:
+          YDB_LOCAL_SURVIVE_RESTART: true
+          YDB_USE_IN_MEMORY_PDISKS: true
+          YDB_TABLE_ENABLE_PREPARED_DDL: true
+        options: '-h localhost'
+    env:
+      OS: ubuntu-latest
+      GO: 1.23.x
+      YDB_CONNECTION_STRING: grpc://localhost:2136/local
+      YDB_ANONYMOUS_CREDENTIALS: 1
+      YDB_VERSION: ${{ matrix.ydb-version }}
+      YDB_DATABASE_SQL_OVER_QUERY_SERVICE: ${{ matrix.query_service }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          cache: true
+      - name: Run basic example ${{ matrix.application }}
+        working-directory: ./examples/basic/${{ matrix.application }}
+        run: go run .
   basic-postgres:
     concurrency:
       group: basic-postgres-${{ matrix.application }}-${{ github.ref }}

.github/workflows/slo.yml

@@ -32,10 +32,14 @@ jobs:
     strategy:
       matrix:
         sdk:
-          - id: database_sql
-            name: database-sql
-            path: ./database/sql
-            label: database/sql
+          - 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: native_query
             name: native-query
             path: ./native/query
@@ -44,14 +48,22 @@ jobs:
             name: native-table
             path: ./native/table
             label: native/table
-          - id: gorm
-            name: gorm
-            path: ./gorm
-            label: gorm
-          - id: xorm
-            name: xorm
-            path: ./xorm
-            label: xorm
+          - 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
 
     concurrency:
       group: slo-${{ github.ref }}-${{ matrix.sdk.name }}

CHANGELOG.md

@@ -1,3 +1,5 @@
+* Added alias from `ydb.WithFakeTx(ydb.ScriptingQueryMode)` to `ydb.WithFakeTx(ydb.QueryExecuteQueryMode)` for compatibility with legacy code   
+
 ## v3.95.0
 * Added implementation of `database/sql` driver over query service client
 * Added `ydb.WithQueryService(bool)` option to explicitly enable `database/sql` driver over query service client

SQL.md

@@ -651,4 +651,4 @@ db := sql.OpenDB(connector)
 
 ## Example of usage <a name="example"></a>
 
-[Basic example](https://github.com/ydb-platform/ydb-go-examples/tree/master/basic) about series written with `database/sql` driver for `YDB` placed in [examples repository](https://github.com/ydb-platform/ydb-go-examples/tree/master/database_sql)  
+[Basic example](https://github.com/ydb-platform/ydb-go-sdk/tree/master/examples/basic/native/query) about series written with `database/sql` driver for `YDB` placed in [examples repository](https://github.com/ydb-platform/ydb-go-sdk/tree/master/examples/database/sql)  

examples/basic/database_sql/README.md renamed to examples/basic/database/sql/README.md

@@ -1,7 +1,3 @@
-/*
- database_sql
-*/
-
 package main
 
 import (

examples/basic/database_sql/data.go renamed to examples/basic/database/sql/data.go

@@ -31,7 +31,7 @@ func main() {
 	}
 	defer func() { _ = cc.Close(ctx) }()
 
-	prefix := path.Join(cc.Name(), "database_sql")
+	prefix := path.Join(cc.Name(), "database/sql")
 
 	c, err := ydb.Connector(cc,
 		ydb.WithAutoDeclare(),

examples/basic/database_sql/main.go renamed to examples/basic/database/sql/main.go

@@ -3,22 +3,23 @@ module examples
 go 1.23
 
 require (
-	github.com/golang-jwt/jwt/v4 v4.5.0
+	github.com/golang-jwt/jwt/v4 v4.5.1
 	github.com/google/uuid v1.6.0
 	github.com/gorilla/mux v1.8.0
 	github.com/lib/pq v1.10.2
+	github.com/pressly/goose/v3 v3.23.1
 	github.com/prometheus/client_golang v1.13.0
 	github.com/ydb-platform/gorm-driver v0.1.3
 	github.com/ydb-platform/ydb-go-sdk-auth-environ v0.3.0
 	github.com/ydb-platform/ydb-go-sdk-prometheus/v2 v2.0.1
-	github.com/ydb-platform/ydb-go-sdk/v3 v3.67.0
+	github.com/ydb-platform/ydb-go-sdk/v3 v3.95.0
 	github.com/ydb-platform/ydb-go-yc v0.12.1
-	golang.org/x/sync v0.7.0
+	golang.org/x/sync v0.10.0
 	google.golang.org/genproto v0.0.0-20240123012728-ef4313101c80
 	gorm.io/driver/postgres v1.5.0
 	gorm.io/driver/sqlite v1.5.0
 	gorm.io/gorm v1.25.10
-	modernc.org/sqlite v1.18.2
+	modernc.org/sqlite v1.34.1
 	xorm.io/builder v0.3.11-0.20220531020008-1bd24a7dc978
 	xorm.io/xorm v1.3.2
 )
@@ -31,46 +32,45 @@ require (
 	github.com/goccy/go-json v0.9.11 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
+	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
-	github.com/jackc/pgx/v5 v5.5.4 // indirect
-	github.com/jackc/puddle/v2 v2.2.1 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
+	github.com/jackc/pgx/v5 v5.7.1 // indirect
+	github.com/jackc/puddle/v2 v2.2.2 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/jonboulle/clockwork v0.4.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
-	github.com/mattn/go-isatty v0.0.17 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-sqlite3 v1.14.15 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
+	github.com/mfridman/interpolate v0.0.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/ncruces/go-strftime v0.1.9 // indirect
 	github.com/prometheus/client_model v0.5.0 // indirect
 	github.com/prometheus/common v0.37.0 // indirect
-	github.com/prometheus/procfs v0.8.0 // indirect
+	github.com/prometheus/procfs v0.12.0 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
+	github.com/sethvargo/go-retry v0.3.0 // indirect
 	github.com/syndtr/goleveldb v1.0.0 // indirect
 	github.com/yandex-cloud/go-genproto v0.0.0-20220815090733-4c139c0154e2 // indirect
 	github.com/ydb-platform/ydb-go-genproto v0.0.0-20241112172322-ea1f63298f77 // indirect
 	github.com/ydb-platform/ydb-go-yc-metadata v0.6.1 // indirect
-	golang.org/x/crypto v0.24.0 // indirect
-	golang.org/x/mod v0.17.0 // indirect
-	golang.org/x/net v0.26.0 // indirect
-	golang.org/x/sys v0.21.0 // indirect
-	golang.org/x/text v0.16.0 // indirect
-	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
+	golang.org/x/net v0.30.0 // indirect
+	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/text v0.21.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20240318140521-94a12d6c2237 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240515191416-fc5f0ca64291 // indirect
 	google.golang.org/grpc v1.64.1 // indirect
 	google.golang.org/protobuf v1.34.1 // indirect
-	lukechampine.com/uint128 v1.2.0 // indirect
-	modernc.org/cc/v3 v3.40.0 // indirect
-	modernc.org/ccgo/v3 v3.16.13 // indirect
-	modernc.org/libc v1.22.2 // indirect
-	modernc.org/mathutil v1.5.0 // indirect
-	modernc.org/memory v1.5.0 // indirect
-	modernc.org/opt v0.1.3 // indirect
-	modernc.org/strutil v1.1.3 // indirect
+	modernc.org/gc/v3 v3.0.0-20240107210532-573471604cb6 // indirect
+	modernc.org/libc v1.55.3 // indirect
+	modernc.org/mathutil v1.6.0 // indirect
+	modernc.org/memory v1.8.0 // indirect
+	modernc.org/strutil v1.2.0 // indirect
 	modernc.org/token v1.1.0 // indirect
 )