mongo

package module

v0.1.0 Latest Latest Go to latest Published: Dec 5, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/an-repository/mongo

README ¶

mongo

TODO

Documentation ¶

Overview ¶

Package mongo TODO

Index ¶

type Client
- func Connect(cfg *Config) (*Client, error)
- func (c *Client) Disconnect() error
type Config
- func NewConfig(options ...Option) *Config
- func (c *Config) URI() (string, error)
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	*mongo.Client
}

func Connect ¶

func Connect(cfg *Config) (*Client, error)

func (*Client) Disconnect ¶

func (c *Client) Disconnect() error

type Config ¶

type Config struct {
	Servers        map[string]int    `dm:"servers"`
	Username       string            `dm:"username"`
	Password       string            `dm:"password"`
	Options        map[string]string `dm:"options"`
	ConnectTimeout time.Duration     `dm:"connect_timeout"`
}

func NewConfig ¶

func NewConfig(options ...Option) *Config

func (*Config) URI ¶

func (c *Config) URI() (string, error)

type Option ¶

type Option func(*Config)

func WithAuth ¶

func WithAuth(username, password string) Option

func WithConnectTimeout ¶

func WithConnectTimeout(timeout time.Duration) Option

func WithOption ¶

func WithOption(name, value string) Option

func WithServer ¶

func WithServer(host string, port int) Option

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL