Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(i18n): Add missing options parameter for find and findOne MONGOSH-1697 #2210

Merged
merged 1 commit into from
Oct 11, 2024
Merged

fix(i18n): Add missing options parameter for find and findOne MONGOSH-1697 #2210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 61 additions & 42 deletions packages/i18n/src/locales/en_US.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ const translations: Catalog = {
find: {
link: 'https://docs.mongodb.com/manual/reference/method/db.collection.find',
description: 'Selects documents in a collection or view.',
example: 'db.collection.find(query, projection)',
example: 'db.collection.find(query, projection, options)',
},
findAndModify: {
link: 'https://docs.mongodb.com/manual/reference/method/db.collection.findAndModify',
Expand All @@ -530,7 +530,7 @@ const translations: Catalog = {
findOne: {
link: 'https://docs.mongodb.com/manual/reference/method/db.collection.findOne',
description: 'Selects documents in a collection or view.',
example: 'db.collection.findOne(query, projection)',
example: 'db.collection.findOne(query, projection, options)',
},
findOneAndDelete: {
link: 'https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndDelete',
Expand Down Expand Up @@ -899,122 +899,134 @@ const translations: Catalog = {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.addOption',
description:
'Adds OP_QUERY wire protocol flags, such as the tailable flag, to change the behavior of queries. Accepts: DBQuery.Option fields tailable, slaveOk, noTimeout, awaitData, exhaust, partial.',
example: 'db.collection.find(query, projection).addOption(flag)',
example:
'db.collection.find(query, projection, options).addOption(flag)',
},
allowPartialResults: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.allowPartialResults',
description: "Sets the 'partial' option to true.",
example:
'db.collection.find(query, projection).allowPartialResults()',
'db.collection.find(query, projection, options).allowPartialResults()',
},
allowDiskUse: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.allowDiskUse',
description:
"Sets the 'allowDiskUse' option. If no argument is passed, the default is true.",
example:
'db.collection.find(query, projection).sort(sort).allowDiskUse(false)',
'db.collection.find(query, projection, options).sort(sort).allowDiskUse(false)',
},
batchSize: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.batchSize',
description:
'Specifies the number of documents to return in each batch of the response from the MongoDB instance. In most cases, modifying the batch size will not affect the user or the application, as the mongo shell and most drivers return results as if MongoDB returned a single batch.',
example: 'db.collection.find(query, projection).batchSize(10)',
example:
'db.collection.find(query, projection, options).batchSize(10)',
},
close: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.close',
description:
'Instructs the server to close a cursor and free associated server resources. The server will automatically close cursors that have no remaining results, as well as cursors that have been idle for a period of time and lack the cursor.noCursorTimeout() option.',
example: 'db.collection.find(query, projection).close()',
example: 'db.collection.find(query, projection, options).close()',
},
collation: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.collation',
description:
'Specifies the collation for the cursor returned by the db.collection.find(). To use, append to the db.collection.find().',
example:
'db.collection.find(query, projection).collation(collationDocument)',
'db.collection.find(query, projection, options).collation(collationDocument)',
},
comment: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.comment',
description: 'Adds a comment field to the query.',
example:
"db.collection.find(query, projection).comment('Comment')",
"db.collection.find(query, projection, options).comment('Comment')",
},
count: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.count',
description:
'Counts the number of documents referenced by a cursor.',
example: 'db.collection.find(query, projection).count()',
example: 'db.collection.find(query, projection, options).count()',
},
explain: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.explain',
description:
'Provides information on the query plan for the db.collection.find() method.',
example: 'db.collection.find(query, projection).explain()',
example:
'db.collection.find(query, projection, options).explain()',
},
forEach: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.forEach',
description:
'Iterates the cursor to apply a JavaScript function to each document from the cursor.',
example:
'db.collection.find(query, projection).forEach(function)',
'db.collection.find(query, projection, options).forEach(function)',
},
getQueryPlan: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.explain',
description: 'Runs cursor.explain()',
example: 'db.collection.find(query, projection).getQueryPlan()',
example:
'db.collection.find(query, projection, options).getQueryPlan()',
},
hasNext: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.hasNext',
description:
"cursor.hasNext() returns true if the cursor returned by the db.collection.find() query can iterate further to return more documents. NOTE: if the cursor is tailable with awaitData then hasNext will block until a document is returned. To check if a document is in the cursor's batch without waiting, use tryNext instead",
example: 'db.collection.find(query, projection).hasNext()',
example:
'db.collection.find(query, projection, options).hasNext()',
},
hint: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.hint',
description:
'Call this method on a query to override MongoDB’s default index selection and query optimization process. Use db.collection.getIndexes() to return the list of current indexes on a collection.',
example: 'db.collection.find(query, projection).hint(index)',
example:
'db.collection.find(query, projection, options).hint(index)',
},
isClosed: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.isClosed',
description: 'Returns true if the cursor is closed.',
example: 'db.collection.find(query, projection).isClosed()',
example:
'db.collection.find(query, projection, options).isClosed()',
},
isExhausted: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.isExhausted',
description:
'cursor.isExhausted() returns true if the cursor is closed and there are no remaining objects in the batch.',
example: 'db.collection.find(query, projection).isExhausted()',
example:
'db.collection.find(query, projection, options).isExhausted()',
},
itcount: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.itcount',
description:
'Counts the number of documents remaining in a cursor. itcount() is similar to cursor.count(), but actually executes the query on an existing iterator, exhausting its contents in the process.',
example: 'db.collection.find(query, projection).itcount()',
example:
'db.collection.find(query, projection, options).itcount()',
},
length: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.count',
description: 'Runs cursor.count()',
example: 'db.collection.find(query, projection).length()',
example:
'db.collection.find(query, projection, options).length()',
},
limit: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.limit',
description:
'Use the limit() method on a cursor to specify the maximum number of documents the cursor will return.',
example: 'db.collection.find(query, projection).limit(2)',
example:
'db.collection.find(query, projection, options).limit(2)',
},
map: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.map',
description:
'Applies the first argument, a function, to each document visited by the cursor and collects the return values from successive application into an array.',
example: 'db.collection.find(query, projection).map(function)',
example:
'db.collection.find(query, projection, options).map(function)',
},
max: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.max',
description:
'Specifies the exclusive upper bound for a specific index in order to constrain the results of find(). max() provides a way to specify an upper bound on compound key indexes.',
example:
'db.collection.find(query, projection).max(indexBoundsDocument)',
'db.collection.find(query, projection, options).max(indexBoundsDocument)',
},
maxScan: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.maxScan',
Expand All @@ -1025,31 +1037,32 @@ const translations: Catalog = {
description:
'Specifies a cumulative time limit in milliseconds for processing operations on a cursor.',
example:
'db.collection.find(query, projection).maxTimeMS(timeLimit)',
'db.collection.find(query, projection, options).maxTimeMS(timeLimit)',
},
maxAwaitTimeMS: {
description:
'Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)',
example:
'db.collection.find(query, projection).maxAwaitTimeMS(timeLimit)',
'db.collection.find(query, projection, options).maxAwaitTimeMS(timeLimit)',
},
min: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.min',
description:
'Specifies the inclusive lower bound for a specific index in order to constrain the results of find(). min() provides a way to specify lower bounds on compound key indexes.',
example:
'db.collection.find(query, projection).min(indexBoundsDocument)',
'db.collection.find(query, projection, options).min(indexBoundsDocument)',
},
modifiers: {
link: '',
description: 'Get query modifiers.',
example: 'db.collection.find(query, projection).modifiers()',
example:
'db.collection.find(query, projection, options).modifiers()',
},
next: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.next',
description:
"The next document in the cursor returned by the db.collection.find() method. NOTE: if the cursor is tailable with awaitData then hasNext will block until a document is returned. To check if a document is in the cursor's batch without waiting, use tryNext instead",
example: 'db.collection.find(query, projection).next()',
example: 'db.collection.find(query, projection, options).next()',
},
tryNext: {
description:
Expand All @@ -1060,25 +1073,26 @@ const translations: Catalog = {
description:
'Instructs the server to avoid closing a cursor automatically after a period of inactivity.',
example:
'db.collection.find(query, projection).noCursorTimeout()',
'db.collection.find(query, projection, options).noCursorTimeout()',
},
objsLeftInBatch: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.objsLeftInBatch',
description:
'cursor.objsLeftInBatch() returns the number of documents remaining in the current batch.',
example:
'db.collection.find(query, projection).objsLeftInBatch()',
'db.collection.find(query, projection, options).objsLeftInBatch()',
},
oplogReplay: {
link: '',
description: 'Sets oplogReplay cursor flag to true.',
example: 'db.collection.find(query, projection).oplogReplay()',
example:
'db.collection.find(query, projection, options).oplogReplay()',
},
projection: {
link: '',
description: 'Sets a field projection for the query.',
example:
'db.collection.find(query, projection).projection(field)',
'db.collection.find(query, projection, options).projection(field)',
},
// don't document since everything is currently pretty printed
pretty: {
Expand All @@ -1090,7 +1104,7 @@ const translations: Catalog = {
description:
'Specify a read concern for the db.collection.find() method.',
example:
'db.collection.find(query, projection).readConcern(level)',
'db.collection.find(query, projection, options).readConcern(level)',
},
readonly: {
link: '',
Expand All @@ -1102,63 +1116,68 @@ const translations: Catalog = {
description:
'Append readPref() to a cursor to control how the client routes the query to members of the replica set.',
example:
'db.collection.find(query, projection).readPref(mode, tagSet)',
'db.collection.find(query, projection, options).readPref(mode, tagSet)',
},
returnKey: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.returnKey',
description:
'Modifies the cursor to return index keys rather than the documents.',
example: 'db.collection.find(query, projection).returnKey()',
example:
'db.collection.find(query, projection, options).returnKey()',
},
showDiskLoc: {
link: '',
description:
'The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY style find.',
example: 'db.collection.find(query, projection).showDiskLoc()',
example:
'db.collection.find(query, projection, options).showDiskLoc()',
},
showRecordId: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.showRecordId',
description:
'Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.',
example: 'db.collection.find(query, projection).showRecordId',
example:
'db.collection.find(query, projection, options).showRecordId',
},
size: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.size',
description:
'A count of the number of documents that match the db.collection.find() query after applying any cursor.skip() and cursor.limit() methods.',
example: 'db.collection.find(query, projection).size()',
example: 'db.collection.find(query, projection, options).size()',
},
skip: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.skip',
description:
'Call the cursor.skip() method on a cursor to control where MongoDB begins returning results. This approach may be useful in implementing paginated results.',
example:
'db.collection.find(query, projection).skip(offsetNumber)',
'db.collection.find(query, projection, options).skip(offsetNumber)',
},
snapshot: {
link: '',
description:
'The $snapshot operator prevents the cursor from returning a document more than once because an intervening write operation results in a move of the document',
example: 'db.collection.find(query, projection).snapshot()',
example:
'db.collection.find(query, projection, options).snapshot()',
},
sort: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.sort',
description:
'Specifies the order in which the query returns matching documents. You must apply sort() to the cursor before retrieving any documents from the database.',
example:
'db.collection.find(query, projection).sort(sortDocument)',
'db.collection.find(query, projection, options).sort(sortDocument)',
},
tailable: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.tailable',
description: 'Marks the cursor as tailable.',
example:
'db.collection.find(query, projection).tailable({ awaitData: true })',
'db.collection.find(query, projection, options).tailable({ awaitData: true })',
},
toArray: {
link: 'https://docs.mongodb.com/manual/reference/method/cursor.toArray',
description:
'The toArray() method returns an array that contains all the documents from a cursor. The method iterates completely the cursor, loading all the documents into RAM and exhausting the cursor.',
example: 'db.collection.find(query, projection).toArray()',
example:
'db.collection.find(query, projection, options).toArray()',
},
},
},
Expand Down
Loading