Skip to content

Commit c8e946d

Browse files
HanaPearlmanHanaPearlman
committed
use bold deprecation docs and include journal in WC
1 parent 75caa8d commit c8e946d

File tree

10 files changed

+124
-126
lines changed

10 files changed

+124
-126
lines changed

‎lib/admin.js

+8-8
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,10 @@ Admin.prototype.ping = function(options, callback) {
166166
* @param {string} username The username.
167167
* @param {string} password The password.
168168
* @param {object} [options] Optional settings.
169-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
170-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
171-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
172-
* @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
169+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
170+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
171+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
172+
* @param {boolean} [options.fsync=false] **Deprecated** Specify a file sync write concern. Use writeConcern instead.
173173
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
174174
* @param {object} [options.customData] Custom data associated with the user (only Mongodb 2.6 or higher)
175175
* @param {object[]} [options.roles] Roles associated with the created user (only Mongodb 2.6 or higher)
@@ -204,10 +204,10 @@ Admin.prototype.addUser = function(username, password, options, callback) {
204204
* @method
205205
* @param {string} username The username.
206206
* @param {object} [options] Optional settings.
207-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
208-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
209-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
210-
* @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
207+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
208+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
209+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
210+
* @param {boolean} [options.fsync=false] **Deprecated** Specify a file sync write concern. Use writeConcern instead.
211211
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
212212
* @param {ClientSession} [options.session] optional session to use for this operation
213213
* @param {Admin~resultCallback} [callback] The command result callback

‎lib/bulk/common.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -1125,10 +1125,10 @@ class BulkOperationBase {
11251125
* @method
11261126
* @param {WriteConcern} [_writeConcern] Optional write concern. Can also be specified through options.
11271127
* @param {object} [options] Optional settings.
1128-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
1129-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
1130-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
1131-
* @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
1128+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
1129+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
1130+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
1131+
* @param {boolean} [options.fsync=false] **Deprecated** Specify a file sync write concern. Use writeConcern instead.
11321132
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
11331133
* @param {BulkOperationBase~resultCallback} [callback] A callback that will be invoked when bulkWrite finishes/errors
11341134
* @throws {MongoError} Throws error if the bulk object has already been executed

‎lib/collection.js

+60-60
Large diffs are not rendered by default.

‎lib/db.js

+24-24
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ const legalOptionNames = [
106106
* @param {(Server|ReplSet|Mongos)} topology The server topology for the database.
107107
* @param {object} [options] Optional settings.
108108
* @param {string} [options.authSource] If the database authentication is dependent on another databaseName.
109-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
110-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
111-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
109+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
110+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
111+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
112112
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
113113
* @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver.
114114
* @param {boolean} [options.serializeFunctions=false] Serialize functions on any object.
@@ -401,9 +401,9 @@ const collectionKeys = [
401401
* @method
402402
* @param {string} name the collection name we wish to access.
403403
* @param {object} [options] Optional settings.
404-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
405-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
406-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
404+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
405+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
406+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
407407
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
408408
* @param {boolean} [options.raw=false] Return document results as raw BSON buffers.
409409
* @param {object} [options.pkFactory] A primary key factory object for generation of custom _id keys.
@@ -496,9 +496,9 @@ Db.prototype.collection = function(name, options, callback) {
496496
* @method
497497
* @param {string} name the collection name we wish to access.
498498
* @param {object} [options] Optional settings.
499-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
500-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
501-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
499+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
500+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
501+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
502502
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
503503
* @param {boolean} [options.raw=false] Return document results as raw BSON buffers.
504504
* @param {object} [options.pkFactory] A primary key factory object for generation of custom _id keys.
@@ -655,9 +655,9 @@ Db.prototype.renameCollection = function(fromCollection, toCollection, options,
655655
* @method
656656
* @param {string} name Name of collection to drop
657657
* @param {Object} [options] Optional settings
658-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
659-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
660-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
658+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
659+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
660+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
661661
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
662662
* @param {ClientSession} [options.session] optional session to use for this operation
663663
* @param {Db~resultCallback} [callback] The results callback
@@ -738,9 +738,9 @@ Db.prototype.executeDbAdminCommand = function(selector, options, callback) {
738738
* @param {string} name Name of the collection to create the index on.
739739
* @param {(string|object)} fieldOrSpec Defines the index.
740740
* @param {object} [options] Optional settings.
741-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
742-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
743-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
741+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
742+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
743+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
744744
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
745745
* @param {boolean} [options.unique=false] Creates an unique index.
746746
* @param {boolean} [options.sparse=false] Creates a sparse index.
@@ -773,9 +773,9 @@ Db.prototype.createIndex = function(name, fieldOrSpec, options, callback) {
773773
* @param {string} name The index name
774774
* @param {(string|object)} fieldOrSpec Defines the index.
775775
* @param {object} [options] Optional settings.
776-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
777-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
778-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
776+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
777+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
778+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
779779
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
780780
* @param {boolean} [options.unique=false] Creates an unique index.
781781
* @param {boolean} [options.sparse=false] Creates a sparse index.
@@ -814,9 +814,9 @@ Db.prototype.addChild = function(db) {
814814
* @param {string} username The username.
815815
* @param {string} password The password.
816816
* @param {object} [options] Optional settings.
817-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
818-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
819-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
817+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
818+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
819+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
820820
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
821821
* @param {object} [options.customData] Custom data associated with the user (only Mongodb 2.6 or higher)
822822
* @param {object[]} [options.roles] Roles associated with the created user (only Mongodb 2.6 or higher)
@@ -844,9 +844,9 @@ Db.prototype.addUser = function(username, password, options, callback) {
844844
* @method
845845
* @param {string} username The username.
846846
* @param {object} [options] Optional settings.
847-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
848-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
849-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
847+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
848+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
849+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
850850
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
851851
* @param {ClientSession} [options.session] optional session to use for this operation
852852
* @param {Db~resultCallback} [callback] The command result callback

‎lib/gridfs-stream/upload.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ module.exports = GridFSBucketWriteStream;
2222
* @param {object} [options] Optional settings.
2323
* @param {string|number|object} [options.id] Custom file id for the GridFS file.
2424
* @param {number} [options.chunkSizeBytes] The chunk size to use, in bytes
25-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
26-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
27-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
25+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
26+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
27+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
2828
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
2929
* @param {boolean} [options.disableMD5=false] If true, disables adding an md5 field to file data
3030
* @fires GridFSBucketWriteStream#error

‎lib/gridfs/grid_store.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ const deprecationFn = deprecate(() => {},
7373
* @param {string} [filename] optional filename for this file, no unique constrain on the field
7474
* @param {string} mode set the mode for this file.
7575
* @param {object} [options] Optional settings.
76-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
77-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
78-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
79-
* @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
76+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
77+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
78+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
79+
* @param {boolean} [options.fsync=false] **Deprecated** Specify a file sync write concern. Use writeConcern instead.
8080
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
8181
* @param {string} [options.root] Root collection to use. Defaults to **{GridStore.DEFAULT_ROOT_COLLECTION}**.
8282
* @param {string} [options.content_type] MIME type of the file. Defaults to **{GridStore.DEFAULT_CONTENT_TYPE}**.

‎lib/mongo_client.js

+8-8
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ const validOptions = require('./operations/connect').validOptions;
109109
* @param {number} [options.acceptableLatencyMS=15] Cutoff latency point in MS for Mongos proxies selection
110110
* @param {boolean} [options.connectWithNoPrimary=false] Sets if the driver should connect even if no primary is available
111111
* @param {string} [options.authSource=undefined] Define the database to authenticate against
112-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
113-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
114-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
115-
* @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
112+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
113+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
114+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
115+
* @param {boolean} [options.fsync=false] **Deprecated** Specify a file sync write concern. Use writeConcern instead.
116116
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
117117
* @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver
118118
* @param {boolean} [options.serializeFunctions=false] Serialize functions on any object
@@ -385,10 +385,10 @@ MongoClient.prototype.isConnected = function(options) {
385385
* @param {number} [options.acceptableLatencyMS=15] Cutoff latency point in MS for Mongos proxies selection
386386
* @param {boolean} [options.connectWithNoPrimary=false] Sets if the driver should connect even if no primary is available
387387
* @param {string} [options.authSource=undefined] Define the database to authenticate against
388-
* @param {(number|string)} [options.w] DEPRECATED: The write concern. Use writeConcern instead.
389-
* @param {number} [options.wtimeout] DEPRECATED: The write concern timeout. Use writeConcern instead.
390-
* @param {boolean} [options.j=false] DEPRECATED: Specify a journal write concern. Use writeConcern instead.
391-
* @param {boolean} [options.fsync=false] DEPRECATED: Specify a file sync write concern. Use writeConcern instead.
388+
* @param {(number|string)} [options.w] **Deprecated** The write concern. Use writeConcern instead.
389+
* @param {number} [options.wtimeout] **Deprecated** The write concern timeout. Use writeConcern instead.
390+
* @param {boolean} [options.j=false] **Deprecated** Specify a journal write concern. Use writeConcern instead.
391+
* @param {boolean} [options.fsync=false] **Deprecated** Specify a file sync write concern. Use writeConcern instead.
392392
* @param {object|WriteConcern} [options.writeConcern] Specify write concern settings.
393393
* @param {boolean} [options.forceServerObjectId=false] Force server to assign _id values instead of driver
394394
* @param {boolean} [options.serializeFunctions=false] Serialize functions on any object

‎lib/operations/connect.js

+2-9
Original file line numberDiff line numberDiff line change
@@ -302,13 +302,6 @@ function connect(mongoClient, url, options, callback) {
302302
delete _finalOptions.db_options.auth;
303303
}
304304

305-
// `journal` should be translated to `j` for the driver
306-
if (_finalOptions.journal != null) {
307-
if (_finalOptions.writeConcern == null) _finalOptions.writeConcern = {};
308-
_finalOptions.writeConcern.j = _finalOptions.journal;
309-
_finalOptions.journal = undefined;
310-
}
311-
312305
// resolve tls options if needed
313306
resolveTLSOptions(_finalOptions);
314307

@@ -619,7 +612,7 @@ function createUnifiedOptions(finalOptions, options) {
619612
'mongos_options'
620613
];
621614
const noMerge = ['readconcern', 'compression', 'autoencryption'];
622-
const skip = ['w', 'wtimeout', 'j', 'fsync', 'writeConcern'];
615+
const skip = ['w', 'wtimeout', 'j', 'journal', 'fsync', 'writeConcern'];
623616

624617
for (const name in options) {
625618
if (skip.indexOf(name.toLowerCase()) !== -1) {
@@ -783,7 +776,7 @@ function transformUrlOptions(_object) {
783776

784777
// Any write concern options from the URL will be top-level, so we manually
785778
// move them options under `object.writeConcern` to avoid warnings later
786-
const wcKeys = ['w', 'wtimeout', 'j', 'fsync'];
779+
const wcKeys = ['w', 'wtimeout', 'j', 'journal', 'fsync'];
787780
for (const key of wcKeys) {
788781
if (object[key] !== undefined) {
789782
if (object.writeConcern === undefined) object.writeConcern = {};

0 commit comments

Comments
 (0)