topology

Sep 17, 2024

Changes in this version

+ func ConvertCreds(cred *options.Credential) *driver.Cred

type Config

+ func NewConfigWithAuthenticator(co *options.ClientOptions, clock *session.ClusterClock, ...) (*Config, error)

type Connection

+ func (c *Connection) OIDCTokenGenID() uint64

+ func (c *Connection) SetOIDCTokenGenID(genID uint64)

Apr 12, 2024

Changes in this version

+ var BGReadCallback func(addr string, start, read time.Time, errs []error, connClosed bool)

+ var BGReadTimeout = 1 * time.Second

Jun 6, 2023

Changes in this version

type Connection

+ func (c *Connection) DriverConnectionID() uint64

Nov 2, 2022

retracted

Changes in this version

+ func ConvertToDriverAPIOptions(s *options.ServerAPIOptions) *driver.ServerAPIOptions

+ func ServerAPIFromServerOptions(opts []ServerOption) *driver.ServerAPIOptions

+ type Config struct

+ LoadBalanced bool

+ Mode MonitorMode

+ ReplicaSetName string

+ SRVMaxHosts int

+ SRVServiceName string

+ SeedList []string

+ ServerMonitor *event.ServerMonitor

+ ServerOpts []ServerOption

+ ServerSelectionTimeout time.Duration

+ URI string

+ func NewConfig(co *options.ClientOptions, clock *session.ClusterClock) (*Config, error)

type ConnectionOption

+ func WithHTTPClient(fn func(*http.Client) *http.Client) ConnectionOption

type Server

+ func (s *Server) RTTMonitor() driver.RTTMonitor

Jul 14, 2022

retracted

Changes in this version

type Server

+ func (s *Server) RTT90() time.Duration

Apr 5, 2022

Changes in this version

+ var ErrPoolClosed = PoolError("attempted to check out a connection from closed connection pool")

+ var ErrPoolNotPaused = PoolError("only a paused pool can be marked ready")

type Server

+ func (s *Server) OperationCount() int64

type ServerOption

+ func WithConnectionPoolMaintainInterval(fn func(time.Duration) time.Duration) ServerOption

Jan 4, 2022

Changes in this version

type ServerOption

+ func WithMaxConnecting(fn func(uint64) uint64) ServerOption

Nov 23, 2021

Changes in this version

type Connection

+ func (c Connection) ServerConnectionID() *int32

type Option

+ func WithSRVMaxHosts(fn func(int) int) Option

+ func WithSRVServiceName(fn func(string) string) Option

type Server

+ func (s *Server) MinRTT() time.Duration

Jul 12, 2021

retracted

Changes in this version

type Connection

+ func (c *Connection) PinToCursor() error

+ func (c *Connection) PinToTransaction() error

+ func (c *Connection) UnpinFromCursor() error

+ func (c *Connection) UnpinFromTransaction() error

type ConnectionOption

+ func WithConnectionLoadBalanced(fn func(bool) bool) ConnectionOption

type Option

+ func WithLoadBalanced(fn func(bool) bool) Option

type ServerOption

+ func WithServerAPI(fn func(serverAPI *driver.ServerAPIOptions) *driver.ServerAPIOptions) ServerOption

+ func WithServerLoadBalanced(fn func(bool) bool) ServerOption

type WaitQueueTimeoutError

+ PinnedCursorConnections uint64

+ PinnedTransactionConnections uint64

Mar 9, 2021 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type Option

+ func WithTopologyServerMonitor(fn func(*event.ServerMonitor) *event.ServerMonitor) Option

type ServerOption

+ func WithServerMonitor(fn func(*event.ServerMonitor) *event.ServerMonitor) ServerOption

+ type ServerSelectionError struct

+ Desc description.Topology

+ Wrapped error

+ func (e ServerSelectionError) Error() string

+ func (e ServerSelectionError) Unwrap() error

Dec 16, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Mar 9, 2021 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

+ const MinSupportedMongoDBVersion

+ var SupportedWireVersions = description.NewVersionRange(2, 9)

Feb 2, 2021 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

+ type WaitQueueTimeoutError struct

+ Wrapped error

+ func (w WaitQueueTimeoutError) Error() string

+ func (w WaitQueueTimeoutError) Unwrap() error

Jan 19, 2021 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Dec 1, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Nov 3, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Oct 7, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Sep 1, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Jul 30, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type Connection

+ func (c *Connection) Stale() bool

type ConnectionError

+ func (e ConnectionError) Unwrap() error

type ConnectionOption

+ func WithDisableOCSPEndpointCheck(fn func(bool) bool) ConnectionOption

+ func WithOCSPCache(fn func(ocsp.Cache) ocsp.Cache) ConnectionOption

Jul 13, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Jun 9, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Apr 10, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Aug 10, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Aug 4, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Jul 8, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type Server

+ func (s *Server) ProcessHandshakeError(err error)

Jun 3, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

May 5, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Apr 7, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Mar 3, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type Option

+ func WithURI(fn func(string) string) Option

Feb 5, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Jan 8, 2020 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Dec 10, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type ConnectionOption

+ func WithConnectionAppName(fn func(string) string) ConnectionOption

+ func WithZstdLevel(fn func(*int) *int) ConnectionOption

type ServerOption

+ func WithServerAppName(fn func(string) string) ServerOption

type Topology

+ func (t *Topology) Unsubscribe(sub *driver.Subscription) error

Dec 17, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Nov 5, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Oct 7, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Sep 5, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Aug 13, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

+ var ErrConnectionClosed = ConnectionError

+ var ErrPoolConnected = PoolError("attempted to Connect to an already connected pool")

+ var ErrPoolDisconnected = PoolError("attempted to check out a connection from closed connection pool")

+ var ErrWaitQueueTimeout = PoolError("timed out while checking out a connection from connection pool")

+ var ErrWrongPool = PoolError("connection does not belong to this pool")

+ type Connection struct

+ func (c *Connection) Address() address.Address

+ func (c *Connection) Alive() bool

+ func (c *Connection) Close() error

+ func (c *Connection) CompressWireMessage(src, dst []byte) ([]byte, error)

+ func (c *Connection) Description() description.Server

+ func (c *Connection) Expire() error

+ func (c *Connection) ID() string

+ func (c *Connection) LocalAddress() address.Address

+ func (c *Connection) ReadWireMessage(ctx context.Context, dst []byte) ([]byte, error)

+ func (c *Connection) WriteWireMessage(ctx context.Context, wm []byte) error

+ type ConnectionError struct

+ ConnectionID string

+ Wrapped error

+ func (e ConnectionError) Error() string

+ type ConnectionOption func(*connectionConfig) error

+ func WithAppName(fn func(string) string) ConnectionOption

+ func WithCompressors(fn func([]string) []string) ConnectionOption

+ func WithConnectTimeout(fn func(time.Duration) time.Duration) ConnectionOption

+ func WithDialer(fn func(Dialer) Dialer) ConnectionOption

+ func WithHandshaker(fn func(Handshaker) Handshaker) ConnectionOption

+ func WithIdleTimeout(fn func(time.Duration) time.Duration) ConnectionOption

+ func WithLifeTimeout(fn func(time.Duration) time.Duration) ConnectionOption

+ func WithMonitor(fn func(*event.CommandMonitor) *event.CommandMonitor) ConnectionOption

+ func WithReadTimeout(fn func(time.Duration) time.Duration) ConnectionOption

+ func WithTLSConfig(fn func(*tls.Config) *tls.Config) ConnectionOption

+ func WithWriteTimeout(fn func(time.Duration) time.Duration) ConnectionOption

+ func WithZlibLevel(fn func(*int) *int) ConnectionOption

+ type Dialer interface

+ DialContext func(ctx context.Context, network, address string) (net.Conn, error)

+ var DefaultDialer Dialer = &net.Dialer{}

+ type DialerFunc func(ctx context.Context, network, address string) (net.Conn, error)

+ func (df DialerFunc) DialContext(ctx context.Context, network, address string) (net.Conn, error)

+ type Handshaker = driver.Handshaker

+ type HandshakerFunc = driver.HandshakerFunc

+ type PoolError string

+ func (pe PoolError) Error() string

type Server

+ func (s *Server) ProcessError(err error)

type ServerOption

+ func WithConnectionPoolMaxIdleTime(fn func(time.Duration) time.Duration) ServerOption

+ func WithConnectionPoolMonitor(fn func(*event.PoolMonitor) *event.PoolMonitor) ServerOption

+ func WithMinConnections(fn func(uint64) uint64) ServerOption

type Topology

+ func (t *Topology) Kind() description.TopologyKind

+ func (t *Topology) SelectServerLegacy(ctx context.Context, ss description.ServerSelector) (*SelectedServer, error)

+ func (t *Topology) SupportsRetryWrites() bool

Jul 9, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Jun 6, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

May 16, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Apr 18, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Mar 13, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type Server

+ func (s *Server) ProcessWriteConcernError(err *result.WriteConcernError)

Mar 7, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Feb 22, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Feb 1, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

type Server

+ func (s *Server) String() string

type Topology

+ func (t *Topology) String() string

Jan 8, 2019 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

+ func NewListCollectionsCursor(c command.Cursor) command.Cursor

type Server

+ func (s *Server) BuildLegacyCursor(ns command.Namespace, cursorID int64, batch []bson.Raw, limit int32, ...) (command.Cursor, error)

Dec 6, 2018 GO-2021-0112

  GO-2021-0112: Improper input validation in go.mongodb.org/mongo-driver

Changes in this version

+ var ErrServerClosed = errors.New("server is closed")

+ var ErrServerConnected = errors.New("server is connected")

+ var ErrServerSelectionTimeout = errors.New("server selection timeout")

+ var ErrSubscribeAfterClosed = errors.New("cannot subscribe after close")

+ var ErrTopologyClosed = errors.New("topology is closed")

+ var ErrTopologyConnected = errors.New("topology is connected or connecting")

+ type MonitorMode uint8

+ const AutomaticMode

+ const SingleMode

+ type Option func(*config) error

+ func WithConnString(fn func(connstring.ConnString) connstring.ConnString) Option

+ func WithMode(fn func(MonitorMode) MonitorMode) Option

+ func WithReplicaSetName(fn func(string) string) Option

+ func WithSeedList(fn func(...string) []string) Option

+ func WithServerOptions(fn func(...ServerOption) []ServerOption) Option

+ func WithServerSelectionTimeout(fn func(time.Duration) time.Duration) Option

+ type SelectedServer struct

+ Kind description.TopologyKind

+ func (ss *SelectedServer) Description() description.SelectedServer

+ type Server struct

+ func ConnectServer(ctx context.Context, addr address.Address, opts ...ServerOption) (*Server, error)

+ func NewServer(addr address.Address, opts ...ServerOption) (*Server, error)

+ func (s *Server) BuildCursor(result bson.Raw, clientSession *session.Client, clock *session.ClusterClock, ...) (command.Cursor, error)

+ func (s *Server) Connect(ctx context.Context) error

+ func (s *Server) Connection(ctx context.Context) (connection.Connection, error)

+ func (s *Server) Description() description.Server

+ func (s *Server) Disconnect(ctx context.Context) error

+ func (s *Server) Drain() error

+ func (s *Server) RequestImmediateCheck()

+ func (s *Server) SelectedDescription() description.SelectedServer

+ func (s *Server) Subscribe() (*ServerSubscription, error)

+ type ServerOption func(*serverConfig) error

+ func WithClock(fn func(clock *session.ClusterClock) *session.ClusterClock) ServerOption

+ func WithCompressionOptions(fn func(...string) []string) ServerOption

+ func WithConnectionOptions(fn func(...connection.Option) []connection.Option) ServerOption

+ func WithHeartbeatInterval(fn func(time.Duration) time.Duration) ServerOption

+ func WithHeartbeatTimeout(fn func(time.Duration) time.Duration) ServerOption

+ func WithMaxConnections(fn func(uint16) uint16) ServerOption

+ func WithMaxIdleConnections(fn func(uint16) uint16) ServerOption

+ func WithRegistry(fn func(*bsoncodec.Registry) *bsoncodec.Registry) ServerOption

+ type ServerSubscription struct

+ C <-chan description.Server

+ func (ss *ServerSubscription) Unsubscribe() error

+ type Subscription struct

+ C <-chan description.Topology

+ func (s *Subscription) Unsubscribe() error

+ type Topology struct

+ SessionPool *session.Pool

+ func New(opts ...Option) (*Topology, error)

+ func (t *Topology) Connect(ctx context.Context) error

+ func (t *Topology) Description() description.Topology

+ func (t *Topology) Disconnect(ctx context.Context) error

+ func (t *Topology) FindServer(selected description.Server) (*SelectedServer, error)

+ func (t *Topology) RequestImmediateCheck()

+ func (t *Topology) SelectServer(ctx context.Context, ss description.ServerSelector) (*SelectedServer, error)

+ func (t *Topology) Subscribe() (*Subscription, error)

+ func (t *Topology) SupportsSessions() bool