config

Documentation

Index

• Constants
• type Config
  • func New(opts ...Option) *Config
  • func (c *Config) Database() string
  • func (c *Config) Endpoint() string
  • func (c *Config) Interval() time.Duration
  • func (c *Config) Meta() *meta.Meta
  • func (c *Config) Secure() bool
  • func (c *Config) Trace() *trace.Discovery
• type Option
  • func With(config config.Common) Option
  • func WithDatabase(database string) Option
  • func WithEndpoint(endpoint string) Option
  • func WithInterval(interval time.Duration) Option
  • func WithMeta(meta *meta.Meta) Option
  • func WithSecure(ssl bool) Option
  • func WithTrace(trace trace.Discovery, opts ...trace.DiscoveryComposeOption) Option

Constants

const (
	DefaultInterval = time.Minute
)

Types

type Config

type Config struct {
	config.Common
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) *Config

func (*Config) Database

func (c *Config) Database() string

func (*Config) Endpoint

func (c *Config) Endpoint() string

func (*Config) Interval

func (c *Config) Interval() time.Duration

func (*Config) Meta

func (c *Config) Meta() *meta.Meta

func (*Config) Secure

func (c *Config) Secure() bool

func (*Config) Trace

func (c *Config) Trace() *trace.Discovery

type Option

type Option func(c *Config)

func With

func With(config config.Common) Option

With applies common configuration params

func WithDatabase

func WithDatabase(database string) Option

WithDatabase set a required database name.

func WithEndpoint

func WithEndpoint(endpoint string) Option

WithEndpoint set a required starting endpoint for connect

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval set the frequency of background tasks of ydb endpoints discovery.

If Interval is zero then the DefaultInterval is used.

If Interval is negative, then no background discovery prepared.

func WithMeta

func WithMeta(meta *meta.Meta) Option

WithMeta is not for user.

This option add meta information about database connection

func WithSecure

func WithSecure(ssl bool) Option

WithSecure set flag for secure connection

func WithTrace

func WithTrace(trace trace.Discovery, opts ...trace.DiscoveryComposeOption) Option

WithTrace configures discovery client calls tracing