<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 07:49:41 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-5135] Document that DBRef objects allow extra fields</title>
                <link>https://jira.mongodb.org/browse/DOCS-5135</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;p&gt;Concise definition of a DBRef from &lt;a href=&quot;https://jira.mongodb.org/browse/SERVER-12263&quot; title=&quot;Support $elemMatch with DBRefs that may contain additional properties&quot; class=&quot;issue-link&quot; data-issue-key=&quot;SERVER-12263&quot;&gt;&lt;del&gt;SERVER-12263&lt;/del&gt;&lt;/a&gt;:&lt;/p&gt;
&lt;blockquote&gt;&lt;p&gt;DBRefs are objects whose first two fields must be &lt;tt&gt;$ref&lt;/tt&gt; and &lt;tt&gt;$id&lt;/tt&gt; (in that order). An optional &lt;tt&gt;$db&lt;/tt&gt; field, if present, must appear third. Other fields may follow (they can&apos;t have a &lt;tt&gt;$&lt;/tt&gt; prefix, of course).&lt;/p&gt;&lt;/blockquote&gt;
&lt;p&gt;We don&apos;t seem to have a real spec for DBRef objects, but the note about optional fields beyond &lt;tt&gt;$db&lt;/tt&gt; is important. Some libraries and ODMs store extra metadata in these fields, and it&apos;d be helpful to document that MongoDB does allow this (both for community developers and our own reference, as the server has broken this validation from time to time).&lt;/p&gt;

&lt;h2&gt;&lt;a name=&quot;ScopeofChanges&quot;&gt;&lt;/a&gt;Scope of Changes&lt;/h2&gt;

&lt;p&gt;Review and update &lt;a href=&quot;https://docs.mongodb.com/manual/reference/database-references/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/manual/reference/database-references/&lt;/a&gt; with info on optional fields beyond &lt;tt&gt;$db&lt;/tt&gt;. We should clarify that MongoDB does allow this functionality with DBRefs.&lt;/p&gt;</description>
                <environment></environment>
        <key id="193026">DOCS-5135</key>
            <summary>Document that DBRef objects allow extra fields</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="4" iconUrl="https://jira.mongodb.org/images/icons/priorities/minor.svg">Minor - P4</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="ashley.brown@mongodb.com">Ashley Brown</assignee>
                                    <reporter username="jmikola@mongodb.com">Jeremy Mikola</reporter>
                        <labels>
                    </labels>
                <created>Tue, 31 Mar 2015 00:21:17 +0000</created>
                <updated>Mon, 30 Oct 2023 22:29:55 +0000</updated>
                            <resolved>Fri, 8 Apr 2022 17:24:57 +0000</resolved>
                                                    <fixVersion>Server_Docs_20231030</fixVersion>
                                    <component>manual</component>
                    <component>Server</component>
                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="4480881" author="xgen-internal-githook" created="Wed, 13 Apr 2022 17:14:03 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Ashley Brown&apos;, &apos;email&apos;: &apos;98361885+mdb-ashley@users.noreply.github.com&apos;, &apos;username&apos;: &apos;mdb-ashley&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-5135&quot; title=&quot;Document that DBRef objects allow extra fields&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-5135&quot;&gt;&lt;del&gt;DOCS-5135&lt;/del&gt;&lt;/a&gt; Add information about extra DBRef fields (#921)&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add note about extra DBRef fields&lt;/li&gt;
&lt;/ul&gt;


&lt;ul&gt;
	&lt;li&gt;Incorporating external review comments&lt;br/&gt;
Branch: v6.0&lt;br/&gt;
&lt;a href=&quot;https://github.com/10gen/docs-mongodb-internal/commit/96421d2b34a0c6ec7f0a010d5356e13694fad19e&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/10gen/docs-mongodb-internal/commit/96421d2b34a0c6ec7f0a010d5356e13694fad19e&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="4468486" author="xgen-internal-githook" created="Fri, 8 Apr 2022 18:09:42 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Ashley Brown&apos;, &apos;email&apos;: &apos;98361885+mdb-ashley@users.noreply.github.com&apos;, &apos;username&apos;: &apos;mdb-ashley&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-5135&quot; title=&quot;Document that DBRef objects allow extra fields&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-5135&quot;&gt;&lt;del&gt;DOCS-5135&lt;/del&gt;&lt;/a&gt; Add information about extra DBRef fields (#921) (#935)&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add note about extra DBRef fields&lt;/li&gt;
&lt;/ul&gt;


&lt;ul&gt;
	&lt;li&gt;Incorporating external review comments&lt;br/&gt;
Branch: v4.2&lt;br/&gt;
&lt;a href=&quot;https://github.com/10gen/docs-mongodb-internal/commit/859af13a2609123212dc4143b8ba0b5def76edb3&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/10gen/docs-mongodb-internal/commit/859af13a2609123212dc4143b8ba0b5def76edb3&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="4468484" author="xgen-internal-githook" created="Fri, 8 Apr 2022 18:09:34 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Ashley Brown&apos;, &apos;email&apos;: &apos;98361885+mdb-ashley@users.noreply.github.com&apos;, &apos;username&apos;: &apos;mdb-ashley&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-5135&quot; title=&quot;Document that DBRef objects allow extra fields&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-5135&quot;&gt;&lt;del&gt;DOCS-5135&lt;/del&gt;&lt;/a&gt; Add information about extra DBRef fields (#921) (#934)&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add note about extra DBRef fields&lt;/li&gt;
&lt;/ul&gt;


&lt;ul&gt;
	&lt;li&gt;Incorporating external review comments&lt;br/&gt;
Branch: v4.4&lt;br/&gt;
&lt;a href=&quot;https://github.com/10gen/docs-mongodb-internal/commit/87fb24160f4e2991ee5e386c7e125a0c9e7cbdd8&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/10gen/docs-mongodb-internal/commit/87fb24160f4e2991ee5e386c7e125a0c9e7cbdd8&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="4468482" author="xgen-internal-githook" created="Fri, 8 Apr 2022 18:09:24 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Ashley Brown&apos;, &apos;email&apos;: &apos;98361885+mdb-ashley@users.noreply.github.com&apos;, &apos;username&apos;: &apos;mdb-ashley&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-5135&quot; title=&quot;Document that DBRef objects allow extra fields&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-5135&quot;&gt;&lt;del&gt;DOCS-5135&lt;/del&gt;&lt;/a&gt; Add information about extra DBRef fields (#921) (#933)&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add note about extra DBRef fields&lt;/li&gt;
&lt;/ul&gt;


&lt;ul&gt;
	&lt;li&gt;Incorporating external review comments&lt;br/&gt;
Branch: v5.0&lt;br/&gt;
&lt;a href=&quot;https://github.com/10gen/docs-mongodb-internal/commit/eb85a8cb4695a608cd304a06347e05efced637e7&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/10gen/docs-mongodb-internal/commit/eb85a8cb4695a608cd304a06347e05efced637e7&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="4468358" author="xgen-internal-githook" created="Fri, 8 Apr 2022 17:35:13 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Ashley Brown&apos;, &apos;email&apos;: &apos;98361885+mdb-ashley@users.noreply.github.com&apos;, &apos;username&apos;: &apos;mdb-ashley&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-5135&quot; title=&quot;Document that DBRef objects allow extra fields&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-5135&quot;&gt;&lt;del&gt;DOCS-5135&lt;/del&gt;&lt;/a&gt; Add information about extra DBRef fields (#921)&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add note about extra DBRef fields&lt;/li&gt;
&lt;/ul&gt;


&lt;ul&gt;
	&lt;li&gt;Incorporating external review comments&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/10gen/docs-mongodb-internal/commit/96421d2b34a0c6ec7f0a010d5356e13694fad19e&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/10gen/docs-mongodb-internal/commit/96421d2b34a0c6ec7f0a010d5356e13694fad19e&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="4462515" author="JIRAUSER1264464" created="Wed, 6 Apr 2022 19:57:02 +0000"  >&lt;p&gt;Hi &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=jmikola&quot; class=&quot;user-hover&quot; rel=&quot;jmikola&quot;&gt;jmikola&lt;/a&gt;, thanks for bringing this to our attention, and sorry about the delay! I&apos;ve proposed an update to the manual and requested your review in &lt;a href=&quot;https://github.com/10gen/docs-mongodb-internal/pull/921&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;this PR&lt;/a&gt;. Thanks!&lt;/p&gt;</comment>
                            <comment id="3879214" author="jmikola@gmail.com" created="Tue, 15 Jun 2021 18:12:59 +0000"  >&lt;p&gt;It&apos;s not clear to me why this was originally resolved as &quot;Won&apos;t Fix&quot; in 2016 (no comment/justification was given).&lt;/p&gt;

&lt;p&gt;We recently wrote a &lt;a href=&quot;https://github.com/mongodb/specifications/blob/master/source/dbref.rst&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;DBRef Specification&lt;/a&gt; (&lt;a href=&quot;https://jira.mongodb.org/browse/DRIVERS-1173&quot; title=&quot;Driver Handling of DBRefs&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DRIVERS-1173&quot;&gt;DRIVERS-1173&lt;/a&gt;), which coincides with MongoDB 5.0 relaxing restrictions on dots/dollars in field names (DRIVERS-1237). Would it be possible to revisit this issue so the MongoDB manual can be revised to align with the specification?&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="104842">SERVER-12263</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="1307631">DRIVERS-1173</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>7.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 6 Apr 2022 19:57:02 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        1 year, 43 weeks 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_10857" key="com.pyxis.greenhopper.jira:gh-epic-link">
                        <customfieldname>Epic Link</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>DOCSP-11702</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_14873" key="com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker">
                        <customfieldname>External Reviewer</customfieldname>
                        <customfieldvalues>
                                    <customfieldvalue><![CDATA[jmikola@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>emet.ozar@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            1 year, 43 weeks ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>ashley.brown@mongodb.com</customfieldvalue>
            <customfieldvalue>xgen-internal-githook</customfieldvalue>
            <customfieldvalue>jmikola@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hrqfov:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hrd1j3:</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="5841">ServerDocs2022: Apr5 - Apr12</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                        <customfield id="customfield_10555" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>3.0</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|hrz2iv:</customfieldvalue>

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