[DOCS-9806] Update documentation for advanced query bar in Compass Created: 23/Jan/17  Updated: 30/Oct/23  Resolved: 10/Apr/17

Status: Closed
Project: Documentation
Component/s: Compass
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Major - P3
Reporter: Thomas Rueckstiess Assignee: Kay Kim (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Related
is related to DOCS-9995 Separate section on Query Bar in Comp... Closed
Participants:
Days since reply: 6 years, 44 weeks, 2 days ago

 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".



 Comments   
Comment by Kay Kim (Inactive) [ 10/Apr/17 ]

Additional changes done as part of DOCS-9995

Comment by Thomas Rueckstiess [ 02/Feb/17 ]

Images of the new query bar:

Documents Tab

Schema Tab

Explain Tab

Generated at Thu Feb 08 07:59:11 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.