<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:59:10 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>[JAVA-3258] Inconsistent javadoc documentation for MongoCollection #updateOne and #findOneAndUpdate methods.</title>
                <link>https://jira.mongodb.org/browse/JAVA-3258</link>
                <project id="10006" key="JAVA">Java Driver</project>
                    <description>&lt;p&gt;The javadocs for both the MongoCollection #updateOne and #findOneAndUpdate methods both state for the &apos;update&apos; param:&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;
&lt;p/&gt;
&lt;div id=&quot;syntaxplugin&quot; class=&quot;syntaxplugin&quot; style=&quot;border: 1px dashed #bbb; border-radius: 5px !important; overflow: auto; max-height: 30em;&quot;&gt;
&lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; border=&quot;0&quot; width=&quot;100%&quot; style=&quot;font-size: 1em; line-height: 1.4em !important; font-weight: normal; font-style: normal; color: black;&quot;&gt;
		&lt;tbody &gt;
				&lt;tr id=&quot;syntaxplugin_code_and_gutter&quot;&gt;
						&lt;td  style=&quot; line-height: 1.4em !important; padding: 0em; vertical-align: top;&quot;&gt;
					&lt;pre style=&quot;font-size: 1em; margin: 0 10px;  margin-top: 10px;   margin-bottom: 10px;  width: auto; padding: 0;&quot;&gt;&lt;span style=&quot;color: gray; font-family: &apos;Consolas&apos;, &apos;Bitstream Vera Sans Mono&apos;, &apos;Courier New&apos;, Courier, monospace !important;&quot;&gt;@param&lt;/span&gt;&lt;span style=&quot;color: black; font-family: &apos;Consolas&apos;, &apos;Bitstream Vera Sans Mono&apos;, &apos;Courier New&apos;, Courier, monospace !important;&quot;&gt; update  a document describing the update, which may not be &lt;/span&gt;&lt;span style=&quot;color: #006699; font-weight: bold; font-family: &apos;Consolas&apos;, &apos;Bitstream Vera Sans Mono&apos;, &apos;Courier New&apos;, Courier, monospace !important;&quot;&gt;null&lt;/span&gt;&lt;span style=&quot;color: black; font-family: &apos;Consolas&apos;, &apos;Bitstream Vera Sans Mono&apos;, &apos;Courier New&apos;, Courier, monospace !important;&quot;&gt;. The update to apply must include only update operators.&lt;/span&gt;&lt;/pre&gt;
			&lt;/td&gt;
		&lt;/tr&gt;
			&lt;/tbody&gt;
&lt;/table&gt;
&lt;/div&gt;
&lt;p/&gt;
&lt;p&gt;Perhaps this should also include information about passing in a replacement document instead of an just an update document that contains update operators.&lt;/p&gt;

&lt;p&gt;I could not find this document anywhere, but if I pass in an empty document to the update parameter, mongo will replace the existing document with that empty document. I assume that because the empty document contains no update operators it is treated a name/value paired object? I would have thought that passing an empty document would result in no changes the existing document, as it does actually not contain any fields.&lt;/p&gt;

&lt;p&gt;Also, when dynamically constructing a Bson update object using the Updates.combine method, if at least one update operator is not added it will be considered an invalid update because it does not contain any update operators. Is it possible to treat the empty array that would be created by the Updates.combine method as a valid update operator that essentially does nothing instead of throwing an error?&lt;/p&gt;

&lt;p&gt;As it stands, the update parameter cannot be null (which seems somewhat inconsistent with the other Bson params that are nullable), and we cannot pass an empty array of updates either.&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;</description>
                <environment></environment>
        <key id="731128">JAVA-3258</key>
            <summary>Inconsistent javadoc documentation for MongoCollection #updateOne and #findOneAndUpdate methods.</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</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="13201">Fixed</resolution>
                                        <assignee username="john.stewart@mongodb.com">John Stewart</assignee>
                                    <reporter username="etay2000">Eric Tray</reporter>
                        <labels>
                    </labels>
                <created>Fri, 5 Apr 2019 14:51:55 +0000</created>
                <updated>Sat, 28 Oct 2023 11:22:17 +0000</updated>
                            <resolved>Sat, 3 Aug 2019 01:46:14 +0000</resolved>
                                    <version>3.10.1</version>
                                    <fixVersion>3.11.0</fixVersion>
                                    <component>Documentation</component>
                    <component>Query Operations</component>
                                        <votes>0</votes>
                                    <watches>1</watches>
                                                                                                                <comments>
                            <comment id="2356716" author="xgen-internal-githook" created="Sat, 3 Aug 2019 01:46:04 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;John Stewart&apos;, &apos;email&apos;: &apos;john.stewart@mongodb.com&apos;, &apos;username&apos;: &apos;jstewart-mongo&apos;}
&lt;p&gt;Message: Update documentation for MongoCollection#updateOne and MongoCollection#findOneAndUpdate&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/browse/JAVA-3258&quot; title=&quot;Inconsistent javadoc documentation for MongoCollection #updateOne and #findOneAndUpdate methods.&quot; class=&quot;issue-link&quot; data-issue-key=&quot;JAVA-3258&quot;&gt;&lt;del&gt;JAVA-3258&lt;/del&gt;&lt;/a&gt;&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-java-driver/commit/f78425f23b84632e3a6de1571b731ad90fd741dc&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-java-driver/commit/f78425f23b84632e3a6de1571b731ad90fd741dc&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hr6t5z:</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>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>