Skip to content
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.

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

Please document query syntax #149

Open
ribrdb opened this issue Sep 13, 2022 · 1 comment
Open

Please document query syntax #149

ribrdb opened this issue Sep 13, 2022 · 1 comment

Comments

@ribrdb
Copy link

ribrdb commented Sep 13, 2022

Please document what syntax you can use for the q field. The api documentation mentions * and -.
From reading closed issues I assume phrases are supported using double quotes. I also see examples using field:value but I can't find any documentation for this. This information should all be documented in one place.

@kishorenc
Copy link
Member

Thanks for the feedback: I'll document this in the next round of updates to the docs.

For now, you've pretty much covered all the supported syntax:

  • wildcard *
  • exclusion of words via -
  • phrase match by wrapping the words in quotes

field:value syntax is only for filtering. To target the fields used for querying, use the query_by param.

@jasonbosco jasonbosco transferred this issue from typesense/typesense Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants