typesense-website icon indicating copy to clipboard operation
typesense-website copied to clipboard

Please document query syntax

Open ribrdb opened this issue 3 years ago • 1 comments

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.

ribrdb avatar Sep 13 '22 15:09 ribrdb

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.

kishorenc avatar Sep 14 '22 11:09 kishorenc