mongo-driver: go.mongodb.org/mongo-driver/mongo/readpref Index | Files

package readpref

import "go.mongodb.org/mongo-driver/mongo/readpref"

Index

Package Files

mode.go options.go readpref.go

Variables

❖
var ErrInvalidTagSet = errors.New("an even number of tags must be specified")

ErrInvalidTagSet indicates that an invalid set of tags was specified.

type Mode Uses

❖
type Mode uint8

Mode indicates the user's preference on reads.

❖
const (

    // PrimaryMode indicates that only a primary is
    // considered for reading. This is the default
    // mode.
    PrimaryMode Mode
    // PrimaryPreferredMode indicates that if a primary
    // is available, use it; otherwise, eligible
    // secondaries will be considered.
    PrimaryPreferredMode
    // SecondaryMode indicates that only secondaries
    // should be considered.
    SecondaryMode
    // SecondaryPreferredMode indicates that only secondaries
    // should be considered when one is available. If none
    // are available, then a primary will be considered.
    SecondaryPreferredMode
    // NearestMode indicates that all primaries and secondaries
    // will be considered.
    NearestMode
)

Mode constants

func ModeFromString Uses

❖
func ModeFromString(mode string) (Mode, error)

ModeFromString returns a mode corresponding to mode.

type Option Uses

❖
type Option func(*ReadPref) error

Option configures a read preference

func WithMaxStaleness Uses

❖
func WithMaxStaleness(ms time.Duration) Option

WithMaxStaleness sets the maximum staleness a server is allowed.

func WithTagSets Uses

❖
func WithTagSets(tagSets ...tag.Set) Option

WithTagSets sets the tag sets used to match a server. The last call to WithTags or WithTagSets overrides all previous calls to either method.

func WithTags Uses

❖
func WithTags(tags ...string) Option

WithTags sets a single tag set used to match a server. The last call to WithTags or WithTagSets overrides all previous calls to either method.

type ReadPref Uses

❖
type ReadPref struct {
    // contains filtered or unexported fields
}

ReadPref determines which servers are considered suitable for read operations.

func Nearest Uses

❖
func Nearest(opts ...Option) *ReadPref

Nearest constructs a read preference with a NearestMode.

func New Uses

❖
func New(mode Mode, opts ...Option) (*ReadPref, error)

New creates a new ReadPref.

func Primary Uses

❖
func Primary() *ReadPref

Primary constructs a read preference with a PrimaryMode.

func PrimaryPreferred Uses

❖
func PrimaryPreferred(opts ...Option) *ReadPref

PrimaryPreferred constructs a read preference with a PrimaryPreferredMode.

func Secondary Uses

❖
func Secondary(opts ...Option) *ReadPref

Secondary constructs a read preference with a SecondaryMode.

func SecondaryPreferred Uses

❖
func SecondaryPreferred(opts ...Option) *ReadPref

SecondaryPreferred constructs a read preference with a SecondaryPreferredMode.

func (*ReadPref) MaxStaleness Uses

❖
func (r *ReadPref) MaxStaleness() (time.Duration, bool)

MaxStaleness is the maximum amount of time to allow a server to be considered eligible for selection. The second return value indicates if this value has been set.

func (*ReadPref) Mode Uses

❖
func (r *ReadPref) Mode() Mode

Mode indicates the mode of the read preference.

func (*ReadPref) TagSets Uses

❖
func (r *ReadPref) TagSets() []tag.Set

TagSets are multiple tag sets indicating which servers should be considered.

Package readpref imports 5 packages (graph) and is imported by 53 packages. Updated 2019-02-22. Refresh now. Tools for package owners.