Documentation
¶
Overview ¶
Package readconcern defines read concerns for MongoDB operations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(concern *ReadConcern)
Option is an option to provide when creating a ReadConcern.
type ReadConcern ¶
type ReadConcern struct {
// contains filtered or unexported fields
}
ReadConcern for replica sets and replica set shards determines which data to return from a query.
func Available ¶
func Available() *ReadConcern
Available specifies that the query should return data from the instance with no guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back).
func Linearizable ¶
func Linearizable() *ReadConcern
Linearizable specifies that the query should return data that reflects all successful writes issued with a write concern of "majority" and acknowledged prior to the start of the read operation.
func Local ¶
func Local() *ReadConcern
Local specifies that the query should return the instance’s most recent data.
func Majority ¶
func Majority() *ReadConcern
Majority specifies that the query should return the instance’s most recent data acknowledged as having been written to a majority of members in the replica set.
func New ¶
func New(options ...Option) *ReadConcern
New constructs a new read concern from the given string.
func Snapshot ¶
func Snapshot() *ReadConcern
Snapshot is only available for operations within multi-document transactions.
func (*ReadConcern) GetLevel ¶
func (rc *ReadConcern) GetLevel() string
GetLevel returns the read concern level.
func (*ReadConcern) MarshalBSONValue ¶
func (rc *ReadConcern) MarshalBSONValue() (bsontype.Type, []byte, error)
MarshalBSONValue implements the bson.ValueMarshaler interface.
Source Files