mongokit

Documentation

Index

• type Conn
  • func New(addr string, options ...Option) (*Conn, error)
  • func (c *Conn) Close() error
  • func (c *Conn) Health(ctx context.Context) error
• type ConnOptions
• type Option
  • func WithAppName(name string) Option
  • func WithConnectTimeout(timeout time.Duration) Option
  • func WithDirectConnection(direct bool) Option
  • func WithReadPref(readPref *readpref.ReadPref) Option

Types

type Conn

type Conn struct{ *mongo.Client }

Conn wraps the connection to the MongoDB.

func New

func New(addr string, options ...Option) (*Conn, error)

New returns a pointer to a new instance of Conn struct. Receives variadic Option to configure the MongoDB connection settings.

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) Health

func (c *Conn) Health(ctx context.Context) error

Health implements the health.Checker interface for MongoDB connection.

type ConnOptions

type ConnOptions struct {
	// contains filtered or unexported fields
}

ConnOptions represents the configuration options for the MongoDB connection Conn.

type Option

type Option func(options *ConnOptions)

Option configures the mongo options.ClientOptions.

func WithAppName

func WithAppName(name string) Option

WithAppName sets app name to the connection properties.

func WithConnectTimeout

func WithConnectTimeout(timeout time.Duration) Option

WithConnectTimeout specifies a timeout that is used for creating connections to the server. This can be set through ApplyURI with the "connectTimeoutMS" (e.g "connectTimeoutMS=30") option. If set to 0, no timeout will be used. The default is 30 seconds.

func WithDirectConnection

func WithDirectConnection(direct bool) Option

WithDirectConnection sets ability to make direct connection.

func WithReadPref

func WithReadPref(readPref *readpref.ReadPref) Option

WithReadPref sets the Mongo read preference which determines which servers are considered suitable for read operations.