<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 07:59:14 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[DOCS-9823] Document maxTimeMS option for all CRUD commands</title>
                <link>https://jira.mongodb.org/browse/DOCS-9823</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/browse/SERVER-2212&quot; title=&quot;Server automatically abort queries/commands after user-specified time limit&quot; class=&quot;issue-link&quot; data-issue-key=&quot;SERVER-2212&quot;&gt;&lt;del&gt;SERVER-2212&lt;/del&gt;&lt;/a&gt; introduced the &lt;tt&gt;maxTimeMS&lt;/tt&gt; option for commands and queries. &lt;/p&gt;

&lt;p&gt;AFAIK, the option is only discussed in &lt;a href=&quot;https://docs.mongodb.com/manual/tutorial/terminate-running-operations/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Terminate Running Operations&lt;/a&gt;. It would be helpful if the option appeared alongside other command options. For instance, it does show up in the &lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/find/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;find&lt;/a&gt; command docs, but is absent from &lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/aggregate/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;aggregate&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;We should check with the server team for a list of all commands where a &lt;tt&gt;maxTimeMS&lt;/tt&gt; option is supported. As shown by &lt;a href=&quot;https://jira.mongodb.org/browse/SERVER-27711&quot; title=&quot;createIndexes command incorrectly rejects maxTimeMS option&quot; class=&quot;issue-link&quot; data-issue-key=&quot;SERVER-27711&quot;&gt;&lt;del&gt;SERVER-27711&lt;/del&gt;&lt;/a&gt;, support for this option is easy to overlook.&lt;/p&gt;</description>
                <environment></environment>
        <key id="349044">DOCS-9823</key>
            <summary>Document maxTimeMS option for all CRUD commands</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="9">Done</resolution>
                                        <assignee username="cory.bullinger@mongodb.com">Cory Bullinger</assignee>
                                    <reporter username="jmikola@mongodb.com">Jeremy Mikola</reporter>
                        <labels>
                            <label>reopened</label>
                            <label>server-docs-bug-bash</label>
                            <label>triage</label>
                    </labels>
                <created>Wed, 25 Jan 2017 15:53:03 +0000</created>
                <updated>Thu, 20 Jul 2023 15:00:16 +0000</updated>
                            <resolved>Tue, 18 Jul 2023 22:35:28 +0000</resolved>
                                                    <fixVersion>v20170516</fixVersion>
                                    <component>manual</component>
                        <due></due>
                            <votes>1</votes>
                                    <watches>12</watches>
                                                                                                                <comments>
                            <comment id="5567039" author="david.storch" created="Fri, 14 Jul 2023 15:13:04 +0000"  >&lt;p&gt;Adjusted the title, since I think we&apos;ve narrowed the scope of this ticket to be just about documenting &lt;tt&gt;maxTimeMS&lt;/tt&gt; for the CRUD commands:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;aggregate&lt;/li&gt;
	&lt;li&gt;count&lt;/li&gt;
	&lt;li&gt;find&lt;/li&gt;
	&lt;li&gt;findAndModify&lt;/li&gt;
	&lt;li&gt;delete&lt;/li&gt;
	&lt;li&gt;insert&lt;/li&gt;
	&lt;li&gt;mapReduce&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;There should be followup work to document &lt;tt&gt;maxTimeMS&lt;/tt&gt; for all of the remaining commands that support this option. cc &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=cory.bullinger%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;cory.bullinger@mongodb.com&quot;&gt;cory.bullinger@mongodb.com&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4945090" author="JIRAUSER1264463" created="Tue, 1 Nov 2022 17:31:30 +0000"  >&lt;p&gt;Thanks &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=jmikola%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;jmikola@mongodb.com&quot;&gt;jmikola@mongodb.com&lt;/a&gt;. Appreciate the additional details!&lt;/p&gt;</comment>
                            <comment id="4943084" author="jmikola@gmail.com" created="Tue, 1 Nov 2022 03:12:16 +0000"  >&lt;p&gt;I think this is still relevant. The option appears in docs for some commands but not others.&lt;/p&gt;

&lt;p&gt;For example, &lt;a href=&quot;https://www.mongodb.com/docs/manual/reference/command/aggregate/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;aggregate&lt;/a&gt; lists maxTimeMS but &lt;a href=&quot;https://www.mongodb.com/docs/manual/reference/command/update/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;update&lt;/a&gt; does not.&lt;/p&gt;</comment>
                            <comment id="4940810" author="edu.bot" created="Mon, 31 Oct 2022 16:11:13 +0000"  >&lt;p&gt;Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!&lt;/p&gt;</comment>
                            <comment id="2740082" author="ravind.kumar" created="Fri, 17 Jan 2020 20:55:00 +0000"  >&lt;p&gt;The commit for this work seems to have vanished into time and space, so the work needs to be redone. Unfortunately the patch wont apply cleanly as we&apos;ve removed apiargs from the manual, so this needs a lot of manual handiwork. Adding back to queue for scheduling.&lt;/p&gt;</comment>
                            <comment id="1615593" author="ravind.kumar" created="Thu, 6 Jul 2017 20:03:30 +0000"  >&lt;p&gt;RFM pending final pass&lt;/p&gt;</comment>
                            <comment id="1485208" author="david.storch" created="Wed, 25 Jan 2017 18:52:27 +0000"  >&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=ravind.kumar&quot; class=&quot;user-hover&quot; rel=&quot;ravind.kumar&quot;&gt;ravind.kumar&lt;/a&gt;, maxTimeMS is handled generically for all commands in the command preprocessing layer:&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/mongodb/mongo/blob/r3.5.1/src/mongo/db/commands/dbcommands.cpp#L1393-L1406&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo/blob/r3.5.1/src/mongo/db/commands/dbcommands.cpp#L1393-L1406&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;This makes it a little bit hard to enumerate all of the commands which support maxTimeMS. At the very least, it should support the the main CRUD execution commands:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;aggregate&lt;/li&gt;
	&lt;li&gt;count&lt;/li&gt;
	&lt;li&gt;delete&lt;/li&gt;
	&lt;li&gt;find&lt;/li&gt;
	&lt;li&gt;findAndModify&lt;/li&gt;
	&lt;li&gt;geoNear&lt;/li&gt;
	&lt;li&gt;group (deprecated)&lt;/li&gt;
	&lt;li&gt;insert&lt;/li&gt;
	&lt;li&gt;mapReduce&lt;/li&gt;
	&lt;li&gt;update&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Other administration commands, like those related to index builds and management or sharding-related administration commands should also support maxTimeMS. Again, the design of maxTimeMS was for it to be supported in a generic way for all commands. It might make sense for the docs pages to also broadly mention that most commands accept a &lt;tt&gt;maxTimeMS&lt;/tt&gt; parameter, with some additional documentation for common use cases (e.g. setting a maxTimeMS on a find or aggregate cursor).&lt;/p&gt;</comment>
                            <comment id="1485021" author="ravind.kumar" created="Wed, 25 Jan 2017 16:19:53 +0000"  >&lt;p&gt;ToDo:&lt;/p&gt;

&lt;p&gt;Check with SERVER team for list of options supporting &lt;tt&gt;maxTimeMS&lt;/tt&gt; - &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=david.storch&quot; class=&quot;user-hover&quot; rel=&quot;david.storch&quot;&gt;david.storch&lt;/a&gt; can you advise?&lt;/p&gt;

&lt;p&gt;Use existing copy of &lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/find/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/manual/reference/command/find/&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;Some of the commands may not following the format of listing parameters (see the insert command). This is a good opportunity to resolve that as a part of this ticket.&lt;/p&gt;

&lt;p&gt;Priority is getting list of options. Ticket cannot be properly estimated without that list.&lt;/p&gt;
</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10010">
                    <name>Duplicate</name>
                                            <outwardlinks description="duplicates">
                                        <issuelink>
            <issuekey id="378026">DOCS-10181</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is duplicated by">
                                        <issuelink>
            <issuekey id="1872210">DOCS-14789</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                        <issuelink>
            <issuekey id="388529">DOCS-10329</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="1110146">DRIVERS-797</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="349062">DRIVERS-2071</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="346383">SERVER-27711</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="13949">SERVER-2212</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="349040">DOCS-9822</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                <customfield id="customfield_10050" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname># Replies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>8.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_14258" key="com.atlassian.jira.plugin.system.customfieldtypes:datepicker">
                        <customfieldname>Baseline start date</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 12 Jul 2023 00:00:00 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 25 Jan 2017 16:19:53 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        29 weeks, 5 days ago
    
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_18254" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Dependencies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[]]></customfieldvalue>


                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_14876" key="com.atlassian.jira.plugin.system.customfieldtypes:userpicker">
                        <customfieldname>Docs Reviewer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>ashley.brown@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10057" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comment by Customer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>true</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10056" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last commenter</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>nick.villahermosa@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            29 weeks, 5 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>cory.bullinger@mongodb.com</customfieldvalue>
            <customfieldvalue>david.storch@mongodb.com</customfieldvalue>
            <customfieldvalue>edu.bot</customfieldvalue>
            <customfieldvalue>jmikola@mongodb.com</customfieldvalue>
            <customfieldvalue>ravind.kumar</customfieldvalue>
            <customfieldvalue>sarah.olson@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|ht1k3z:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hsu8ev:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10557" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1324">KANBAN BUCKET</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10053" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>Time In Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_14350" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>serverRank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hrzoy7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                </customfields>
    </item>
</channel>
</rss>