Node.js MongoDB Driver API

Class: Mongos

Mongos

Creates a new Mongos instance

new Mongos(servers, options){Mongos}

lib/topologies/mongos.js, line 107
Name Type Description
servers Array.<Server>

A seedlist of servers participating in the replicaset.
options object 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.
poolSize number 5 optional

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

Cutoff latency point in MS for MongoS proxy selection
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 boolean false optional

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

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

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

Passed directly through to tls.createSecureContext. See https://nodejs.org/dist/latest-v9.x/docs/api/tls.html#tls_tls_createsecurecontext_options for more info.
ecdhCurve string optional

Passed directly through to tls.createSecureContext. See https://nodejs.org/dist/latest-v9.x/docs/api/tls.html#tls_tls_createsecurecontext_options for more info.
sslCert Buffer | string 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 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 optional

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

String containing the server name requested via TLS SNI.
socketOptions object optional

Socket options

Name Type Default Description
noDelay boolean true optional

TCP Socket NoDelay option.
keepAlive boolean true optional

TCP Connection keep alive enabled
keepAliveInitialDelay number 120000 optional

The number of milliseconds to wait before initiating keepAlive on the TCP socket
connectTimeoutMS number 10000 optional

How long to wait for a connection to be established before timing out
socketTimeoutMS number 0 optional

How long a send or receive on a socket can take before timing out
domainsEnabled boolean false optional

Enable the wrapping of the callback in the current domain, disabled by default to avoid perf hit.
monitorCommands boolean false optional

Enable command monitoring for this topology
Properties:
Name Type Description
parserType string

the parser type used (c++ or js).
Deprecated
  • Yes
Fires:
Returns:
Mongos instance.

Events

close

lib/topologies/mongos.js, line 397

Mongos close event

Type:
  • object

commandFailed

lib/topologies/mongos.js, line 439

An event emitted indicating a command failed, if command monitoring is enabled

Type:
  • object

commandStarted

lib/topologies/mongos.js, line 425

An event emitted indicating a command was started, if command monitoring is enabled

Type:
  • object

commandSucceeded

lib/topologies/mongos.js, line 432

An event emitted indicating a command succeeded, if command monitoring is enabled

Type:
  • object

connect

lib/topologies/mongos.js, line 347

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

Type:

error

lib/topologies/mongos.js, line 404

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

Type:

fullsetup

lib/topologies/mongos.js, line 383

Mongos fullsetup event, emitted when all proxies in the topology have been connected to.

Type:

ha

lib/topologies/mongos.js, line 354

The mongos 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

joined

lib/topologies/mongos.js, line 374

A server member joined the mongos set

Type:
  • function
Name Type Description
type string

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

The server object that joined

left

lib/topologies/mongos.js, line 365

A server member left the mongos set

Type:
  • function
Name Type Description
type string

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

The server object that left

open

lib/topologies/mongos.js, line 390

Mongos open event, emitted when mongos can start processing commands.

Type:

parseError

lib/topologies/mongos.js, line 418

Mongos parseError event

Type:
  • object

timeout

lib/topologies/mongos.js, line 411

Mongos timeout event

Type:
  • object