Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-14378

Documentation does not reflect changes made in SERVER-23882

    XMLWordPrintableJSON

Details

    Description

      Description

      SERVER-23882, implemented in version 3.3.10 of the server, introduced collation as part of a query's shape.  Despite a specific note in the description of the ticket, it looks like the documentation was never updated to reflect the change.  The entry on the glossary page currently still reads as follows:

      A combination of query predicate, sort, and projection.

      Relatedly, the PlanCache.getPlansByQuery() documentation currently states that the command has the following definition:

      db.collection.getPlanCache().getPlansByQuery( <query>, <projection>, <sort> ) 

      But it actually accepts a fourth argument which is the collation:

      > db.foo.getPlanCache().getPlansByQuery
      function(query, projection, sort, collation) {
          return this._runCommandThrowOnError("planCacheListPlans",
                                              this._parseQueryShape(query, projection, sort, collation));
      } 

      Worth noting here: the getPlansByQuery() function was deprecated in version 4.2 and is now removed as of 4.4.  At the time of writing, version 3.6 reaches EOL this month but versions 4.0 and 4.2 will still be supported for a while.

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

      Attachments

        Activity

          People

            ashley.brown@mongodb.com Ashley Brown
            christopher.harris@mongodb.com Chris Harris
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              2 years, 41 weeks, 5 days ago