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

Rewrite Query Language docs #4726

Merged
merged 7 commits into from
Mar 19, 2024
Merged

Rewrite Query Language docs #4726

merged 7 commits into from
Mar 19, 2024

Conversation

ddelemeny
Copy link
Collaborator

@ddelemeny ddelemeny commented Mar 13, 2024

Piggybacking on @trinity-1686a's update proposal for the query language documentation in #4708.

I extracted and formatted a "friendly" version to be included in the Getting started section of the docs and rewrote the refdoc in a more formal way

  • Extract an introduction to the query language
  • Rewrite the QL reference doc in a more systematic and exhaustive way.

Quickwit.io screenshots

Intro

image

Reference

image

@ddelemeny ddelemeny marked this pull request as ready for review March 14, 2024 17:26
@ddelemeny
Copy link
Collaborator Author

ddelemeny commented Mar 14, 2024

Okay, that should to the trick. Please make sure I didn't leave obvious mistakes in my interpretation.

@trinity-1686a I've left a few comments in the refdoc where I think some clarification is needed, feel free to chime in !

Edit: information is also missing about the single quote syntax for terms used by @fmassot in quickwit-oss/quickwit-datasource#102

Copy link
Contributor

@trinity-1686a trinity-1686a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we have a name for field:'my value' queries. It's a bit like a phrase query in the sense that it matches only if field contains both my and value; but it doesn't check positions (i.e. they can be distant or not in the right order). It's also a convenient way to query fields with the raw tokenizer when the value contain spaces (which can also be done with field:my\ value I believe)

docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
docs/get-started/query-language-intro.md Outdated Show resolved Hide resolved
docs/reference/query-language.md Outdated Show resolved Hide resolved
@ddelemeny ddelemeny force-pushed the ddelemeny/ql-docs-rewrite branch from 17ca780 to 3d14daf Compare March 19, 2024 15:06
@ddelemeny
Copy link
Collaborator Author

Thanks for the review @trinity-1686a!
@fmassot I think the docs are ready to merge.

@ddelemeny ddelemeny force-pushed the ddelemeny/ql-docs-rewrite branch from 6ae81cc to c8820b9 Compare March 19, 2024 19:23
@fmassot fmassot merged commit 685142b into main Mar 19, 2024
4 checks passed
@fmassot fmassot deleted the ddelemeny/ql-docs-rewrite branch March 19, 2024 22:58
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

Successfully merging this pull request may close these issues.

3 participants