README.md

Author: asmyasnikov

CHANGELOG.md

@@ -1,8 +1,10 @@
+* Simplified README.md for godoc documentation in pkg.go.dev
+
 ## v3.19.0
 * Added public package `dsn` for making piped data source name (connection string)
 * Marked `ydb.WithEndpoint`, `ydb.WithDatabase`, `ydb.WithSecure`, `ydb.WithInsecure` options as deprecated
 * Moved `ydb.RegisterParser` to package `dsn`
-* Added version into all error and warm log messages
+* Added version into all error and warn log messages
 
 ## v3.18.5
 * Fixed duplicating `WithPanicCallback` proxying to table config options

README.md

@@ -11,62 +11,7 @@
 
 Supports `table`, `discovery`, `coordination`, `ratelimiter`, `scheme` and `scripting` clients for `YDB`.
 
-```go
-import (
-  "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/result/named"
-  "github.com/ydb-platform/ydb-go-sdk/v3/table/types"
-)
-
-db, err := ydb.New(ctx,
-  ydb.WithConnectionString("grpcs://localhost:2135/?database=/local"),
-  ydb.WithAnonymousCredentials(),
-)
-if err != nil {
-  log.Fatal(err)
-}
-defer func() { _ = db.Close(ctx) }()
-err = db.Table().Do(
-  ctx,
-  func(ctx context.Context, s table.Session) (err error) {
-    _, res, err := s.Execute(ctx,
-      table.TxControl(
-        table.BeginTx(table.WithSerializableReadWrite()), table.CommitTx(),
-      ),
-      "DECLARE $myStr AS Utf8; SELECT 42 as id, $myStr as myStr",
-      table.NewQueryParameters(
-        table.ValueParam("$myStr", types.UTF8Value("test")),
-      ),
-    )
-    if err != nil {
-      return err // for driver retry
-    }
-    defer func() { _ = res.Close() }()
-    var (
-      id    int32
-      myStr *string //optional value
-    )
-    for res.NextResultSet(ctx) {
-      for res.NextRow() {
-        err := res.ScanNamed(
-          named.Required("id", &id),
-          named.Optional("myStr", &myStr),
-        )
-        if err != nil {
-          return err
-        }
-        fmt.Printf("got id %v, got mystr: %v\n", id, *myStr)
-      }
-    }
-    return res.Err()
-  },
-)
-if err != nil {
-  log.Fatal(err)
-}
-```
-More examples of usage placed in [examples](https://github.com/ydb-platform/ydb-go-examples) repository.
+Simple example see in [example](example_table_test.go). More examples of usage placed in [examples](https://github.com/ydb-platform/ydb-go-examples) repository.
 
 See also [CREDENTIALS.md](CREDENTIALS.md) about supported YDB credentials.
 

dsn/dsn.go

@@ -10,8 +10,8 @@ import (
 //   ctx,
 //   ydb.WithConnectionString(
 //     New("endpoint", "database").WithSecure(false).String(),
-// ),
-//)
+//   ),
+// )
 
 // DSN helps to make connection string from separated endpoint and database
 type DSN interface {