mongo

package

v1.0.0 Latest Latest Go to latest Published: Jul 6, 2022 License: MIT Imports: 7 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/jeamon/sample-rest-api

Links

Open Source Insights

Documentation ¶

Index ¶

func GetClient(c *Config) (*mongo.Client, error)
type Config
type Handler
- func (h *Handler) Shutdown(ctx context.Context) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetClient ¶

func GetClient(c *Config) (*mongo.Client, error)

Types ¶

type Config ¶

type Config struct {
	Host          string
	Port          string
	User          string
	Password      string
	Database      string
	MigrationPath string
}

Config holds all values used to configure and connect to a postgres db.

func (*Config) Check ¶

func (c *Config) Check() func(ctx context.Context) error

Check allows to probe the liveness of mongo database.

func (*Config) ConnectAndMigrate ¶

func (c *Config) ConnectAndMigrate(logger *zap.Logger) (*Handler, error)

Connect establishes a connection to the database based on the configuration provided.

func (*Config) ToDSN ¶

func (c *Config) ToDSN() string

type Handler ¶

type Handler struct {
	Client *mongo.Client
}

Handler holds a connection to the nosql database

func (*Handler) Shutdown ¶

func (h *Handler) Shutdown(ctx context.Context) error

Shutdown closes all connections.

Source Files ¶

View all Source files

handler.go

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