Skip to content

Review filters guide #1902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
guimachiavelli opened this issue Sep 26, 2022 · 2 comments · Fixed by #2061
Closed

Review filters guide #1902

guimachiavelli opened this issue Sep 26, 2022 · 2 comments · Fixed by #2061

Comments

@guimachiavelli
Copy link
Member

guimachiavelli commented Sep 26, 2022 •
edited
Loading

This guide was written about a year ago and is starting to show its age. We should review it completely and possibly rewrite a few sections.

Filter expressions and operators

One major pain point is the list of filter operators, which no longer comfortably accommodates the growing number of operators (started with 3, now 6, will probably be further expanded soon). Additionally, the complexity of these operators has grown significantly and fitting everything (explanation, edge cases, comprehensive examples) in a single list item has become awkward.

Content to add

NOT and EXISTS

EXISTS can be negated both as attribute NOT EXISTS and NOT attribute EXISTS.

IN and OR

At the moment, IN works a bit like syntactic sugar for multiple OR statements. The implementation is actually different, however, and devs do not offer any assurances the behaviour of both operators will always match.
@guimachiavelli guimachiavelli mentioned this issue Sep 27, 2022
Merged
@maryamsulemani97
Copy link
Contributor

maryamsulemani97 commented Oct 3, 2022 •
edited
Loading

Related: #860 , #837

@guimachiavelli
Copy link
Member Author

Another related issue: #1850

@dichotommy dichotommy mentioned this issue Oct 5, 2022
Closed
@maryamsulemani97 maryamsulemani97 mentioned this issue Dec 27, 2022
Merged
bors bot added a commit that referenced this issue Feb 16, 2023
@bors @maryamsulemani97
Merge #2061
d794d8b 
2061: review filtering guide r=maryamsulemani97 a=maryamsulemani97

closes #1902, #860, #837, and #1850

- moves all operators to a new heading
- removes SQL syntax and combines it with the curl code samples
- replaces amazon and imdb images for facets with meilisearch demo images
- removes unused images in `.vuepress/public/faceted-search`
- remove redundant code samples
<hr>

- Improve coherence between dataset and examples
  - A sample document was added as part of  #2050 with `rating` and `director` fields
  - This PR uses `movie_ratings` instead of `movies` to clarify that this is a separate dataset
     - `faceted_search_facets_1` still  uses `movies` as this code sample is used in the API reference as well

Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: Maryam <[email protected]>
Co-authored-by: maryamsulemani97 <[email protected]>
@bors bors bot closed this as completed in f7243dc Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

review filtering guide meilisearch/documentation
2 participants
@guimachiavelli @maryamsulemani97