Class: ReplSet

ReplSet

new ReplSet(servers, options){ReplSet}

Creates a new ReplSet instance

Name Type Default Description
servers Array.<Server>

A seedlist of servers participating in the replicaset.

options object null optional

Optional settings.

Name Type Default Description
ha booelan true optional

Turn on high availability monitoring.

haInterval number 5000 optional

Time between each replicaset status check.

replicaSet string

The name of the replicaset to connect to.

secondaryAcceptableLatencyMS number 15 optional

Sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms)

connectWithNoPrimary boolean false optional

Sets if the driver should connect even if no primary is available

poolSize number 5 optional

Number of connections in the connection pool for each server instance, set to 5 as default for legacy reasons.

ssl boolean false optional

Use ssl connection (needs to have a mongod server with ssl support)

checkServerIdentity boolean | function true optional

Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.

sslValidate object true optional

Validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher)

sslCA array null optional

Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher)

sslCert Buffer | string null optional

String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)

sslKey Buffer | string null optional

String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher)

sslPass Buffer | string null optional

String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher)

socketOptions object null optional

Socket options

Name Type Default Description
noDelay boolean true optional

TCP Socket NoDelay option.

keepAlive number 0 optional

TCP KeepAlive on the socket with a X ms delay before start.

connectTimeoutMS number 0 optional

TCP Connection timeout setting

socketTimeoutMS number 0 optional

TCP Socket timeout setting

Deprecated
  • Yes
Fires:
Returns:
ReplSet instance.

Methods

connections(){array}

All raw connections

Events

ReplSet close event

Type:
  • object

A replset connect event, used to verify that the connection is up and running

Type:

ReplSet error event, emitted if there is an error listener.

Type:

ReplSet fullsetup event, emitted when all servers in the topology have been connected to.

Type:
  • Replset

The replset high availability event

Type:
  • function
Name Type Description
type string

The stage in the high availability event (start|end)

data.norepeat boolean

This is a repeating high availability process or a single execution only

data.id number

The id for this high availability request

data.state object

An object containing the information about the current replicaset

A server member joined the replicaset

Type:
  • function
Name Type Description
type string

The type of member that joined (primary|secondary|arbiter)

server Server

The server object that joined

A server member left the replicaset

Type:
  • function
Name Type Description
type string

The type of member that left (primary|secondary|arbiter)

server Server

The server object that left

ReplSet open event, emitted when replicaset can start processing commands.

Type:
  • Replset

parseError

ReplSet parseError event

Type:
  • object

ReplSet timeout event

Type:
  • object
comments powered by Disqus