<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:05:51 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-12682] create command option `indexOptionsDefaults` duplicates storageEngine documentation</title>
                <link>https://jira.mongodb.org/browse/DOCS-12682</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;h2&gt;&lt;a name=&quot;Description&quot;&gt;&lt;/a&gt;Description&lt;/h2&gt;
&lt;p&gt;On the documentation page for the &lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/create/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;&lt;tt&gt;create&lt;/tt&gt; command&lt;/a&gt;, the description of &lt;tt&gt;indexOptionsDefaults&lt;/tt&gt; seems to be copied from the description of the &lt;tt&gt;storageEngine&lt;/tt&gt; option, which seems a little strange, as I&apos;d expect that &lt;tt&gt;indexOptionsDefaults&lt;/tt&gt; would take in a document that looks like the options passed to &lt;tt&gt;createIndexes&lt;/tt&gt;. Is this a mistake, or am I misunderstanding the purpose of the field?&lt;/p&gt;

&lt;h2&gt;&lt;a name=&quot;Scopeofchanges&quot;&gt;&lt;/a&gt;Scope of changes&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;ImpacttoOtherDocs&quot;&gt;&lt;/a&gt;Impact to Other Docs&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;MVP%28WorkandDate%29&quot;&gt;&lt;/a&gt;MVP (Work and Date)&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;Resources%28ScopeorDesignDocs%2CInvision%2Cetc.%29&quot;&gt;&lt;/a&gt;Resources (Scope or Design Docs, Invision, etc.)&lt;/h2&gt;
</description>
                <environment></environment>
        <key id="759055">DOCS-12682</key>
            <summary>create command option `indexOptionsDefaults` duplicates storageEngine documentation</summary>
                <type id="1" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14703&amp;avatarType=issuetype">Bug</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="12300">Won&apos;t Do</resolution>
                                        <assignee username="kay.kim@mongodb.com">Kay Kim</assignee>
                                    <reporter username="sam.rossi@mongodb.com">Samuel Rossi</reporter>
                        <labels>
                    </labels>
                <created>Mon, 6 May 2019 20:51:57 +0000</created>
                <updated>Mon, 30 Oct 2023 20:41:51 +0000</updated>
                            <resolved>Mon, 13 Mar 2023 20:22:29 +0000</resolved>
                                                    <fixVersion>Server_Docs_20231030</fixVersion>
                                    <component>Server</component>
                        <due></due>
                            <votes>0</votes>
                                    <watches>4</watches>
                                                                                                                <comments>
                            <comment id="5269022" author="JIRAUSER1264464" created="Mon, 13 Mar 2023 20:22:29 +0000"  >&lt;p&gt;Hi, we&apos;re closing this ticket because we believe the discussion in comments means we shouldn&apos;t take any action here. If you believe this is an error, please reopen the ticket with a comment explaining why and we&apos;ll take a look. Thanks!&lt;/p&gt;</comment>
                            <comment id="2237465" author="sam.rossi" created="Tue, 7 May 2019 18:26:31 +0000"  >&lt;p&gt;For the create collection helper, yes, we allow &lt;tt&gt;indexOptionDefaults&lt;/tt&gt;, but it seems weird to expose this if we can&apos;t actually document the format of the documents that are used there. In our index management spec, we also currently require that drivers expose a &lt;tt&gt;storageEngine&lt;/tt&gt; option, but again, it seems weird to require this if users aren&apos;t supposed to know what to populate it with.&lt;/p&gt;

&lt;p&gt;One thing that might not be clear here is that in statically-typed languages, we define structs for each of the options types rather than accepting an arbitrary document. For example, a driver would define an &lt;tt&gt;IndexOptions&lt;/tt&gt; struct which has a field called &lt;tt&gt;storageEngine&lt;/tt&gt;. I&apos;m thinking that it might not make sense for our spec to require that drivers have a &lt;tt&gt;storageEngine&lt;/tt&gt; field if we can&apos;t even document what form it should take. For dynamically typed languages that just take a dictionary of options, this isn&apos;t as big of a deal (since they can just allow the user to specify arbitrary keys in the options and let the server validate them), but it seems counterintuitive that we&apos;d go out of our way to add the ability to specify a &lt;tt&gt;storageEngine&lt;/tt&gt; option if we can&apos;t actually document how to use it.&lt;/p&gt;</comment>
                            <comment id="2237257" author="max.hirschhorn@10gen.com" created="Tue, 7 May 2019 16:26:35 +0000"  >&lt;blockquote&gt;
&lt;p&gt;Is this something that we shouldn&apos;t be exposing to users? The drivers all have runCommand helpers, so it would still be possible for users who know the proper semantics of a config string to express it. manually.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;My impression was for drivers that offer a &lt;tt&gt;create_collection()&lt;/tt&gt; helper, they&apos;d allow the &lt;tt&gt;indexOptionDefaults&lt;/tt&gt; option to be specified. Drivers shouldn&apos;t document anything about WiredTiger &lt;tt&gt;configString&lt;/tt&gt;.&lt;/p&gt;</comment>
                            <comment id="2237187" author="sam.rossi" created="Tue, 7 May 2019 15:59:27 +0000"  >&lt;p&gt;Interesting! The drivers specification for index management requires that drivers allow users to specify a &lt;tt&gt;storageEngine&lt;/tt&gt; option, and I was having trouble finding the documentation for this, so the fact that it&apos;s purposely not documented would explain that. Is this something that we shouldn&apos;t be exposing to users? The drivers all have runCommand helpers, so it would still be possible for users who know the proper semantics of a config string to express it. manually.&lt;/p&gt;</comment>
                            <comment id="2236154" author="ravind.kumar" created="Mon, 6 May 2019 20:56:57 +0000"  >&lt;p&gt;Looking at the source ticket &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-6106&quot; title=&quot;Document &amp;quot;indexOptionDefaults&amp;quot; option to createCollection()&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-6106&quot;&gt;&lt;del&gt;DOCS-6106&lt;/del&gt;&lt;/a&gt; via &lt;a href=&quot;https://jira.mongodb.org/browse/SERVER-18879&quot; title=&quot;Add &amp;quot;indexOptionDefaults&amp;quot; to createCollection()&quot; class=&quot;issue-link&quot; data-issue-key=&quot;SERVER-18879&quot;&gt;&lt;del&gt;SERVER-18879&lt;/del&gt;&lt;/a&gt;, it does look like this is intentional. &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=max.hirschhorn&quot; class=&quot;user-hover&quot; rel=&quot;max.hirschhorn&quot;&gt;max.hirschhorn&lt;/a&gt; might be able to comment further on this.&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                <customfield id="customfield_10050" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname># Replies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>5.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Mon, 6 May 2019 20:56:57 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        47 weeks, 2 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_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>
                            47 weeks, 2 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>ashley.brown@mongodb.com</customfieldvalue>
            <customfieldvalue>kay.kim@mongodb.com</customfieldvalue>
            <customfieldvalue>max.hirschhorn@mongodb.com</customfieldvalue>
            <customfieldvalue>ravind.kumar</customfieldvalue>
            <customfieldvalue>sam.rossi@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|huy0hb:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hunee7:</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_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|huxmqn:</customfieldvalue>

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