<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:55:32 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-1802] Improve runCommand API documentation</title>
                <link>https://jira.mongodb.org/browse/JAVA-1802</link>
                <project id="10006" key="JAVA">Java Driver</project>
                    <description>&lt;p&gt;Clarify the intent and read preference used by the &lt;tt&gt;MongoCollection.runCommand&lt;/tt&gt; methods.&lt;/p&gt;

&lt;p&gt;Where the commands are run are based on if a read preference is supplied:&lt;/p&gt;

&lt;div class=&apos;table-wrap&apos;&gt;
&lt;table class=&apos;confluenceTable&apos;&gt;&lt;tbody&gt;
&lt;tr&gt;
&lt;th class=&apos;confluenceTh&apos;&gt; method &lt;/th&gt;
&lt;th class=&apos;confluenceTh&apos;&gt; read preference &lt;/th&gt;
&lt;th class=&apos;confluenceTh&apos;&gt; use case &lt;/th&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td class=&apos;confluenceTd&apos;&gt; &lt;tt&gt;runCommand(Bson command)&lt;/tt&gt;  &lt;/td&gt;
&lt;td class=&apos;confluenceTd&apos;&gt; primary &lt;/td&gt;
&lt;td class=&apos;confluenceTd&apos;&gt; run write commands. &lt;br class=&quot;atl-forced-newline&quot; /&gt; eg.  create index, create collection, drop collection etc.. &lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td class=&apos;confluenceTd&apos;&gt; &lt;tt&gt;runCommand(Bson command, ReadPreference readPreference)&lt;/tt&gt;  &lt;/td&gt;
&lt;td class=&apos;confluenceTd&apos;&gt; as supplied &lt;/td&gt;
&lt;td class=&apos;confluenceTd&apos;&gt; run any commands with the supplied readPreference.  &lt;br class=&quot;atl-forced-newline&quot; /&gt; eg  dbstats, profile, ismaster etc.. &lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;&lt;/table&gt;
&lt;/div&gt;



&lt;p&gt;Add examples to the &lt;tt&gt;quick-tour-admin.md&lt;/tt&gt;, needs to be done in async also.&lt;/p&gt;</description>
                <environment></environment>
        <key id="202408">JAVA-1802</key>
            <summary>Improve runCommand API documentation</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</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="ross@mongodb.com">Ross Lawley</assignee>
                                    <reporter username="ross@mongodb.com">Ross Lawley</reporter>
                        <labels>
                    </labels>
                <created>Wed, 6 May 2015 14:47:31 +0000</created>
                <updated>Wed, 7 Oct 2015 13:01:04 +0000</updated>
                            <resolved>Mon, 7 Sep 2015 08:07:16 +0000</resolved>
                                                    <fixVersion>3.1.0</fixVersion>
                                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="1053720" author="jeff.yemin" created="Wed, 7 Oct 2015 13:01:04 +0000"  >&lt;p&gt;Released in &lt;a href=&quot;https://github.com/mongodb/mongo-java-driver/releases/tag/r3.1.0&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;3.1.0&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1023348" author="ross@10gen.com" created="Mon, 7 Sep 2015 08:07:16 +0000"  >&lt;p&gt;The work for clarifying and the API docs was done in &lt;a href=&quot;https://jira.mongodb.org/browse/JAVA-1867&quot; title=&quot;MongoDatabase.runCommand should never fail server selection with a direct connection&quot; class=&quot;issue-link&quot; data-issue-key=&quot;JAVA-1867&quot;&gt;&lt;del&gt;JAVA-1867&lt;/del&gt;&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;Now the supplied readPreference is used and &quot;write&quot; commands can use either method with the `primary` read preference.&lt;/p&gt;</comment>
                            <comment id="947455" author="jeff.yemin" created="Mon, 22 Jun 2015 21:39:22 +0000"  >&lt;p&gt;There is actually a bug related to this (&lt;a href=&quot;https://jira.mongodb.org/browse/JAVA-1867&quot; title=&quot;MongoDatabase.runCommand should never fail server selection with a direct connection&quot; class=&quot;issue-link&quot; data-issue-key=&quot;JAVA-1867&quot;&gt;&lt;del&gt;JAVA-1867&lt;/del&gt;&lt;/a&gt;), the fix for which contains a partial fix for this issue.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="202393">JAVA-1801</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <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|hreauv:</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="522">Java Sprint 20</customfieldvalue>
    <customfieldvalue id="552">Java Sprint 20</customfieldvalue>
    <customfieldvalue id="586">Java Sprint 21</customfieldvalue>
    <customfieldvalue id="587">Java Sprint 23</customfieldvalue>
    <customfieldvalue id="588">Java Sprint 24</customfieldvalue>
    <customfieldvalue id="712">Java Sprint 25</customfieldvalue>

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