fix URL for versioning policy

ydb-platform · Apr 8, 2024 · ac576fa · ac576fa
1 parent 961b160
commit ac576fa
Show file tree

Hide file tree

Showing 40 changed files with 327 additions and 327 deletions.
diff --git a/balancers/balancers.go b/balancers/balancers.go
@@ -9,7 +9,7 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 )
 
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func RoundRobin() *balancerConfig.Config {
 	return &balancerConfig.Config{}
 }

diff --git a/config/config.go b/config/config.go
@@ -107,7 +107,7 @@ type Option func(c *Config)
 
 // WithInternalDNSResolver
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithInternalDNSResolver() Option {
 	return func(c *Config) {}
 }
@@ -170,7 +170,7 @@ func WithApplicationName(applicationName string) Option {
 
 // WithUserAgent add provided user agent to all api requests
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithUserAgent(userAgent string) Option {
 	return func(c *Config) {
 		c.metaOptions = append(c.metaOptions, meta.WithApplicationNameOption(userAgent))

diff --git a/connection.go b/connection.go
@@ -16,7 +16,7 @@ import (
 // Connection interface provide access to YDB service clients
 // Interface and list of clients may be changed in the future
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 type Connection interface { //nolint:interfacebloat
 	// Endpoint returns initial endpoint
 	Endpoint() string
@@ -35,7 +35,7 @@ type Connection interface { //nolint:interfacebloat
 
 	// Query returns query client
 	//
-	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 	Query() query.Client
 
 	// Scheme returns scheme client

diff --git a/coordination/coordination.go b/coordination/coordination.go
@@ -26,7 +26,7 @@ type Client interface {
 	// - close the Client which the session was created with,
 	// - call any method of the Session until the ErrSessionClosed is returned.
 	//
-	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 	Session(ctx context.Context, path string, opts ...options.SessionOption) (Session, error)
 }
 

diff --git a/driver.go b/driver.go
@@ -191,7 +191,7 @@ func (d *Driver) Table() table.Client {
 
 // Query returns query client
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 func (d *Driver) Query() query.Client {
 	return d.query.Get()
 }
@@ -273,7 +273,7 @@ func MustOpen(ctx context.Context, dsn string, opts ...Option) *Driver {
 
 // New connects to database and return driver runtime holder
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func New(ctx context.Context, opts ...Option) (_ *Driver, err error) { //nolint:nonamedreturns
 	d, err := newConnectionFromOptions(ctx, opts...)
 	if err != nil {

diff --git a/internal/table/config/config.go b/internal/table/config/config.go
@@ -15,13 +15,13 @@ const (
 	DefaultSessionPoolSizeLimit            = 50
 	DefaultSessionPoolIdleThreshold        = 5 * time.Minute
 
-	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 	DefaultKeepAliveMinSize = 10
 
-	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 	DefaultIdleKeepAliveThreshold = 2
 
-	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 	DefaultSessionPoolKeepAliveTimeout = 500 * time.Millisecond
 )
 
@@ -61,7 +61,7 @@ func WithSizeLimit(sizeLimit int) Option {
 // If keepAliveMinSize is less than zero, then no sessions will be preserved
 // If keepAliveMinSize is zero, the DefaultKeepAliveMinSize is used
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithKeepAliveMinSize(keepAliveMinSize int) Option {
 	return func(c *Config) {}
 }
@@ -73,7 +73,7 @@ func WithKeepAliveMinSize(keepAliveMinSize int) Option {
 // be removed ever.
 // If IdleKeepAliveThreshold is equal to zero, it will be set to DefaultIdleKeepAliveThreshold
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithIdleKeepAliveThreshold(idleKeepAliveThreshold int) Option {
 	return func(c *Config) {}
 }
@@ -95,7 +95,7 @@ func WithIdleThreshold(idleThreshold time.Duration) Option {
 // WithKeepAliveTimeout limits maximum time spent on KeepAlive request
 // If keepAliveTimeout is less than or equal to zero then the DefaultSessionPoolKeepAliveTimeout is used.
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithKeepAliveTimeout(keepAliveTimeout time.Duration) Option {
 	return func(c *Config) {}
 }
@@ -182,7 +182,7 @@ func (c *Config) SizeLimit() int {
 // If KeepAliveMinSize is less than zero, then no sessions will be preserved
 // If KeepAliveMinSize is zero, the DefaultKeepAliveMinSize is used
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func (c *Config) KeepAliveMinSize() int {
 	return DefaultKeepAliveMinSize
 }
@@ -199,7 +199,7 @@ func (c *Config) IgnoreTruncated() bool {
 // be removed ever.
 // If IdleKeepAliveThreshold is equal to zero, it will be set to DefaultIdleKeepAliveThreshold
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func (c *Config) IdleKeepAliveThreshold() int {
 	return DefaultIdleKeepAliveThreshold
 }
@@ -216,7 +216,7 @@ func (c *Config) IdleThreshold() time.Duration {
 // KeepAliveTimeout limits maximum time spent on KeepAlive request
 // If KeepAliveTimeout is less than or equal to zero then the DefaultSessionPoolKeepAliveTimeout is used.
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func (c *Config) KeepAliveTimeout() time.Duration {
 	return DefaultSessionPoolKeepAliveTimeout
 }

diff --git a/internal/topic/topicreaderinternal/commit_range.go b/internal/topic/topicreaderinternal/commit_range.go
@@ -158,7 +158,7 @@ func (r *CommitRanges) toRawPartitionCommitOffset() []rawtopicreader.PartitionCo
 
 // PublicCommitRange contains data for commit messages range
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 type PublicCommitRange struct {
 	priv commitRange
 }

diff --git a/internal/topic/topicwriterinternal/writer_options.go b/internal/topic/topicwriterinternal/writer_options.go
@@ -51,7 +51,7 @@ func WithTokenUpdateInterval(interval time.Duration) PublicWriterOption {
 
 // WithCommonConfig
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 func WithCommonConfig(common config.Common) PublicWriterOption {
 	return func(cfg *WriterReconnectorConfig) {
 		cfg.Common = common

diff --git a/meta.go b/meta.go
@@ -8,14 +8,14 @@ import (
 
 // WithTraceID returns a copy of parent context with traceID
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithTraceID(ctx context.Context, traceID string) context.Context {
 	return meta.WithTraceID(ctx, traceID)
 }
 
 // WithRequestType returns a copy of parent context with custom request type
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithRequestType(ctx context.Context, requestType string) context.Context {
 	return meta.WithRequestType(ctx, requestType)
 }
diff --git a/meta/context.go b/meta/context.go
@@ -15,7 +15,7 @@ func WithTraceID(ctx context.Context, traceID string) context.Context {
 
 // WithUserAgent returns a copy of parent context with custom user-agent info
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithUserAgent(ctx context.Context, _ string) context.Context {
 	return ctx
 }

diff --git a/metrics/config.go b/metrics/config.go
@@ -4,7 +4,7 @@ import "github.com/ydb-platform/ydb-go-sdk/v3/trace"
 
 // Config is interface for metrics registry config
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 type Config interface {
 	Registry
 

diff --git a/metrics/registry.go b/metrics/registry.go
@@ -2,7 +2,7 @@ package metrics
 
 // Registry is interface for metrics registry
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 type Registry interface {
 	// CounterVec returns CounterVec by name, subsystem and labels
 	// If counter by args already created - return counter from cache

diff --git a/options.go b/options.go
@@ -65,7 +65,7 @@ func WithApplicationName(applicationName string) Option {
 
 // WithUserAgent add provided user agent value to all api requests
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithUserAgent(userAgent string) Option {
 	return func(ctx context.Context, c *Driver) error {
 		c.options = append(c.options, config.WithApplicationName(userAgent))
@@ -434,14 +434,14 @@ func WithSessionPoolDeleteTimeout(deleteTimeout time.Duration) Option {
 
 // WithSessionPoolKeepAliveMinSize set minimum sessions should be keeped alive in table.Client
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithSessionPoolKeepAliveMinSize(keepAliveMinSize int) Option {
 	return func(ctx context.Context, c *Driver) error { return nil }
 }
 
 // WithSessionPoolKeepAliveTimeout set timeout of keep alive requests for session in table.Client
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithSessionPoolKeepAliveTimeout(keepAliveTimeout time.Duration) Option {
 	return func(ctx context.Context, c *Driver) error { return nil }
 }

diff --git a/params_builder.go b/params_builder.go
@@ -4,7 +4,7 @@ import "github.com/ydb-platform/ydb-go-sdk/v3/internal/params"
 
 // ParamsBuilder used for create query arguments instead of tons options.
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 func ParamsBuilder() params.Builder {
 	return params.Builder{}
 }
diff --git a/retry/context.go b/retry/context.go
@@ -8,21 +8,21 @@ type (
 
 // WithIdempotentOperation returns a copy of parent context with idempotent operation feature
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithIdempotentOperation(ctx context.Context) context.Context {
 	return context.WithValue(ctx, ctxIsOperationIdempotentKey{}, true)
 }
 
 // WithNonIdempotentOperation returns a copy of parent context with non-idempotent operation feature
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithNonIdempotentOperation(ctx context.Context) context.Context {
 	return context.WithValue(ctx, ctxIsOperationIdempotentKey{}, false)
 }
 
 // IsOperationIdempotent returns the flag for retry with no idempotent errors
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func IsOperationIdempotent(ctx context.Context) bool {
 	v, ok := ctx.Value(ctxIsOperationIdempotentKey{}).(bool)
 

diff --git a/retry/sql.go b/retry/sql.go
@@ -32,7 +32,7 @@ func (retryOptions doRetryOptionsOption) ApplyDoOption(opts *doOptions) {
 }
 
 // WithDoRetryOptions specified retry options
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithDoRetryOptions(opts ...Option) doRetryOptionsOption {
 	return opts
 }
@@ -102,7 +102,7 @@ func (doTxRetryOptions doTxRetryOptionsOption) ApplyDoTxOption(o *doTxOptions) {
 }
 
 // WithDoTxRetryOptions specified retry options
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithDoTxRetryOptions(opts ...Option) doTxRetryOptionsOption {
 	return opts
 }

diff --git a/sugar/params.go b/sugar/params.go
@@ -18,7 +18,7 @@ type constraint interface {
 
 // GenerateDeclareSection generates DECLARE section text in YQL query by params
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func GenerateDeclareSection[T constraint](parameters T) (string, error) {
 	switch v := any(parameters).(type) {
 	case *params.Parameters:
@@ -36,7 +36,7 @@ func GenerateDeclareSection[T constraint](parameters T) (string, error) {
 
 // ToYdbParam converts
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func ToYdbParam(param sql.NamedArg) (*params.Parameter, error) {
 	params, err := bind.Params(param)
 	if err != nil {

diff --git a/sugar/result.go b/sugar/result.go
@@ -73,7 +73,7 @@ func (r *result) Close() error {
 
 // Result converts query.Result to iterable result for compatibility with table/result.Result usage
 //
-// Experimental: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#experimental
+// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 func Result(r query.Result) *result {
 	return &result{
 		r: r,

diff --git a/table/options/models.go b/table/options/models.go
@@ -420,7 +420,7 @@ func (kr KeyRange) String() string {
 	return buf.String()
 }
 
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 type TTLSettings struct {
 	DateTimeColumn string
 	TTLSeconds     uint32

diff --git a/table/options/options.go b/table/options/options.go
@@ -518,7 +518,7 @@ func WithPartitioningPolicyMode(mode PartitioningMode) PartitioningPolicyOption
 	}
 }
 
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithPartitioningPolicyUniformPartitions(n uint64) PartitioningPolicyOption {
 	return func(p *partitioningPolicy, a *allocator.Allocator) {
 		p.Partitions = &Ydb_Table.PartitioningPolicy_UniformPartitions{
@@ -527,7 +527,7 @@ func WithPartitioningPolicyUniformPartitions(n uint64) PartitioningPolicyOption
 	}
 }
 
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithPartitioningPolicyExplicitPartitions(splitPoints ...value.Value) PartitioningPolicyOption {
 	return func(p *partitioningPolicy, a *allocator.Allocator) {
 		values := make([]*Ydb.TypedValue, len(splitPoints))
@@ -891,7 +891,7 @@ func WithIgnoreTruncated() ExecuteDataQueryOption {
 
 // WithQueryCachePolicyKeepInCache manages keep-in-cache policy
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 // Use WithKeepInCache for disabling keep-in-cache policy
 func WithQueryCachePolicyKeepInCache() QueryCachePolicyOption {
 	return withQueryCachePolicyKeepInCache(true)
@@ -905,7 +905,7 @@ func withQueryCachePolicyKeepInCache(keepInCache bool) QueryCachePolicyOption {
 
 // WithQueryCachePolicy manages query cache policy
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WithQueryCachePolicy(opts ...QueryCachePolicyOption) ExecuteDataQueryOption {
 	return withQueryCachePolicy(opts...)
 }

diff --git a/table/table.go b/table/table.go
@@ -39,7 +39,7 @@ type Client interface {
 	// - context was canceled or deadlined
 	// - session was created
 	//
-	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+	// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 	CreateSession(ctx context.Context, opts ...Option) (s ClosableSession, err error)
 
 	// Do provide the best effort for execute operation.

diff --git a/table/types/cast.go b/table/types/cast.go
@@ -93,7 +93,7 @@ func VariantValue(v Value) (name string, idx uint32, _ Value, _ error) {
 
 // DictFields returns dict values from abstract Value
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func DictFields(v Value) (map[Value]Value, error) {
 	return DictValues(v)
 }

diff --git a/table/types/types.go b/table/types/types.go
@@ -120,7 +120,7 @@ const (
 
 // WriteTypeStringTo writes ydb type string representation into buffer
 //
-// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/master/VERSIONING.md#deprecated
+// Deprecated: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#deprecated
 func WriteTypeStringTo(buf *bytes.Buffer, t Type) { //nolint: interfacer
 	buf.WriteString(t.Yql())
 }