mongo

package

v1.15.5 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 9 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/americanas-go/ignite

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ConfigAdd(path string)
type ClientOptionsPlugin
type ClientPlugin
type Conn
type Options
- func NewOptions() (*Options, error)
- func NewOptionsWithPath(path string) (opts *Options, err error)
type Plugin

Constants ¶

View Source

const (
	PluginsRoot = root + ".plugins"
)

Variables ¶

This section is empty.

Functions ¶

func ConfigAdd ¶

func ConfigAdd(path string)

Types ¶

type ClientOptionsPlugin ¶

type ClientOptionsPlugin func(context.Context, *options.ClientOptions) error

ClientOptionsPlugin defines a mongo client options plugin signature.

type ClientPlugin ¶

type ClientPlugin func(context.Context, *mongo.Client) error

ClientPlugin defines a mongo client plugin signature.

type Conn ¶

type Conn struct {
	ClientOptions *options.ClientOptions
	Client        *mongo.Client
	Database      *mongo.Database
	Options       *Options
	Plugins       []Plugin
}

Conn represents a mongo connection.

func NewConn ¶

func NewConn(ctx context.Context, plugins ...Plugin) (*Conn, error)

NewConn returns a new connection with default options.

func NewConnWithConfigPath ¶

func NewConnWithConfigPath(ctx context.Context, path string, plugins ...Plugin) (*Conn, error)

NewConnWithConfigPath returns a new connection with options from config path.

func NewConnWithOptions ¶

func NewConnWithOptions(ctx context.Context, o *Options, plugins ...Plugin) (conn *Conn, err error)

NewConnWithOptions returns a new connection with options from config path.

type Options ¶

type Options struct {
	Uri  string
	Auth *options.Credential
}

Options represents mongo client options.

func NewOptions ¶

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath ¶

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type Plugin ¶

type Plugin func(context.Context) (ClientOptionsPlugin, ClientPlugin)

Plugin defines a function to process plugin.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples
ping
plugins
contrib/americanas-go/health.v1
contrib/datadog/dd-trace-go.v1
contrib/go.opentelemetry.io/contrib.v0 This package implements integration between the official go mongodb driver (https://github.com/mongodb/mongo-go-driver) and OpenTelemetry.	This package implements integration between the official go mongodb driver (https://github.com/mongodb/mongo-go-driver) and OpenTelemetry.
contrib/newrelic/go-agent.v3

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