readconcern

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

• type Option
  • func Level(level string) Option
• type ReadConcern
  • func Available() *ReadConcern
  • func Linearizable() *ReadConcern
  • func Local() *ReadConcern
  • func Majority() *ReadConcern
  • func New(options ...Option) *ReadConcern
  • func Snapshot() *ReadConcern
  • func (rc *ReadConcern) GetLevel() string
  • func (rc *ReadConcern) MarshalBSONValue() (bsontype.Type, []byte, error)

Types

type Option

type Option func(concern *ReadConcern)

Option is an option to provide when creating a ReadConcern.

Deprecated: Use the ReadConcern literal declaration instead. For example:

&readconcern.ReadConcern{Level: "local"}

func Level

func Level(level string) Option

Level creates an option that sets the level of a ReadConcern.

Deprecated: Use the ReadConcern literal declaration instead. For example:

&readconcern.ReadConcern{Level: "local"}

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 New

func New(options ...Option) *ReadConcern

New constructs a new read concern from the given string.

Deprecated: Use the ReadConcern literal declaration instead. For example:

&readconcern.ReadConcern{Level: "local"}

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) GetLevel

func (rc *ReadConcern) GetLevel() string

GetLevel returns the read concern level.

Deprecated: Use the ReadConcern.Level field instead.

func (*ReadConcern) MarshalBSONValue

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

MarshalBSONValue implements the bson.ValueMarshaler interface.

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