config

Documentation

Index

• Constants
• type Config
  • func New(opts ...Option) Config
• type Option
  • func WithCreateSessionTimeout(createSessionTimeout time.Duration) Option
  • func WithDeleteTimeout(deleteTimeout time.Duration) Option
  • func WithIdleKeepAliveThreshold(idleKeepAliveThreshold int) Option
  • func WithIdleThreshold(idleThreshold time.Duration) Option
  • func WithKeepAliveMinSize(keepAliveMinSize int) Option
  • func WithKeepAliveTimeout(keepAliveTimeout time.Duration) Option
  • func WithOperationCancelAfter(operationCancelAfter time.Duration) Option
  • func WithOperationTimeout(operationTimeout time.Duration) Option
  • func WithSizeLimit(sizeLimit int) Option
  • func WithTrace(trace trace.Table) Option

Constants

const (
	DefaultSessionPoolKeepAliveTimeout     = 500 * time.Millisecond
	DefaultSessionPoolDeleteTimeout        = 500 * time.Millisecond
	DefaultSessionPoolCreateSessionTimeout = 5 * time.Second
	DefaultSessionPoolIdleThreshold        = 5 * time.Minute
	DefaultSessionPoolSizeLimit            = 50
	DefaultKeepAliveMinSize                = 10
	DefaultIdleKeepAliveThreshold          = 2
)

Types

type Config

type Config interface {
	// OperationTimeout is the maximum amount of time a YDB server will process
	// an operation. After timeout exceeds YDB will try to cancel operation and
	// regardless of the cancellation appropriate error will be returned to
	// the client.
	// If OperationTimeout is zero then no timeout is used.
	OperationTimeout() time.Duration

	// OperationCancelAfter is the maximum amount of time a YDB server will process an
	// operation. After timeout exceeds YDB will try to cancel operation and if
	// it succeeds appropriate error will be returned to the client; otherwise
	// processing will be continued.
	// If OperationCancelAfter is zero then no timeout is used.
	OperationCancelAfter() time.Duration

	// Trace defines trace over table client calls
	Trace() trace.Table

	// SizeLimit is an upper bound of pooled sessions.
	// If SizeLimit is less than or equal to zero then the
	// DefaultSessionPoolSizeLimit variable is used as a limit.
	SizeLimit() int

	// KeepAliveMinSize is a lower bound for sessions in the pool. If there are more sessions open, then
	// the excess idle ones will be closed and removed after IdleKeepAliveThreshold is reached for each of them.
	// If KeepAliveMinSize is less than zero, then no sessions will be preserved
	// If KeepAliveMinSize is zero, the DefaultKeepAliveMinSize is used
	KeepAliveMinSize() int

	// IdleKeepAliveThreshold is a number of keepAlive messages to call before the
	// session is removed if it is an excess session (see KeepAliveMinSize)
	// This means that session will be deleted after the expiration of lifetime = IdleThreshold * IdleKeepAliveThreshold
	// If IdleKeepAliveThreshold is less than zero then it will be treated as infinite and no sessions will
	// be removed ever.
	// If IdleKeepAliveThreshold is equal to zero, it will be set to DefaultIdleKeepAliveThreshold
	IdleKeepAliveThreshold() int

	// IdleThreshold is a maximum duration between any activity within session.
	// If this threshold reached, KeepAlive() method will be called on idle
	// session.
	//
	// If IdleThreshold is less than zero then there is no idle limit.
	// If IdleThreshold is zero, then the DefaultSessionPoolIdleThreshold value
	// is used.
	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.
	KeepAliveTimeout() time.Duration

	// CreateSessionTimeout limits maximum time spent on Create session request
	// If CreateSessionTimeout is less than or equal to zero then the
	// DefaultSessionPoolCreateSessionTimeout is used.
	CreateSessionTimeout() time.Duration

	// DeleteTimeout limits maximum time spent on Delete request
	// If DeleteTimeout is less than or equal to zero then the
	// DefaultSessionPoolDeleteTimeout is used.
	DeleteTimeout() time.Duration
}

func New

func New(opts ...Option) Config

type Option

type Option func(*config)

func WithCreateSessionTimeout

func WithCreateSessionTimeout(createSessionTimeout time.Duration) Option

func WithDeleteTimeout

func WithDeleteTimeout(deleteTimeout time.Duration) Option

func WithIdleKeepAliveThreshold

func WithIdleKeepAliveThreshold(idleKeepAliveThreshold int) Option

func WithIdleThreshold

func WithIdleThreshold(idleThreshold time.Duration) Option

func WithKeepAliveMinSize

func WithKeepAliveMinSize(keepAliveMinSize int) Option

func WithKeepAliveTimeout

func WithKeepAliveTimeout(keepAliveTimeout time.Duration) Option

func WithOperationCancelAfter

func WithOperationCancelAfter(operationCancelAfter time.Duration) Option

func WithOperationTimeout

func WithOperationTimeout(operationTimeout time.Duration) Option

func WithSizeLimit

func WithSizeLimit(sizeLimit int) Option

func WithTrace

func WithTrace(trace trace.Table) Option