From 7b10e25ed777e673ca15afd103a93531f06fcd76 Mon Sep 17 00:00:00 2001 From: Michael Zabka Date: Mon, 22 Jul 2019 16:27:02 +0200 Subject: [PATCH] docs(ChangeStream): fix name of stream changes watch option startAtOperationTime - it was changed during alpha, beta testing from startAtClusterTime to startAtOperationTime, but JSDocs keeps old option name. - related to api ref docs: https://mongodb.github.io/mongo-java-driver/3.8/javadoc/com/mongodb/client/ChangeStreamIterable.html - related to specs: https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst --- lib/collection.js | 2 +- lib/db.js | 2 +- lib/mongo_client.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/collection.js b/lib/collection.js index ede947efcf..2f8f23e761 100644 --- a/lib/collection.js +++ b/lib/collection.js @@ -1740,7 +1740,7 @@ Collection.prototype.aggregate = function(pipeline, options, callback) { * @param {number} [options.batchSize] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. * @param {object} [options.collation] Specify collation settings for operation. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. * @param {ReadPreference} [options.readPreference] The read preference. Defaults to the read preference of the database or collection. See {@link https://docs.mongodb.com/manual/reference/read-preference|read preference documentation}. - * @param {Timestamp} [options.startAtClusterTime] receive change events that occur after the specified timestamp + * @param {Timestamp} [options.startAtOperationTime] receive change events that occur after the specified timestamp * @param {ClientSession} [options.session] optional session to use for this operation * @return {ChangeStream} a ChangeStream instance. */ diff --git a/lib/db.js b/lib/db.js index c105eda00e..2b04ed4aee 100644 --- a/lib/db.js +++ b/lib/db.js @@ -988,7 +988,7 @@ Db.prototype.unref = function() { * @param {number} [options.batchSize] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. * @param {object} [options.collation] Specify collation settings for operation. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. * @param {ReadPreference} [options.readPreference] The read preference. Defaults to the read preference of the database. See {@link https://docs.mongodb.com/manual/reference/read-preference|read preference documentation}. - * @param {Timestamp} [options.startAtClusterTime] receive change events that occur after the specified timestamp + * @param {Timestamp} [options.startAtOperationTime] receive change events that occur after the specified timestamp * @param {ClientSession} [options.session] optional session to use for this operation * @return {ChangeStream} a ChangeStream instance. */ diff --git a/lib/mongo_client.js b/lib/mongo_client.js index 49d02981ed..53cea468a4 100644 --- a/lib/mongo_client.js +++ b/lib/mongo_client.js @@ -420,7 +420,7 @@ MongoClient.prototype.withSession = function(options, operation) { * @param {number} [options.batchSize] The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. * @param {object} [options.collation] Specify collation settings for operation. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. * @param {ReadPreference} [options.readPreference] The read preference. See {@link https://docs.mongodb.com/manual/reference/read-preference|read preference documentation}. - * @param {Timestamp} [options.startAtClusterTime] receive change events that occur after the specified timestamp + * @param {Timestamp} [options.startAtOperationTime] receive change events that occur after the specified timestamp * @param {ClientSession} [options.session] optional session to use for this operation * @return {ChangeStream} a ChangeStream instance. */