import "go.mongodb.org/mongo-driver/mongo/readpref"
mode.go options.go readpref.go
ErrInvalidTagSet indicates that an invalid set of tags was specified.
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
ModeFromString returns a mode corresponding to mode.
IsValid checks whether the mode is valid.
String returns the string representation of mode.
Option configures a read preference
WithHedgeEnabled specifies whether or not hedged reads should be enabled in the server. This feature requires MongoDB server version 4.4 or higher. For more information about hedged reads, see https://docs.mongodb.com/master/core/sharded-cluster-query-router/#mongos-hedged-reads. If not specified, the default is to not send a value to the server, which will result in the server defaults being used.
WithMaxStaleness sets the maximum staleness a server is allowed.
WithTagSets sets the tag sets used to match a server. The last call to WithTags or WithTagSets overrides all previous calls to either method.
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 struct {
// contains filtered or unexported fields
}ReadPref determines which servers are considered suitable for read operations.
Nearest constructs a read preference with a NearestMode.
New creates a new ReadPref.
Primary constructs a read preference with a PrimaryMode.
PrimaryPreferred constructs a read preference with a PrimaryPreferredMode.
Secondary constructs a read preference with a SecondaryMode.
SecondaryPreferred constructs a read preference with a SecondaryPreferredMode.
HedgeEnabled returns whether or not hedged reads are enabled for this read preference. If this option was not specified during read preference construction, nil is returned.
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.
Mode indicates the mode of the read preference.
String returns a human-readable description of the read preference.
TagSets are multiple tag sets indicating which servers should be considered.
Package readpref imports 6 packages (graph) and is imported by 124 packages. Updated 2020-09-19. Refresh now. Tools for package owners.