readconcern

package
v2.0.0-beta1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 26, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package readconcern defines read concerns for MongoDB operations.

For more information about MongoDB read concerns, see https://www.mongodb.com/docs/manual/reference/read-concern/

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ReadConcern

type ReadConcern struct {
	Level string
}

A ReadConcern defines a MongoDB read concern, which allows you to control the consistency and isolation properties of the data read from replica sets and replica set shards.

For more information about MongoDB read concerns, see https://www.mongodb.com/docs/manual/reference/read-concern/

func Available

func Available() *ReadConcern

Available returns a ReadConcern that requests data from an instance with no guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back).

For more information about read concern "available", see https://www.mongodb.com/docs/manual/reference/read-concern-available/

func Linearizable

func Linearizable() *ReadConcern

Linearizable returns a ReadConcern that requests data that reflects all successful majority-acknowledged writes that completed prior to the start of the read operation.

For more information about read concern "linearizable", see https://www.mongodb.com/docs/manual/reference/read-concern-linearizable/

func Local

func Local() *ReadConcern

Local returns a ReadConcern that requests 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).

For more information about read concern "local", see https://www.mongodb.com/docs/manual/reference/read-concern-local/

func Majority

func Majority() *ReadConcern

Majority returns a ReadConcern that requests data that has been acknowledged by a majority of the replica set members (i.e. the documents read are durable and guaranteed not to roll back).

For more information about read concern "majority", see https://www.mongodb.com/docs/manual/reference/read-concern-majority/

func Snapshot

func Snapshot() *ReadConcern

Snapshot returns a ReadConcern that requests majority-committed data as it appears across shards from a specific single point in time in the recent past.

For more information about read concern "snapshot", see https://www.mongodb.com/docs/manual/reference/read-concern-snapshot/

func (*ReadConcern) MarshalBSONValue deprecated

func (rc *ReadConcern) MarshalBSONValue() (bson.Type, []byte, error)

MarshalBSONValue implements the bson.ValueMarshaler interface.

Deprecated: Marshaling a ReadConcern to BSON will not be supported in Go Driver 2.0.

Jump to

Keyboard shortcuts

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