Installing a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Marks this stream as aborted (will never push another data event)
and kills the underlying cursor. Will emit the 'end' event, and then
the 'close' event once the cursor is successfully killed.
// Connect using the MongoClient.connect static method
const MongoClient = require('mongodb').MongoClient;
const test = require('assert');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';
// Connect using MongoClient
MongoClient.connect(url, function(err, client) {
const db = client.db(dbName);
client.close();
});
Sets or gets the default captureRejection value for all emitters.
This symbol shall be used to install a listener for only monitoring 'error'
@@ -14,22 +14,22 @@
Installing a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Connect to MongoDB using a url
Return the mongo client logger
-Starts a new session on the server
-Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this cluster. Will ignore all changes to system collections, as well as the local, admin, and config databases.
@@ -46,17 +46,17 @@An array of aggregation pipeline stages through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
Optional settings for the command
-Runs a given operation with an implicitly created session. The lifetime of the session will be handled without the need for user interaction.
NOTE: presently the operation MUST return a Promise (either explicit or implicitly as an async function)
An callback to execute with an implicitly created session
-Connect to MongoDB using a url
Returns a copy of the array of listeners for the event named eventName.
For EventEmitters this behaves exactly the same as calling .listeners on
the emitter.
In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
allow to specify if there what fields we wish to return as unserialized raw buffer.
@@ -32,7 +32,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
serialize the javascript functions (default:false).
diff --git a/docs/Next/interfaces/AddUserOptions.html b/docs/Next/interfaces/AddUserOptions.html index 7e5293bc8fd..7c2dbe0a3a7 100644 --- a/docs/Next/interfaces/AddUserOptions.html +++ b/docs/Next/interfaces/AddUserOptions.html @@ -12,7 +12,7 @@Custom data associated with the user (only Mongodb 2.6 or higher)
Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -27,7 +27,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/AggregateOptions.html b/docs/Next/interfaces/AggregateOptions.html index 21f849cd11f..d36afcca736 100644 --- a/docs/Next/interfaces/AggregateOptions.html +++ b/docs/Next/interfaces/AggregateOptions.html @@ -17,7 +17,7 @@In server versions 4.4 and above, 'comment' can be any valid BSON type.
Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -40,7 +40,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/AggregationCursorOptions.html b/docs/Next/interfaces/AggregationCursorOptions.html index c5555391aa0..20f020185d1 100644 --- a/docs/Next/interfaces/AggregationCursorOptions.html +++ b/docs/Next/interfaces/AggregationCursorOptions.html @@ -22,7 +22,7 @@In server versions 4.4 and above, 'comment' can be any valid BSON type.
Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -47,7 +47,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/Auth.html b/docs/Next/interfaces/Auth.html index 7f5ce27f7e5..df8f50f0b7d 100644 --- a/docs/Next/interfaces/Auth.html +++ b/docs/Next/interfaces/Auth.html @@ -1,5 +1,5 @@ -Generated using TypeDoc
return BSON regular expressions as BSONRegExp instances.
the serializer will check if keys are valid.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
allow to specify if there what fields we wish to return as unserialized raw buffer.
@@ -16,7 +16,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
serialize the javascript functions (default:false).
diff --git a/docs/Next/interfaces/BulkWriteOptions.html b/docs/Next/interfaces/BulkWriteOptions.html index 7cbd1bd8ac4..dae2eea204a 100644 --- a/docs/Next/interfaces/BulkWriteOptions.html +++ b/docs/Next/interfaces/BulkWriteOptions.html @@ -11,7 +11,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -33,7 +33,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/ChangeStreamOptions.html b/docs/Next/interfaces/ChangeStreamOptions.html index cb056260880..dff677a252c 100644 --- a/docs/Next/interfaces/ChangeStreamOptions.html +++ b/docs/Next/interfaces/ChangeStreamOptions.html @@ -20,7 +20,7 @@In server versions 4.4 and above, 'comment' can be any valid BSON type.
Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -62,7 +62,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CollStatsOptions.html b/docs/Next/interfaces/CollStatsOptions.html index 6c340c5477a..f68eadea86d 100644 --- a/docs/Next/interfaces/CollStatsOptions.html +++ b/docs/Next/interfaces/CollStatsOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -24,7 +24,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CollectionOptions.html b/docs/Next/interfaces/CollectionOptions.html index 7389eb1ecc7..b99eac8706b 100644 --- a/docs/Next/interfaces/CollectionOptions.html +++ b/docs/Next/interfaces/CollectionOptions.html @@ -2,7 +2,7 @@return BSON regular expressions as BSONRegExp instances.
the serializer will check if keys are valid.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
allow to specify if there what fields we wish to return as unserialized raw buffer.
@@ -14,7 +14,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CommandOperationOptions.html b/docs/Next/interfaces/CommandOperationOptions.html index 8cfae6dfbc8..b685f1cd117 100644 --- a/docs/Next/interfaces/CommandOperationOptions.html +++ b/docs/Next/interfaces/CommandOperationOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -24,7 +24,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CountDocumentsOptions.html b/docs/Next/interfaces/CountDocumentsOptions.html index 28714c8bd6c..123fc656bfb 100644 --- a/docs/Next/interfaces/CountDocumentsOptions.html +++ b/docs/Next/interfaces/CountDocumentsOptions.html @@ -17,7 +17,7 @@In server versions 4.4 and above, 'comment' can be any valid BSON type.
Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -42,7 +42,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CountOptions.html b/docs/Next/interfaces/CountOptions.html index a2560931f0c..243b4e28db2 100644 --- a/docs/Next/interfaces/CountOptions.html +++ b/docs/Next/interfaces/CountOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -30,7 +30,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CreateCollectionOptions.html b/docs/Next/interfaces/CreateCollectionOptions.html index 69b71494cae..10e698ded66 100644 --- a/docs/Next/interfaces/CreateCollectionOptions.html +++ b/docs/Next/interfaces/CreateCollectionOptions.html @@ -17,7 +17,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
The number of seconds after which a document in a timeseries or clustered collection expires.
@@ -44,7 +44,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/CreateIndexesOptions.html b/docs/Next/interfaces/CreateIndexesOptions.html index 4412002bca7..05e8713fe3e 100644 --- a/docs/Next/interfaces/CreateIndexesOptions.html +++ b/docs/Next/interfaces/CreateIndexesOptions.html @@ -13,7 +13,7 @@In server versions 4.4 and above, 'comment' can be any valid BSON type.
(MongoDB 4.4. or higher) Specifies how many data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready. This option accepts the same values for the "w" field in a write concern plus "votingMembers", which indicates all voting data-bearing nodes.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)
@@ -40,7 +40,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/DbOptions.html b/docs/Next/interfaces/DbOptions.html index 008d17bbc7b..8e067c36133 100644 --- a/docs/Next/interfaces/DbOptions.html +++ b/docs/Next/interfaces/DbOptions.html @@ -4,7 +4,7 @@return BSON regular expressions as BSONRegExp instances.
the serializer will check if keys are valid.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
allow to specify if there what fields we wish to return as unserialized raw buffer.
@@ -20,7 +20,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/DbStatsOptions.html b/docs/Next/interfaces/DbStatsOptions.html index 8735f7edb0b..e93a6374c43 100644 --- a/docs/Next/interfaces/DbStatsOptions.html +++ b/docs/Next/interfaces/DbStatsOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -24,7 +24,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/DeleteOptions.html b/docs/Next/interfaces/DeleteOptions.html index a41dba1c2e4..f72736edda8 100644 --- a/docs/Next/interfaces/DeleteOptions.html +++ b/docs/Next/interfaces/DeleteOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -30,7 +30,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/DriverInfo.html b/docs/Next/interfaces/DriverInfo.html index 9a37fdd7661..e33e1adec57 100644 --- a/docs/Next/interfaces/DriverInfo.html +++ b/docs/Next/interfaces/DriverInfo.html @@ -1 +1 @@ -Generated using TypeDoc
Generated using TypeDoc
In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -24,7 +24,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/EstimatedDocumentCountOptions.html b/docs/Next/interfaces/EstimatedDocumentCountOptions.html index 73f3c95ab80..ad937cd6607 100644 --- a/docs/Next/interfaces/EstimatedDocumentCountOptions.html +++ b/docs/Next/interfaces/EstimatedDocumentCountOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -27,7 +27,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/EvalOptions.html b/docs/Next/interfaces/EvalOptions.html index fc7c67a1ac4..a780958cadf 100644 --- a/docs/Next/interfaces/EvalOptions.html +++ b/docs/Next/interfaces/EvalOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -24,7 +24,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/FindOneAndDeleteOptions.html b/docs/Next/interfaces/FindOneAndDeleteOptions.html index 49cfe467b8d..8e85ca4f21e 100644 --- a/docs/Next/interfaces/FindOneAndDeleteOptions.html +++ b/docs/Next/interfaces/FindOneAndDeleteOptions.html @@ -9,7 +9,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -30,7 +30,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/FindOneAndReplaceOptions.html b/docs/Next/interfaces/FindOneAndReplaceOptions.html index 50a5aded4c6..4ca37787126 100644 --- a/docs/Next/interfaces/FindOneAndReplaceOptions.html +++ b/docs/Next/interfaces/FindOneAndReplaceOptions.html @@ -11,7 +11,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -32,7 +32,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/FindOneAndUpdateOptions.html b/docs/Next/interfaces/FindOneAndUpdateOptions.html index f8bfefbd955..529d2b74e1a 100644 --- a/docs/Next/interfaces/FindOneAndUpdateOptions.html +++ b/docs/Next/interfaces/FindOneAndUpdateOptions.html @@ -13,7 +13,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -34,7 +34,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/FindOptions.html b/docs/Next/interfaces/FindOptions.html index a847b503d58..57afae2e005 100644 --- a/docs/Next/interfaces/FindOptions.html +++ b/docs/Next/interfaces/FindOptions.html @@ -19,7 +19,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -55,7 +55,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/InsertOneOptions.html b/docs/Next/interfaces/InsertOneOptions.html index 20885f6904c..d98b6ba92d3 100644 --- a/docs/Next/interfaces/InsertOneOptions.html +++ b/docs/Next/interfaces/InsertOneOptions.html @@ -11,7 +11,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -28,7 +28,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/ListCollectionsOptions.html b/docs/Next/interfaces/ListCollectionsOptions.html index 10c29ee483a..8b9352f12c8 100644 --- a/docs/Next/interfaces/ListCollectionsOptions.html +++ b/docs/Next/interfaces/ListCollectionsOptions.html @@ -13,7 +13,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -30,7 +30,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/ListDatabasesOptions.html b/docs/Next/interfaces/ListDatabasesOptions.html index 9337f3406d8..03ee45afd48 100644 --- a/docs/Next/interfaces/ListDatabasesOptions.html +++ b/docs/Next/interfaces/ListDatabasesOptions.html @@ -11,7 +11,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -30,7 +30,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/ListIndexesOptions.html b/docs/Next/interfaces/ListIndexesOptions.html index 22ae8924541..4f67c8e9bb8 100644 --- a/docs/Next/interfaces/ListIndexesOptions.html +++ b/docs/Next/interfaces/ListIndexesOptions.html @@ -11,7 +11,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -26,7 +26,7 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/MapReduceOptions.html b/docs/Next/interfaces/MapReduceOptions.html index 6fbe8fdf5a9..993e6de1784 100644 --- a/docs/Next/interfaces/MapReduceOptions.html +++ b/docs/Next/interfaces/MapReduceOptions.html @@ -11,7 +11,7 @@In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.
In server versions 4.4 and above, 'comment' can be any valid BSON type.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
Specifies the verbosity mode for the explain output.
@@ -38,7 +38,7 @@when deserializing will promote BSON values to their Node.js closest equivalent types.
Query filter object.
-Return BSON filled buffers from operations
Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)
diff --git a/docs/Next/interfaces/MongoClientOptions.html b/docs/Next/interfaces/MongoClientOptions.html index da5eb6f6061..4694c9f1b42 100644 --- a/docs/Next/interfaces/MongoClientOptions.html +++ b/docs/Next/interfaces/MongoClientOptions.html @@ -4,17 +4,17 @@An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
-The name of the application that created this MongoClient instance. MongoDB 3.4 and newer will print this value in the server log upon establishing each connection. It is also recorded in the slow query log and profile collections
-The auth settings for when connection to server.
-Specify the authentication mechanism that MongoDB will use to authenticate the connection.
-Specify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs.
-Specify the database name associated with the user’s credentials.
-Optionally enable client side auto encryption
An array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance.
-The time in milliseconds to attempt a connection before timing out.
PEM formatted CRLs (Certificate Revocation Lists).
-Allow a driver to force a Single topology type with a connection string containing one host
-Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver
A string describing a named curve or a colon separated list of curve @@ -81,22 +81,22 @@ recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
-Enable utf8 validation when deserializing BSON documents. Defaults to true.
allow to specify if there what fields we wish to return as unserialized raw buffer.
-Force server to assign _id values instead of driver
heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.
serialize will not emit undefined fields (default:true)
-The journal write concern
TCP Connection keep alive enabled
-The number of milliseconds to wait before initiating keepAlive on the TCP socket
Private keys in PEM format. PEM allows the option of private keys
@@ -107,29 +107,29 @@
passphrase:
Instruct the driver it is connecting to a load balancer fronting a mongos like service
-The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
-Custom logger object
-The logging level
-The maximum number of connections that may be in the process of being established concurrently by the connection pool.
-The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.
-The maximum number of connections in the connection pool.
-Specifies, in seconds, how stale a secondary can be before the client stops using it for read operations.
-Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.
-The minimum number of connections in the connection pool.
-Enable command monitoring for this client
-TCP Connection no delay
Shared passphrase used for a single private key and/or a PFX.
@@ -142,9 +142,9 @@ passphrase:A primary key factory function for generation of custom _id keys
A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
when deserializing a Binary will return it as a node.js Buffer instance.
@@ -152,34 +152,34 @@when deserializing a Long will fit it into a Number if it's smaller than 53 bits
when deserializing will promote BSON values to their Node.js closest equivalent types.
-Configures a Socks5 proxy host used for creating TCP connections.
-Configures a Socks5 proxy password when the proxy in proxyHost requires username/password authentication.
-Configures a Socks5 proxy port used for creating TCP connections.
-Configures a Socks5 proxy username when the proxy in proxyHost requires username/password authentication.
-Return document results as raw BSON buffers
-Specify a read concern for the collection (only MongoDB 3.2 or higher supported)
-The level of isolation
-Specifies the read preferences for this connection
-Specifies the tags document as a comma-separated list of colon-separated key-value pairs.
If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
Specifies the name of the replica set, if the mongod is a member of a replica set.
-Enables retryable reads.
-Enable retryable writes.
An optional TLS context object from tls.createSecureContext()
@@ -195,60 +195,60 @@ interoperability. Default: none, see minVersion.serialize the javascript functions (default:false).
-Server API version
-Specifies how long (in milliseconds) to block for server selection before throwing an exception.
-The time in milliseconds to attempt a send or receive on a socket before the attempt times out.
-The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts
Modifies the srv URI to look like:
_{srvServiceName}._tcp.{hostname}.{domainname}
Querying this DNS URI is expected to respond with SRV records
-A boolean to enable or disables TLS/SSL for the connection. (The ssl option is equivalent to the tls option.)
-SSL Certificate file path.
-SSL Certificate revocation list file path.
-SSL Certificate file path.
-SSL Key file file path.
-SSL Certificate pass phrase.
-Validate mongod server certificate against Certificate Authority
-Enables or disables TLS/SSL for the connection.
-Bypasses validation of the certificates presented by the mongod/mongos instance
-Disables hostname validation of the certificate presented by the mongod/mongos instance.
-Specifies the location of a local .pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the mongod/mongos instance.
-Specifies the location of a local TLS Certificate
-Specifies the location of a local .pem file that contains either the client's TLS/SSL certificate and key or only the client's TLS/SSL key when tlsCertificateFile is used to provide the certificate.
-Specifies the password to de-crypt the tlsCertificateKeyFile.
-Disables various certificate validations.
-The write concern w value
The maximum time in milliseconds that a thread can wait for a connection to become available.
-A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.
Generated using TypeDoc
An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
-Optionally enable client side auto encryption
The time in milliseconds to attempt a connection before timing out.
-PEM formatted CRLs (Certificate Revocation Lists).
-Allow a driver to force a Single topology type with a connection string containing one host
-Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver
A string describing a named curve or a colon separated list of curve @@ -64,13 +64,13 @@ recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
-Force server to assign _id values instead of driver
heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.
-TCP Connection keep alive enabled
-The number of milliseconds to wait before initiating keepAlive on the TCP socket
Private keys in PEM format. PEM allows the option of private keys
@@ -81,23 +81,23 @@
passphrase:
The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
-Custom logger object
-The maximum number of connections that may be in the process of being established concurrently by the connection pool.
-The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.
-The maximum number of connections in the connection pool.
-Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.
-The minimum number of connections in the connection pool.
-Enable command monitoring for this client
-TCP Connection no delay
Shared passphrase used for a single private key and/or a PFX.
@@ -110,22 +110,22 @@ passphrase:A primary key factory function for generation of custom _id keys
A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
-Return document results as raw BSON buffers
-If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
Specifies the name of the replica set, if the mongod is a member of a replica set.
-Enables retryable reads.
-Enable retryable writes.
An optional TLS context object from tls.createSecureContext()
@@ -139,17 +139,17 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion. -Specifies how long (in milliseconds) to block for server selection before throwing an exception.
-The time in milliseconds to attempt a send or receive on a socket before the attempt times out.
-The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts
Modifies the srv URI to look like:
_{srvServiceName}._tcp.{hostname}.{domainname}
Querying this DNS URI is expected to respond with SRV records
-Bypasses validation of the certificates presented by the mongod/mongos instance
-Disables hostname validation of the certificate presented by the mongod/mongos instance.
-Disables various certificate validations.
-The maximum time in milliseconds that a thread can wait for a connection to become available.
-An integer that specifies the compression level if using zlib for network compression.
Generated using TypeDoc