[DOCS-9995] Separate section on Query Bar in Compass Docs Created: 11/Mar/17  Updated: 30/Oct/23  Resolved: 13/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
Duplicate
Related
related to DOCS-9806 Update documentation for advanced que... Closed
Participants:
Days since reply: 6 years, 48 weeks, 5 days ago

 Description   

With the recent change to allow for more advanced queries across several collection-level tabs in Compass (Schema, Documents, Explain), I think we need to re-organize the documentation a little and create a separate section/chapter for the Query Bar (or "Querying" / "Queries").

I think this section could live under Collections, next to all the other collection-level views.

  • It should explain the (advanced) query bar with screenshots in collapsed and expanded state (e.g. from Documents view), and go through the 5 options filter, project, sort, skip, limit.
  • Provide details on the query (filter) language (strict extended json syntax, not shell syntax, at least until COMPASS-901 is implemented)
  • It should mention that sort and skip are not available on the schema view (currently listed as "known issues", but this is not a limitation, it just doesn't make sense to sort or skip on the schema view as the documents selection is random, this is "works as designed").

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