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

Update documentation for advanced query bar in Compass

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Compass
    • Labels:
      None
    • # Replies:
      2
    • Last comment by Customer:
      true
    • Sprint:
      KANBAN BUCKET

      Description

      Once we merge COMPASS-630 / COMPASS-631, Compass will have an "advanced" query bar that lets the user input not just the filter (as before), but also project, sort, skip and limit.

      This is for the 1.7.0-beta timeframe, which is roughly mid/end February.

      Not all collection-level tabs will expose all options however. As a first step, we will have:

      Schema view

      • filter: as before, lets the user provide a filter to refine the schema
      • limit: the user can now choose how many documents should be sampled randomly. We still cap the limit at 1000 for performance reasons for now.

      Document view

      • all options (filter, project, sort, skip, limit) are exposed

      Explain view

      • only filter is exposed: works as before

      The final version (possibly still 1.7.0 timeframe) will have additional options available:

      Schema view

      • filter
      • limit (how many documents should be sampled)
      • project (user can choose which fields they want included/excluded in the schema view)

      Documents and Explain plan view

      • filter, project, sort, skip, limit all exposed.

      Each query option has a little clickable "info sprinkle" in its label, which links to documentation. Therefore, each of the above options needs its own permalink so we can link directly to this section, e.g. "Explain - project" or "Schema - limit".

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Days since reply:
                  3 years, 2 days ago
                  Date of 1st Reply: