collectionopt

package

v0.0.17 Latest Latest Go to latest Published: Oct 25, 2018 License: Apache-2.0 Imports: 4 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

This section is empty.

This section is empty.

This section is empty.

type Collection struct {
	ReadConcern    *readconcern.ReadConcern
	WriteConcern   *writeconcern.WriteConcern
	ReadPreference *readpref.ReadPref
}

Collection represents a collection.

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

CollectionBundle is a bundle of collection options.

func BundleCollection(opts ...Option) *CollectionBundle

BundleCollection bundles collection options.

func (cb *CollectionBundle) ReadConcern(rc *readconcern.ReadConcern) *CollectionBundle

ReadConcern sets the read concern.

func (cb *CollectionBundle) ReadPreference(rp *readpref.ReadPref) *CollectionBundle

ReadPreference sets the read preference.

func (cb *CollectionBundle) String() string

String prints a string representation of the bundle for debug purposes

func (cb *CollectionBundle) Unbundle() (*Collection, error)

Unbundle unbundles the options, returning a collection.

func (cb *CollectionBundle) WriteConcern(wc *writeconcern.WriteConcern) *CollectionBundle

WriteConcern sets the write concern.

type Option interface {
	// contains filtered or unexported methods
}

Option represents a collection option.

func ReadConcern(rc *readconcern.ReadConcern) Option

ReadConcern sets the read concern.

func ReadPreference(rp *readpref.ReadPref) Option

ReadPreference sets the read preference.

func WriteConcern(wc *writeconcern.WriteConcern) Option

WriteConcern sets the write concern.