Merge pull request #196 from ydb-platform/dsn

add package dsn

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,6 @@
+* 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
 
 ## v3.18.5

dsn/dsn.go

@@ -0,0 +1,53 @@
+package dsn
+
+import (
+	"fmt"
+)
+
+// Usage of this package
+//
+// db, err := ydb.New(
+//   ctx,
+//   ydb.WithConnectionString(
+//     New("endpoint", "database").WithSecure(false).String(),
+// ),
+//)
+
+// DSN helps to make connection string from separated endpoint and database
+type DSN interface {
+	fmt.Stringer
+
+	// WithSecure makes new DSN from current DSN with passed secure flag
+	WithSecure(secure bool) DSN
+}
+
+type connectionString struct {
+	endpoint string
+	database string
+	secure   bool
+}
+
+func (cs *connectionString) String() (s string) {
+	s = "grpc"
+	if cs.secure {
+		s += "s"
+	}
+	return s + "://" + cs.endpoint + "/?database=" + cs.database
+}
+
+func (cs *connectionString) WithSecure(secure bool) DSN {
+	return &connectionString{
+		secure:   secure,
+		endpoint: cs.endpoint,
+		database: cs.database,
+	}
+}
+
+// New makes secured DSN with endpoint and database
+func New(endpoint, database string) DSN {
+	return &connectionString{
+		endpoint: endpoint,
+		database: database,
+		secure:   true,
+	}
+}

dsn/parser.go

@@ -0,0 +1,17 @@
+package dsn
+
+import (
+	"fmt"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3/config"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/dsn"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
+)
+
+func RegisterParser(param string, parser func(value string) ([]config.Option, error)) (err error) {
+	err = dsn.Register(param, parser)
+	if err != nil {
+		return xerrors.WithStackTrace(fmt.Errorf("%w: %s", err, param))
+	}
+	return nil
+}

options.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"crypto/x509"
 	"encoding/pem"
-	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -69,6 +68,8 @@ func WithRequestsType(requestsType string) Option {
 }
 
 // WithConnectionString accept connection string like 'grpc[s]://{endpoint}/?database={database}'
+// Warning: WithConnectionString will be removed at next major release
+// (connection string will be required string param of ydb.New)
 func WithConnectionString(connectionString string) Option {
 	return func(ctx context.Context, c *connection) error {
 		var (
@@ -96,14 +97,6 @@ func WithConnectionString(connectionString string) Option {
 	}
 }
 
-func RegisterParser(param string, parser func(value string) ([]config.Option, error)) (err error) {
-	err = dsn.Register(param, parser)
-	if err != nil {
-		return xerrors.WithStackTrace(fmt.Errorf("%w: %s", err, param))
-	}
-	return nil
-}
-
 // WithConnectionTTL defines duration for parking idle connections
 // Warning: if defined WithSessionPoolIdleThreshold - idleThreshold must be less than connectionTTL
 func WithConnectionTTL(ttl time.Duration) Option {
@@ -113,27 +106,35 @@ func WithConnectionTTL(ttl time.Duration) Option {
 	}
 }
 
+// WithEndpoint defines endpoint option
+// Deprecated: use WithConnectionString or dsn package instead
 func WithEndpoint(endpoint string) Option {
 	return func(ctx context.Context, c *connection) error {
 		c.options = append(c.options, config.WithEndpoint(endpoint))
 		return nil
 	}
 }
 
+// WithDatabase defines database option
+// Deprecated: use WithConnectionString or dsn package instead
 func WithDatabase(database string) Option {
 	return func(ctx context.Context, c *connection) error {
 		c.options = append(c.options, config.WithDatabase(database))
 		return nil
 	}
 }
 
+// WithSecure defines secure option
+// Deprecated: use WithConnectionString or dsn package instead
 func WithSecure(secure bool) Option {
 	return func(ctx context.Context, c *connection) error {
 		c.options = append(c.options, config.WithSecure(secure))
 		return nil
 	}
 }
 
+// WithInsecure defines secure option
+// Deprecated: use WithConnectionString or dsn package instead
 func WithInsecure() Option {
 	return func(ctx context.Context, c *connection) error {
 		c.options = append(c.options, config.WithSecure(false))